@seamapi/types 1.724.0 → 1.725.0

package/src/lib/seam/connect/models/action-attempts/lock-door.ts

@@ -21,7 +21,16 @@ const error = z
   })
   .describe('Error associated with the action.')
 
-const result = z.object({}).describe('Result of the action.')
+const result = z
+  .object({
+    was_confirmed_by_device: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether the device confirmed that the lock action occurred.',
+      ),
+  })
+  .describe('Result of the action.')
 
 export const lock_door_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt

package/src/lib/seam/connect/models/action-attempts/scan-credential.ts

@@ -31,23 +31,23 @@ const no_credential_on_encoder_error = z
   })
   .describe('Error to indicate that there is no credential on the encoder.')
 
-const no_card_on_encoder_error = z
+const encoder_not_online_error = z
   .object({
     type: z
-      .literal('no_card_on_encoder')
-      .describe('Error type to indicate that there is no card on the encoder.'),
+      .literal('encoder_not_online')
+      .describe('Error type to indicate that the encoder is not online.'),
     message: z
       .string()
       .describe(
         'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
       ),
   })
-  .describe('Error to indicate that there is no card on the encoder.')
+  .describe('Error to indicate that the encoder is not online.')
 
 const error = z.union([
   ...common_action_attempt_errors,
   no_credential_on_encoder_error,
-  no_card_on_encoder_error,
+  encoder_not_online_error,
 ])
 
 const warning = z

package/src/lib/seam/connect/models/action-attempts/unlock-door.ts

@@ -21,7 +21,16 @@ const error = z
   })
   .describe('Error associated with the action.')
 
-const result = z.object({}).describe('Result of the action.')
+const result = z
+  .object({
+    was_confirmed_by_device: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether the device confirmed that the unlock action occurred.',
+      ),
+  })
+  .describe('Result of the action.')
 
 export const unlock_door_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt

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

@@ -222,12 +222,21 @@ const account_reauthorization_requested = common_connected_account_warning
     'Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.',
   )
 
+const being_deleted = common_connected_account_warning
+  .extend({
+    warning_code: z.literal('being_deleted').describe(warning_code_description),
+  })
+  .describe(
+    'Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam.',
+  )
+
 const connected_account_warning = z
   .discriminatedUnion('warning_code', [
     scheduled_maintenance_window,
     unknown_issue_with_connected_account,
     salto_ks_subscription_limit_almost_reached,
     account_reauthorization_requested,
+    being_deleted,
   ])
   .describe('Warning associated with the connected account.')
 
@@ -243,6 +252,7 @@ const _connected_account_warning_map = z.object({
   account_reauthorization_requested: account_reauthorization_requested
     .nullable()
     .optional(),
+  being_deleted: being_deleted.nullable().optional(),
 })
 
 export type ConnectedAccountWarningMap = z.infer<

package/src/lib/seam/connect/models/customer/access-grant-resources.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { custom_metadata_input } from '../custom-metadata.js'
+
 // Base access grant resource with common fields
 const base_access_grant_resource = z.object({
   name: z
@@ -96,6 +98,11 @@ export const reservation_resource = base_access_grant_resource
         message: 'Must not have leading or trailing whitespace',
       })
       .describe('Your unique identifier for the reservation.'),
+    custom_metadata: custom_metadata_input
+      .optional()
+      .describe(
+        'Set key:value pairs for filtering reservations by custom criteria.',
+      ),
   })
   .merge(user_identity_reference)
   .merge(location_references)

package/src/lib/seam/connect/models/customer/customer-portal.ts

@@ -1,6 +1,5 @@
 import { z } from 'zod'
 
-import type { CustomMetadata } from '../custom-metadata.js'
 import { access_grant_key_aliases } from './access-grant-resources.js'
 import { location_key_aliases } from './location-resources.js'
 
@@ -40,6 +39,23 @@ const base_manage_feature = base_feature.extend({
     .describe(
       'Indicates whether the customer can manage staff for their properties.',
     ),
+  events: z
+    .object({
+      allowed_events: z
+        .array(z.string())
+        .optional()
+        .describe(
+          'List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events.',
+        ),
+      default_events: z
+        .array(z.string())
+        .optional()
+        .describe(
+          'List of event types that are pre-selected in the events filter when the user first loads the events tab.',
+        ),
+    })
+    .optional()
+    .describe('Configuration for event type filtering in the manage feature.'),
 })
 
 const base_organize_feature = base_feature
