@seamapi/types 1.961.0 → 1.963.0

package/package.json

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

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

@@ -50,11 +50,22 @@ const pulled_backup_access_code_warning = common_access_method_warning
     'Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.',
   )
 
+const delay_in_issuing_warning = common_access_method_warning
+  .extend({
+    warning_code: z
+      .literal('delay_in_issuing')
+      .describe(warning_code_description),
+  })
+  .describe(
+    'Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.',
+  )
+
 const access_method_warning = z
   .discriminatedUnion('warning_code', [
     being_deleted,
     updating_access_times_warning,
     pulled_backup_access_code_warning,
+    delay_in_issuing_warning,
   ])
   .describe(
     'Warning associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
@@ -66,10 +77,47 @@ const _access_method_warning_map = z.object({
   pulled_backup_access_code: pulled_backup_access_code_warning
     .optional()
     .nullable(),
+  delay_in_issuing: delay_in_issuing_warning.optional().nullable(),
 })
 
 export type AccessMethodWarningMap = z.infer<typeof _access_method_warning_map>
 
+const common_access_method_error = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which Seam created the error.'),
+  message: z
+    .string()
+    .describe(
+      'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
+    ),
+})
+
+const error_code_description =
+  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
+
+const failed_to_issue_error = common_access_method_error.extend({
+  error_code: z.literal('failed_to_issue').describe(error_code_description),
+}).describe(`
+    ---
+    resource_type: access_method
+    ---
+    Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.
+  `)
+
+const access_method_error = z
+  .discriminatedUnion('error_code', [failed_to_issue_error])
+  .describe(
+    'Error associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
+  )
+
+const _access_method_error_map = z.object({
+  failed_to_issue: failed_to_issue_error.optional().nullable(),
+})
+
+export type AccessMethodErrorMap = z.infer<typeof _access_method_error_map>
+
 // Pending mutations for access methods
 const common_pending_mutation = z.object({
   created_at: z
@@ -279,6 +327,11 @@ export const access_method = z.object({
     .describe(
       'Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
     ),
+  errors: z
+    .array(access_method_error)
+    .describe(
+      'Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).',
+    ),
   pending_mutations: z
     .array(access_method_pending_mutations)
     .describe(

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

@@ -19,6 +19,7 @@ export const DEVICE_PROVIDERS = {
   DOORKING: 'doorking',
   SALTO: 'salto',
   SALTO_KS: 'salto_ks',
+  SALTO_KS_ACCEPT: 'salto_ks_accept',
   LOCKLY: 'lockly',
   TTLOCK: 'ttlock',
   LINEAR: 'linear',
@@ -143,7 +144,7 @@ export const PROVIDER_CATEGORY_MAP = {
     'thirty_three_lock',
   ],
 
-  beta: ['kisi'],
+  beta: ['kisi', 'salto_ks_accept'],
 
   thermostats: ['ecobee', 'nest', 'sensi', 'honeywell_resideo', 'first_alert'],
   noise_sensors: ['minut', 'noiseaware'],

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

@@ -91,6 +91,24 @@ export const access_method_created_event = access_method_event.extend({
     An access method was created.
   `)
 
+export const access_method_delay_in_issuing_event = access_method_event.extend({
+  event_type: z.literal('access_method.delay_in_issuing'),
+}).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    Seam has not yet issued this access method, even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and the accompanying \`delay_in_issuing\` warning clears automatically once issuance succeeds.
+  `)
+
+export const access_method_failed_to_issue_event = access_method_event.extend({
+  event_type: z.literal('access_method.failed_to_issue'),
+}).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    Seam was unable to issue this access method before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and the accompanying \`failed_to_issue\` error clears automatically if the access method is eventually issued.
+  `)
+
 export type AccessMethodCreatedEvent = z.infer<
   typeof access_method_created_event
 >
@@ -106,4 +124,6 @@ export const access_method_events = [
   access_method_deleted_event,
   access_method_reissued_event,
   access_method_created_event,
+  access_method_delay_in_issuing_event,
+  access_method_failed_to_issue_event,
 ] as const