@seamapi/types 1.723.0 → 1.725.0

package/package.json

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

package/src/lib/seam/connect/internal/model-types.ts

@@ -1,3 +1,4 @@
+export type { SeamEvent, SeamEventType } from '../models/events/seam-event.js'
 export type {
   AccessCode as ManagedAccessCode,
   Device as ManagedDevice,

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

@@ -156,22 +156,6 @@ const salto_ks_user_not_subscribed = common_access_code_error
   })
   .describe('Salto site user is not subscribed.')
 
-const hubitat_device_programming_delay = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('hubitat_device_programming_delay')
-      .describe(error_code_description),
-  })
-  .describe('Access code has not yet been fully moved to the device.')
-
-const hubitat_no_free_positions_available = common_access_code_error
-  .extend({
-    error_code: z
-      .literal('hubitat_no_free_positions_available')
-      .describe(error_code_description),
-  })
-  .describe('No free positions available on the device.')
-
 const smartthings_no_free_slots_available = common_access_code_error
   .extend({
     error_code: z
@@ -214,6 +198,16 @@ const keynest_unsupported_third_party_locker = common_access_code_error
   })
   .describe('KeyNest locker is not supported.')
 
+const replaced_by_newer_access_code = common_access_code_error
+  .extend({
+    error_code: z
+      .literal('replaced_by_newer_access_code')
+      .describe(error_code_description),
+  })
+  .describe(
+    'This access code was overridden on the device by a newer access code programmed to the same slot.',
+  )
+
 const access_code_error = z
   .discriminatedUnion('error_code', [
     smartthings_failed_to_set_access_code_error,
@@ -233,13 +227,12 @@ const access_code_error = z
     august_lock_missing_keypad,
     august_lock_temporarily_offline_error,
     salto_ks_user_not_subscribed,
-    hubitat_device_programming_delay,
-    hubitat_no_free_positions_available,
     wyze_duplicate_code_name,
     wyze_potential_duplicate_code,
     dormakaba_oracode_invalid_time_range,
     kwikset_insufficient_permissions,
     keynest_unsupported_third_party_locker,
+    replaced_by_newer_access_code,
   ])
   .describe(
     'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
@@ -291,12 +284,6 @@ const _access_code_error_map = z.object({
   salto_ks_user_not_subscribed: salto_ks_user_not_subscribed
     .optional()
     .nullable(),
-  hubitat_device_programming_delay: hubitat_device_programming_delay
-    .optional()
-    .nullable(),
-  hubitat_no_free_positions_available: hubitat_no_free_positions_available
-    .optional()
-    .nullable(),
   wyze_duplicate_code_name: wyze_duplicate_code_name.optional().nullable(),
   wyze_potential_duplicate_code: wyze_potential_duplicate_code
     .optional()
@@ -307,6 +294,9 @@ const _access_code_error_map = z.object({
   keynest_unsupported_third_party_locker: keynest_unsupported_third_party_locker
     .optional()
     .nullable(),
+  replaced_by_newer_access_code: replaced_by_newer_access_code
+    .optional()
+    .nullable(),
 })
 
 export type AccessCodeErrorMap = z.infer<typeof _access_code_error_map>
@@ -437,6 +427,12 @@ const ultraloq_access_code_disabled = common_access_code_warning
     'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.',
   )
 
+const being_deleted = common_access_code_warning
+  .extend({
+    warning_code: z.literal('being_deleted').describe(warning_code_description),
+  })
+  .describe('Access code is being deleted.')
+
 const access_code_warning = z
   .discriminatedUnion('warning_code', [
     smartthings_failed_to_set_access_code_warning,
@@ -452,6 +448,7 @@ const access_code_warning = z
     management_transferred,
     kwikset_unable_to_confirm_code_warning,
     ultraloq_access_code_disabled,
+    being_deleted,
   ])
   .describe(
     'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
@@ -489,10 +486,59 @@ const _access_code_warning_map = z.object({
   ultraloq_access_code_disabled: ultraloq_access_code_disabled
     .optional()
     .nullable(),
+  being_deleted: being_deleted.optional().nullable(),
 })
 
 export type AccessCodeWarningMap = z.infer<typeof _access_code_warning_map>
 
+export const dormakaba_oracode_access_code_metadata = z
+  .object({
+    stay_id: z
+      .number()
+      .describe('Dormakaba Oracode stay ID associated with this access code.'),
+    user_level_id: z
+      .string()
+      .optional()
+      .describe(
+        'Dormakaba Oracode user level ID associated with this access code.',
+      ),
+    user_level_name: z
+      .string()
+      .nullable()
+      .describe(
+        'Dormakaba Oracode user level name associated with this access code.',
+      ),
+    site_name: z
+      .string()
+      .optional()
+      .describe(
+        'Dormakaba Oracode site name associated with this access code.',
+      ),
+    is_cancellable: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether the stay can be cancelled via the Dormakaba Oracode API.',
+      ),
+    is_extendable: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether the stay can be extended via the Dormakaba Oracode API.',
+      ),
+    is_early_checkin_able: z
+      .boolean()
+      .optional()
+      .describe('Indicates whether early check-in is available for this stay.'),
+    is_overridable: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.',
+      ),
+  })
+  .describe('Metadata for a dormakaba Oracode access code.')
+
 export const access_code = z.object({
   workspace_id: z
     .string()
@@ -650,6 +696,12 @@ export const access_code = z.object({
     .describe(
       'Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.',
     ),
+  dormakaba_oracode_metadata: dormakaba_oracode_access_code_metadata
+    .nullable()
+    .optional()
+    .describe(
+      'Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.',
+    ),
 }).describe(`
   ---
   route_path: /access_codes

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

@@ -1,6 +1,9 @@
 import { z } from 'zod'
 
-import { access_code } from './managed-access-code.js'
+import {
+  access_code,
+  dormakaba_oracode_access_code_metadata,
+} from './managed-access-code.js'
 
 export const unmanaged_access_code = access_code
   .pick({
@@ -26,6 +29,11 @@ export const unmanaged_access_code = access_code
       .describe(
         'Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.',
       ),
+    dormakaba_oracode_metadata: dormakaba_oracode_access_code_metadata
+      .nullable()
+      .describe(
+        'Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.',
+      ),
   }).describe(`
     ---
     route_path: /access_codes/unmanaged
@@ -39,7 +47,7 @@ export const unmanaged_access_code = access_code
     Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
 
     Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
-    
+
     - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
   `)
 

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

@@ -1,5 +1,6 @@
 import { z } from 'zod'
 
+import { access_grant_pending_mutations } from './pending-mutations.js'
 import { requested_access_method } from './requested-access-method.js'
 
 const common_access_grant_error = z.object({
@@ -60,14 +61,99 @@ const being_deleted = common_access_grant_warning
     'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
   )
 
+const underprovisioned_access = common_access_grant_warning
+  .extend({
+    warning_code: z
+      .literal('underprovisioned_access')
+      .describe(warning_code_description),
+  })
+  .describe(
+    'Indicates that the access grant should have access to more locations than it currently does. Access methods are being created for the missing locations.',
+  )
+
+const overprovisioned_access = common_access_grant_warning
+  .extend({
+    warning_code: z
+      .literal('overprovisioned_access')
+      .describe(warning_code_description),
+  })
+  .describe(
+    'Indicates that the access grant has access to locations it should not have. Access methods are being removed from the extra locations.',
+  )
+
+const updating_access_times = common_access_grant_warning
+  .extend({
+    warning_code: z
+      .literal('updating_access_times')
+      .describe(warning_code_description),
+    access_method_ids: z
+      .array(z.string().uuid())
+      .describe('IDs of the access methods being updated.'),
+  })
+  .describe(
+    'Indicates that the access times for this [access grant](https://docs.seam.co/latest/capability-guides/access-grants) are being updated.',
+  )
+
+const requested_code_unavailable = common_access_grant_warning
+  .extend({
+    warning_code: z
+      .literal('requested_code_unavailable')
+      .describe(warning_code_description),
+    device_id: z
+      .string()
+      .uuid()
+      .describe('ID of the device where the requested code was unavailable.'),
+    original_code: z
+      .string()
+      .describe('The originally requested PIN code that was unavailable.'),
+    new_code: z
+      .string()
+      .describe('The new PIN code that was assigned instead.'),
+  })
+  .describe(
+    'Indicates that the requested PIN code was already in use on a device, so a different code was assigned.',
+  )
+
+const device_does_not_support_access_codes = common_access_grant_warning
+  .extend({
+    warning_code: z
+      .literal('device_does_not_support_access_codes')
+      .describe(warning_code_description),
+    device_id: z
+      .string()
+      .uuid()
+      .describe('ID of the device that does not support access codes.'),
+  })
+  .describe(
+    'Indicates that a device in the access grant does not support access codes and was excluded from code materialization.',
+  )
+
 const access_grant_warning = z
-  .discriminatedUnion('warning_code', [being_deleted])
+  .discriminatedUnion('warning_code', [
+    being_deleted,
+    underprovisioned_access,
+    overprovisioned_access,
+    updating_access_times,
+    requested_code_unavailable,
+    device_does_not_support_access_codes,
+  ])
   .describe(
     'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
   )
 
 const _access_grant_warning_map = z.object({
   being_deleted: being_deleted.optional().nullable(),
+  underprovisioned_access: underprovisioned_access.optional().nullable(),
+  overprovisioned_access: overprovisioned_access.optional().nullable(),
+  updating_access_times: updating_access_times.optional().nullable(),
+  requested_code_unavailable_by_device: z
+    .record(z.string().uuid(), requested_code_unavailable)
+    .optional()
+    .nullable(),
+  device_does_not_support_access_codes: z
+    .record(z.string().uuid(), device_does_not_support_access_codes)
+    .optional()
+    .nullable(),
 })
 
 export type AccessGrantWarningMap = z.infer<typeof _access_grant_warning_map>
@@ -154,6 +240,11 @@ export const access_grant = z.object({
     .describe(
       'ID of the customization profile associated with the Access Grant.',
     ),
+  pending_mutations: z
+    .array(access_grant_pending_mutations)
+    .describe(
+      'List of pending mutations for the access grant. This shows updates that are in progress.',
+    ),
 }).describe(`
   ---
   draft: Early access.

package/src/lib/seam/connect/models/access-grants/access-method.ts

@@ -23,18 +23,174 @@ const being_deleted = common_access_method_warning
     'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
   )
 
+const updating_access_times_warning = common_access_method_warning
+  .extend({
+    warning_code: z
+      .literal('updating_access_times')
+      .describe(warning_code_description),
+  })
+  .describe(
+    'Indicates that the access times for this [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) are being updated.',
+  )
+
 const access_method_warning = z
-  .discriminatedUnion('warning_code', [being_deleted])
+  .discriminatedUnion('warning_code', [
+    being_deleted,
+    updating_access_times_warning,
+  ])
   .describe(
     'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
   )
 
 const _access_method_warning_map = z.object({
   being_deleted: being_deleted.optional().nullable(),
+  updating_access_times: updating_access_times_warning.optional().nullable(),
 })
 
 export type AccessMethodWarningMap = z.infer<typeof _access_method_warning_map>
 
+// Pending mutations for access methods
+const common_pending_mutation = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the mutation was created.'),
+  message: z.string().describe('Detailed description of the mutation.'),
+})
+
+const provisioning_access_mutation = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('provisioning_access')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices.',
+      ),
+    from: z
+      .object({
+        device_ids: z
+          .array(z.string().uuid())
+          .describe('Previous device IDs where access was provisioned.'),
+      })
+      .describe('Previous device configuration.'),
+    to: z
+      .object({
+        device_ids: z
+          .array(z.string().uuid())
+          .describe('New device IDs where access is being provisioned.'),
+      })
+      .describe('New device configuration.'),
+  })
+  .describe(
+    'Seam is in the process of provisioning access for this access method on new devices.',
+  )
+
+const revoking_access_mutation = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('revoking_access')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of revoking access for this access method from devices.',
+      ),
+    from: z
+      .object({
+        device_ids: z
+          .array(z.string().uuid())
+          .describe('Previous device IDs where access existed.'),
+      })
+      .describe('Previous device configuration.'),
+    to: z
+      .object({
+        device_ids: z
+          .array(z.string().uuid())
+          .describe('New device IDs where access should remain.'),
+      })
+      .describe('New device configuration.'),
+  })
+  .describe(
+    'Seam is in the process of revoking access for this access method from devices.',
+  )
+
+const updating_access_times_mutation = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('updating_access_times')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of updating the access times for this access method.',
+      ),
+    from: z
+      .object({
+        starts_at: z
+          .string()
+          .datetime()
+          .nullable()
+          .describe('Previous start time for access.'),
+        ends_at: z
+          .string()
+          .datetime()
+          .nullable()
+          .describe('Previous end time for access.'),
+      })
+      .describe('Previous access time configuration.'),
+    to: z
+      .object({
+        starts_at: z
+          .string()
+          .datetime()
+          .nullable()
+          .describe('New start time for access.'),
+        ends_at: z
+          .string()
+          .datetime()
+          .nullable()
+          .describe('New end time for access.'),
+      })
+      .describe('New access time configuration.'),
+  })
+  .describe(
+    'Seam is in the process of updating the access times for this access method.',
+  )
+
+const notifying_connector_mutation = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('notifying_connector')
+      .describe(
+        "Mutation code to indicate that Seam is in the process of notifying the connector about this access method's issuance.",
+      ),
+    // Intentionally generic — each connector type has its own provider_data shape
+    // (e.g., Cloudbeds uses { keyId: string, keyType: string })
+    provider_data: z
+      .record(z.any())
+      .describe('Provider-specific data needed to notify the connector.'),
+  })
+  .describe(
+    "Seam is in the process of notifying the connector about this access method's issuance.",
+  )
+
+export const access_method_pending_mutations = z.discriminatedUnion(
+  'mutation_code',
+  [
+    provisioning_access_mutation,
+    revoking_access_mutation,
+    updating_access_times_mutation,
+  ],
+)
+
+export type AccessMethodPendingMutation = z.infer<
+  typeof access_method_pending_mutations
+>
+
+const _access_method_pending_mutations_map = z.object({
+  provisioning_access: provisioning_access_mutation.optional().nullable(),
+  revoking_access: revoking_access_mutation.optional().nullable(),
+  updating_access_times: updating_access_times_mutation.optional().nullable(),
+  notifying_connector: notifying_connector_mutation.optional().nullable(),
+})
+
+export type AccessMethodPendingMutationsMap = z.infer<
+  typeof _access_method_pending_mutations_map
+>
+
 export const access_method = z.object({
   workspace_id: z
     .string()
@@ -84,6 +240,11 @@ export const access_method = z.object({
     .describe(
       'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
     ),
+  pending_mutations: z
+    .array(access_method_pending_mutations)
+    .describe(
+      'Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress.',
+    ),
   customization_profile_id: z
     .string()
     .uuid()

package/src/lib/seam/connect/models/access-grants/index.ts

@@ -1,2 +1,3 @@
 export * from './access-grant.js'
 export * from './access-method.js'
+export * from './pending-mutations.js'

package/src/lib/seam/connect/models/access-grants/pending-mutations.ts

@@ -0,0 +1,101 @@
+import { z } from 'zod'
+
+const common_pending_mutation = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the mutation was created.'),
+  message: z.string().describe('Detailed description of the mutation.'),
+})
+
+const updating_spaces_mutation = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('updating_spaces')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.',
+      ),
+    from: z
+      .object({
+        device_ids: z
+          .array(z.string().uuid())
+          .describe('Previous device IDs where access codes existed.'),
+      })
+      .describe('Previous location configuration.'),
+    to: z
+      .object({
+        device_ids: z
+          .array(z.string().uuid())
+          .describe('New device IDs where access codes should be created.'),
+        common_code_key: z
+          .string()
+          .nullable()
+          .optional()
+          .describe('Common code key to ensure PIN code reuse across devices.'),
+      })
+      .describe('New location configuration.'),
+  })
+  .describe(
+    'Seam is in the process of updating the devices/spaces associated with this access grant.',
+  )
+
+const updating_access_times_mutation = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('updating_access_times')
+      .describe(
+        'Mutation code to indicate that Seam is in the process of updating the access times for this access grant.',
+      ),
+    access_method_ids: z
+      .array(z.string().uuid())
+      .describe('IDs of the access methods being updated.'),
+    from: z
+      .object({
+        starts_at: z
+          .string()
+          .datetime()
+          .nullable()
+          .describe('Previous start time for access.'),
+        ends_at: z
+          .string()
+          .datetime()
+          .nullable()
+          .describe('Previous end time for access.'),
+      })
+      .describe('Previous access time configuration.'),
+    to: z
+      .object({
+        starts_at: z
+          .string()
+          .datetime()
+          .nullable()
+          .describe('New start time for access.'),
+        ends_at: z
+          .string()
+          .datetime()
+          .nullable()
+          .describe('New end time for access.'),
+      })
+      .describe('New access time configuration.'),
+  })
+  .describe(
+    'Seam is in the process of updating the access times for this access grant.',
+  )
+
+export const access_grant_pending_mutations = z.discriminatedUnion(
+  'mutation_code',
+  [updating_spaces_mutation, updating_access_times_mutation],
+)
+
+export type AccessGrantPendingMutation = z.infer<
+  typeof access_grant_pending_mutations
+>
+
+const _access_grant_pending_mutations_map = z.object({
+  updating_spaces: updating_spaces_mutation.optional().nullable(),
+  updating_access_times: updating_access_times_mutation.optional().nullable(),
+})
+
+export type AccessGrantPendingMutationsMap = z.infer<
+  typeof _access_grant_pending_mutations_map
+>

package/src/lib/seam/connect/models/access-grants/requested-access-method.ts

@@ -16,6 +16,14 @@ export const requested_access_method = z.object({
     .describe(
       "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
     ),
+  instant_key_max_use_count: z
+    .number()
+    .int()
+    .min(1)
+    .optional()
+    .describe(
+      "Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified.",
+    ),
   created_at: z
     .string()
     .datetime()

package/src/lib/seam/connect/models/acs/metadata/salto-space.ts

@@ -2,11 +2,6 @@ import { z } from 'zod'
 
 export const acs_entrance_salto_space_metadata = z
   .object({
-    ext_door_id: z.string().describe(`
-    ---
-    deprecated: use door_id.
-    ---
-    `),
     door_id: z.string().describe('Door ID in the Salto Space access system.'),
     door_name: z
       .string()

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

@@ -62,25 +62,25 @@ const credential_cannot_be_reissued = z
     'Error to indicate that the affected credential cannot be reissued.',
   )
 
-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,
   incompatible_card_format_error,
   credential_cannot_be_reissued,
-  no_card_on_encoder_error,
+  encoder_not_online_error,
 ])
 
 const result = acs_credential