@@ -104,16 +120,55 @@ export const portal_configuration_base = z.object({
     .enum(['en-US', 'pt-PT', 'fr-FR', 'it-IT', 'es-ES'])
     .optional()
     .describe('The locale to use for the portal.'),
+  exclude_locale_picker: z
+    .boolean()
+    .default(false)
+    .describe(
+      'Whether to exclude the option to select a locale within the portal UI.',
+    ),
   customization_profile_id: z
     .string()
     .uuid()
     .optional()
     .describe('The ID of the customization profile to use for the portal.'),
-  property_listing_filter: z
-    .record(z.string(), z.union([z.string(), z.boolean()]))
+  customer_resources_filters: z
+    .array(
+      z.object({
+        field: z
+          .string()
+          .regex(/^[a-zA-Z_]\w*$/, {
+            message:
+              'Field names must start with a letter or underscore and contain only alphanumeric characters and underscores',
+          })
+          .describe('The custom_metadata field name to filter on.'),
+        operation: z
+          .literal('=')
+          .describe(
+            "The comparison operation. Currently only '=' is supported.",
+          ),
+        value: z
+          .union([z.string(), z.boolean()])
+          .describe('The value to compare against.'),
+      }),
+    )
+    .optional()
+    .describe(
+      'Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.',
+    ),
+  navigation_mode: z
+    .enum(['full', 'restricted'])
+    .default('full')
+    .describe(
+      "Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.",
+    ),
+  deep_link: z
+    .object({
+      resource_type: z.enum(['reservation', 'space']),
+      resource_key: z.string(),
+    })
     .optional()
     .describe(
-      'Filter configuration for property listings based on their custom_metadata. Keys and values must match the custom_metadata stored on property listings.',
+      'Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.',
     ),
 })
 
@@ -138,11 +193,16 @@ export const portal_configuration = portal_configuration_base
       },
     },
     is_embedded: false,
+    exclude_locale_picker: false,
     locale: undefined,
-    property_listing_filter: undefined,
+    customer_resources_filters: undefined,
   })
   .describe(`Configuration for a customer portal`)
 
 export type PortalConfiguration = z.infer<typeof portal_configuration>
 
-export type PropertyListingFilter = CustomMetadata
+export type CustomerResourcesFilters = Array<{
+  field: string
+  operation: '='
+  value: string | boolean
+}>

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

@@ -42,7 +42,7 @@ export const dormakaba_oracode_time_slot = z
         `Indicates whether a time slot for a dormakaba Oracode device is a master time slot.`,
       ),
 
-    ext_dormakaba_oracode_user_level_prefix: z
+    dormakaba_oracode_user_level_prefix: z
       .number()
       .describe(`Prefix for a user level for a dormakaba Oracode device.`),
     dormakaba_oracode_user_level_id: z
@@ -168,6 +168,16 @@ export const device_metadata = z
       battery_level: z.string().describe(`Battery level for a Salto device.`),
       locked_state: z.string().describe(`Locked state for a Salto device.`),
       model: z.string().optional().describe(`Model for a Salto device.`),
+      site_id: z
+        .string()
+        .optional()
+        .describe(`Site ID for the Salto KS site to which the device belongs.`),
+      site_name: z
+        .string()
+        .optional()
+        .describe(
+          `Site name for the Salto KS site to which the device belongs.`,
+        ),
     }).describe(`
     ---
     deprecated: Use \`salto_ks_metadata \` instead.
@@ -194,6 +204,18 @@ export const device_metadata = z
           .describe(
             `Indicates whether the site has a Salto KS subscription that supports custom PINs.`,
           ),
+        site_id: z
+          .string()
+          .optional()
+          .describe(
+            `Site ID for the Salto KS site to which the device belongs.`,
+          ),
+        site_name: z
+          .string()
+          .optional()
+          .describe(
+            `Site name for the Salto KS site to which the device belongs.`,
+          ),
       })
       .describe(`Metadata for a Salto KS device.`),
 
@@ -493,14 +515,6 @@ export const device_metadata = z
       })
       .describe(`Metadata for a Honeywell Resideo device.`),
 
-    hubitat_metadata: z
-      .object({
-        device_id: z.string().describe(`Device ID for a Hubitat device.`),
-        device_name: z.string().describe(`Device name for a Hubitat device.`),
-        device_label: z.string().describe(`Device label for a Hubitat device.`),
-      })
-      .describe(`Metadata for a Hubitat device.`),
-
     dormakaba_oracode_metadata: z
       .object({
         door_id: z
@@ -619,6 +633,12 @@ export const device_metadata = z
         device_id: z.string().describe(`Device ID for a Sensi device.`),
         device_name: z.string().describe(`Device name for a Sensi device.`),
         product_type: z.string().describe(`Product type for a Sensi device.`),
+        dual_setpoints_not_supported: z
+          .boolean()
+          .optional()
+          .describe(
+            `Set to true when the device does not support the /dual-setpoints API endpoint.`,
+          ),
       })
       .describe(`Metadata for a Sensi device.`),
 
@@ -723,6 +743,12 @@ export const device_metadata = z
         wifi_signal_strength: z
           .number()
           .describe(`WiFi signal strength (0-1) for a Korelock device.`),
+        location_id: z
+          .string()
+          .nullable()
+          .describe(
+            `Location ID for a Korelock device. Required for timebound access codes.`,
+          ),
       })
       .partial()
       .describe(`Metadata for a Korelock device.`),

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

@@ -24,7 +24,6 @@ export const DEVICE_PROVIDERS = {
   LINEAR: 'linear',
   NOISEAWARE: 'noiseaware',
   NUKI: 'nuki',
-  SEAM_RELAY_ADMIN: 'seam_relay_admin',
   IGLOO: 'igloo',
   KWIKSET: 'kwikset',
   MINUT: 'minut',
@@ -33,7 +32,6 @@ export const DEVICE_PROVIDERS = {
   NEST: 'nest',
   IGLOOHOME: 'igloohome',
   ECOBEE: 'ecobee',
-  HUBITAT: 'hubitat',
   FOUR_SUITES: 'four_suites',
   DORMAKABA_ORACODE: 'dormakaba_oracode',
   PTI: 'pti',
@@ -50,7 +48,6 @@ export const DEVICE_PROVIDERS = {
   TADO: 'tado',
   SALTO_SPACE: 'salto_space',
   SENSI: 'sensi',
-  KWIKSET2: 'kwikset2',
   KEYNEST: 'keynest',
   KORELOCK: 'korelock',
   DORMAKABA_AMBIANCE: 'dormakaba_ambiance',
@@ -99,6 +96,7 @@ export const PROVIDER_CATEGORY_MAP = {
     'avigilon_alta',
     'keynest',
     'hotek',
+    'ultraloq',
   ],
 
   consumer_smartlocks: [
@@ -114,6 +112,7 @@ export const PROVIDER_CATEGORY_MAP = {
     'wyze',
     'lockly',
     'tedee',
+    'ultraloq',
   ],
 
   beta: ['korelock'],

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

@@ -16,7 +16,6 @@ export const LOCK_DEVICE_TYPE = {
   NUKI_LOCK: 'nuki_lock',
   SALTO_LOCK: 'salto_lock',
   SCHLAGE_LOCK: 'schlage_lock',
-  SEAM_RELAY: 'seam_relay',
   SMARTTHINGS_LOCK: 'smartthings_lock',
   WYZE_LOCK: 'wyze_lock',
   YALE_LOCK: 'yale_lock',
@@ -24,7 +23,6 @@ export const LOCK_DEVICE_TYPE = {
   CONTROLBYWEB_DEVICE: 'controlbyweb_device',
   TTLOCK_LOCK: 'ttlock_lock',
   IGLOOHOME_LOCK: 'igloohome_lock',
-  HUBITAT_LOCK: 'hubitat_lock',
   FOUR_SUITES_DOOR: 'four_suites_door',
   DORMAKABA_ORACODE_DOOR: 'dormakaba_oracode_door',
   TEDEE_LOCK: 'tedee_lock',

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

@@ -409,6 +409,16 @@ const ultraloq_time_zone_unknown = common_device_warning
     'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.',
   )
 
+const two_n_device_missing_timezone = common_device_warning
+  .extend({
+    warning_code: z
+      .literal('two_n_device_missing_timezone')
+      .describe(warning_code_description),
+  })
+  .describe(
+    'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.',
+  )
+
 export const unknown_issue_with_phone = common_device_warning.extend({
   warning_code: z
     .literal('unknown_issue_with_phone')
@@ -453,6 +463,27 @@ const accessory_keypad_setup_required = common_device_warning.extend({
     Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.
     `)
 
+const max_access_codes_reached = common_device_warning.extend({
+  warning_code: z
+    .literal('max_access_codes_reached')
+    .describe(warning_code_description),
+  active_access_code_count: z
+    .number()
+    .int()
+    .describe(
+      'Number of active access codes on the device when the warning was set.',
+    ),
+  max_active_access_code_count: z
+    .number()
+    .int()
+    .describe('Maximum number of active access codes supported by the device.'),
+}).describe(`
+    ---
+    variant_group_key: access_codes
+    ---
+    Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.
+    `)
+
 const device_warning = z.discriminatedUnion('warning_code', [
   partial_backup_access_code_pool,
   many_active_backup_codes,
@@ -471,9 +502,11 @@ const device_warning = z.discriminatedUnion('warning_code', [
   unknown_issue_with_phone,
   lockly_time_zone_not_configured,
   ultraloq_time_zone_unknown,
+  two_n_device_missing_timezone,
   hub_required_for_additional_capabilities,
   keynest_unsupported_locker,
   accessory_keypad_setup_required,
+  max_access_codes_reached,
 ])
 
 export type DeviceWarning = z.infer<typeof device_warning>
@@ -518,12 +551,16 @@ const _device_warning_map = z.object({
     .optional()
     .nullable(),
   ultraloq_time_zone_unknown: ultraloq_time_zone_unknown.optional().nullable(),
+  two_n_device_missing_timezone: two_n_device_missing_timezone
+    .optional()
+    .nullable(),
   hub_required_for_additional_capabilities:
     hub_required_for_additional_capabilities.optional().nullable(),
   keynest_unsupported_locker: keynest_unsupported_locker.optional().nullable(),
   accessory_keypad_setup_required: accessory_keypad_setup_required
     .optional()
     .nullable(),
+  max_access_codes_reached: max_access_codes_reached.optional().nullable(),
 })
 
 export type DeviceWarningMap = z.infer<typeof _device_warning_map>

package/src/lib/seam/connect/models/events/access-codes.ts

@@ -1,7 +1,11 @@
 import { z } from 'zod'
 
 import { custom_metadata } from '../custom-metadata.js'
-import { common_event } from './common.js'
+import {
+  common_event,
+  common_event_error,
+  common_event_warning,
+} from './common.js'
 
 const access_code_event = common_event.extend({
   access_code_id: z.string().uuid().describe('ID of the affected access code.'),
@@ -27,6 +31,27 @@ const access_code_event = common_event.extend({
     ),
 })
 
+const access_code_event_issue_properties = {
+  connected_account_errors: z
+    .array(common_event_error)
+    .describe('Errors associated with the connected account.'),
+  connected_account_warnings: z
+    .array(common_event_warning)
+    .describe('Warnings associated with the connected account.'),
+  device_errors: z
+    .array(common_event_error)
+    .describe('Errors associated with the device.'),
+  device_warnings: z
+    .array(common_event_warning)
+    .describe('Warnings associated with the device.'),
+  access_code_errors: z
+    .array(common_event_error)
+    .describe('Errors associated with the access code.'),
+  access_code_warnings: z
+    .array(common_event_warning)
+    .describe('Warnings associated with the access code.'),
+}
+
 const code = z.string().describe('Code for the affected access code.')
 
 export const access_code_created_event = access_code_event.extend({
@@ -92,10 +117,11 @@ export type AccessCodeRemovedFromDeviceEvent = z.infer<
   typeof access_code_removed_from_device_event
 >
 
-export const access_code_delay_in_setting_on_device_event =
-  access_code_event.extend({
+export const access_code_delay_in_setting_on_device_event = access_code_event
+  .extend({
     event_type: z.literal('access_code.delay_in_setting_on_device'),
-  }).describe(`
+  })
+  .extend(access_code_event_issue_properties).describe(`
     ---
     route_path: /access_codes
     ---
@@ -106,10 +132,11 @@ export type AccessCodeDelayInSettingOnDeviceEvent = z.infer<
   typeof access_code_delay_in_setting_on_device_event
 >
 
-export const access_code_failed_to_set_on_device_event =
-  access_code_event.extend({
+export const access_code_failed_to_set_on_device_event = access_code_event
+  .extend({
     event_type: z.literal('access_code.failed_to_set_on_device'),
-  }).describe(`
+  })
+  .extend(access_code_event_issue_properties).describe(`
     ---
     route_path: /access_codes
     ---
@@ -132,10 +159,11 @@ export const access_code_deleted_event = access_code_event.extend({
 
 export type AccessCodeDeletedEvent = z.infer<typeof access_code_deleted_event>
 
-export const access_code_delay_in_removing_from_device_event =
-  access_code_event.extend({
+export const access_code_delay_in_removing_from_device_event = access_code_event
+  .extend({
     event_type: z.literal('access_code.delay_in_removing_from_device'),
-  }).describe(`
+  })
+  .extend(access_code_event_issue_properties).describe(`
     ---
     route_path: /access_codes
     ---
@@ -146,10 +174,11 @@ export type AccessCodeDelayInRemovingFromDeviceEvent = z.infer<
   typeof access_code_delay_in_removing_from_device_event
 >
 
-export const access_code_failed_to_remove_from_device_event =
-  access_code_event.extend({
+export const access_code_failed_to_remove_from_device_event = access_code_event
+  .extend({
     event_type: z.literal('access_code.failed_to_remove_from_device'),
-  }).describe(`
+  })
+  .extend(access_code_event_issue_properties).describe(`
     ---
     route_path: /access_codes
     ---
@@ -218,9 +247,13 @@ export type UnmanagedAccessCodeConvertedToManagedEvent = z.infer<
 >
 
 export const unmanaged_access_code_failed_to_convert_to_managed_event =
-  access_code_event.extend({
-    event_type: z.literal('access_code.unmanaged.failed_to_convert_to_managed'),
-  }).describe(`
+  access_code_event
+    .extend({
+      event_type: z.literal(
+        'access_code.unmanaged.failed_to_convert_to_managed',
+      ),
+    })
+    .extend(access_code_event_issue_properties).describe(`
       ---
       route_path: /access_codes/unmanaged
       ---

package/src/lib/seam/connect/models/events/access-methods.ts

@@ -82,6 +82,19 @@ export const access_method_reissued_event = access_method_issued_event.extend({
     An access method was reissued.
   `)
 
+export const access_method_created_event = access_method_event.extend({
+  event_type: z.literal('access_method.created'),
+}).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    An access method was created.
+  `)
+
+export type AccessMethodCreatedEvent = z.infer<
+  typeof access_method_created_event
+>
+
 export type AccessMethodRevokedEvent = z.infer<
   typeof access_method_revoked_event
 >
@@ -92,4 +105,5 @@ export const access_method_events = [
   access_method_card_encoding_required_event,
   access_method_deleted_event,
   access_method_reissued_event,
+  access_method_created_event,
 ] as const

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

@@ -1,9 +1,25 @@
 import { z } from 'zod'
 
+import { common_event_error, common_event_warning } from '../common.js'
 import { common_acs_event } from './common.js'
 
 const acs_system_event = common_acs_event.extend({})
 
+const acs_system_event_issue_properties = {
+  acs_system_errors: z
+    .array(common_event_error)
+    .describe('Errors associated with the access control system.'),
+  acs_system_warnings: z
+    .array(common_event_warning)
+    .describe('Warnings associated with the access control system.'),
+  connected_account_errors: z
+    .array(common_event_error)
+    .describe('Errors associated with the connected account.'),
+  connected_account_warnings: z
+    .array(common_event_warning)
+    .describe('Warnings associated with the connected account.'),
+}
+
 export const acs_system_connected_event = acs_system_event.extend({
   event_type: z.literal('acs_system.connected'),
 }).describe(`
@@ -15,9 +31,11 @@ export const acs_system_connected_event = acs_system_event.extend({
 
 export type AcsSystemConnectedEvent = z.infer<typeof acs_system_connected_event>
 
-export const acs_system_disconnected_event = acs_system_event.extend({
-  event_type: z.literal('acs_system.disconnected'),
-}).describe(`
+export const acs_system_disconnected_event = acs_system_event
+  .extend({
+    event_type: z.literal('acs_system.disconnected'),
+  })
+  .extend(acs_system_event_issue_properties).describe(`
     ---
     route_path: /acs/systems
     ---