@seamapi/types 1.263.1 → 1.264.1

package/lib/seam/connect/schemas.d.ts

@@ -1 +1 @@
-export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
+export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';

package/lib/seam/connect/schemas.js

@@ -1,2 +1,2 @@
-export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
+export { access_code, acs_access_group, acs_credential, acs_entrance, acs_system, acs_user, action_attempt, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, noise_threshold, seam_event, thermostat_schedule, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
 //# sourceMappingURL=schemas.js.map

package/lib/seam/connect/schemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.263.1",
+  "version": "1.264.1",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -92,7 +92,7 @@
     "zod": "^3.21.4"
   },
   "devDependencies": {
-    "@seamapi/blueprint": "^0.27.0",
+    "@seamapi/blueprint": "^0.28.0",
     "@types/node": "^20.8.10",
     "concurrently": "^8.2.0",
     "del-cli": "^5.0.0",

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

@@ -72,5 +72,53 @@ export const unmanaged_acs_credential = common_acs_credential.merge(
   }),
 )
 
+export const acs_credential_on_encoder = z.object({
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time the credential was created.'),
+
+  is_issued: z.boolean().nullable(),
+
+  starts_at: z
+    .string()
+    .datetime()
+    .nullable()
+    .describe('Date and time the credential will become useable.'),
+  ends_at: z
+    .string()
+    .datetime()
+    .nullable()
+    .describe('Date and time the credential will stop being useable.'),
+
+  card_number: z
+    .string()
+    .nullable()
+    .describe('A number or string that physically identifies this card.'),
+
+  visionline_metadata: z
+    .object({
+      card_id: z.string(),
+      card_function_type: z.enum(['guest', 'staff']), // computed, looks at door ops, and checks is guest op is present.
+
+      cancelled: z.boolean(),
+      discarded: z.boolean(),
+      expired: z.boolean(),
+      overwritten: z.boolean(),
+      overridden: z.boolean().optional(),
+      pending_auto_update: z.boolean(),
+
+      card_format: z.enum(['TLCode', 'rfid48']),
+      card_holder: z.string().optional(),
+
+      number_of_issued_cards: z.number(),
+
+      // guest_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
+      // common_acs_entrance_ids: z.array(z.string().uuid()).optional(), // computed
+    })
+    .optional(),
+})
+
 export type AcsCredential = z.output<typeof acs_credential>
 export type UnmanagedAcsCredential = z.output<typeof unmanaged_acs_credential>
+export type AcsCredentialOnEncoder = z.output<typeof acs_credential_on_encoder>

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

@@ -4,8 +4,8 @@ import { activate_climate_preset_action_attempt } from './activate-climate-prese
 import { deprecated_action_attempts } from './deprecated.js'
 import { encode_card_action_attempt } from './encode-card.js'
 import { lock_door_action_attempt } from './lock-door.js'
-import { read_card_action_attempt } from './read-card.js'
 import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.js'
+import { scan_card_action_attempt } from './scan-card.js'
 import { set_cool_action_attempt } from './set-cool.js'
 import { set_fan_mode_action_attempt } from './set-fan-mode.js'
 import { set_heat_action_attempt } from './set-heat.js'
@@ -16,7 +16,7 @@ import { unlock_door_action_attempt } from './unlock-door.js'
 export const action_attempt = z.union([
   ...lock_door_action_attempt.options,
   ...unlock_door_action_attempt.options,
-  ...read_card_action_attempt.options,
+  ...scan_card_action_attempt.options,
   ...encode_card_action_attempt.options,
   ...reset_sandbox_workspace_action_attempt.options,
   ...set_cool_action_attempt.options,

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

@@ -11,7 +11,7 @@ const error = z.object({
   message: z.string(),
 })
 
-const result = z.any()
+const result = z.object({})
 
 const sync_access_codes_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt.extend({
@@ -33,7 +33,9 @@ const create_access_code_action_attempt = z.discriminatedUnion('status', [
   }),
   common_succeeded_action_attempt.extend({
     action_type: z.literal('CREATE_ACCESS_CODE'),
-    result,
+    result: z.object({
+      access_code: z.any(),
+    }),
   }),
   common_failed_action_attempt.extend({
     action_type: z.literal('CREATE_ACCESS_CODE'),
@@ -61,7 +63,9 @@ const update_access_code_action_attempt = z.discriminatedUnion('status', [
   }),
   common_succeeded_action_attempt.extend({
     action_type: z.literal('UPDATE_ACCESS_CODE'),
-    result,
+    result: z.object({
+      access_code: z.any(),
+    }),
   }),
   common_failed_action_attempt.extend({
     action_type: z.literal('UPDATE_ACCESS_CODE'),
@@ -75,7 +79,9 @@ const create_noise_threshold_action_attempt = z.discriminatedUnion('status', [
   }),
   common_succeeded_action_attempt.extend({
     action_type: z.literal('CREATE_NOISE_THRESHOLD'),
-    result,
+    result: z.object({
+      noise_threshold: z.any(),
+    }),
   }),
   common_failed_action_attempt.extend({
     action_type: z.literal('CREATE_NOISE_THRESHOLD'),
@@ -103,7 +109,9 @@ const update_noise_threshold_action_attempt = z.discriminatedUnion('status', [
   }),
   common_succeeded_action_attempt.extend({
     action_type: z.literal('UPDATE_NOISE_THRESHOLD'),
-    result,
+    result: z.object({
+      noise_threshold: z.any(),
+    }),
   }),
   common_failed_action_attempt.extend({
     action_type: z.literal('UPDATE_NOISE_THRESHOLD'),

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

@@ -13,18 +13,7 @@ const error = z.object({
   message: z.string(),
 })
 
-const result = z.object({
-  acs_credential_id: z
-    .string()
-    .uuid()
-    .nullable()
-    .describe('Matching acs_credential currently encoded on this card.'),
-  card_number: z
-    .string()
-    .nullable()
-    .describe('A number or string that physically identifies this card.'),
-  // TODO visionline_metadata: visionline_credential_metadata,
-})
+const result = z.object({})
 
 export const encode_card_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt

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

@@ -1 +1,2 @@
 export * from './action-attempt.js'
+export * from './common.js'

package/src/lib/seam/connect/models/action-attempts/{read-card.ts → scan-card.ts}

@@ -1,32 +1,35 @@
 import { z } from 'zod'
 
+import {
+  acs_credential,
+  acs_credential_on_encoder,
+  unmanaged_acs_credential,
+} from '../acs/acs-credential.js'
 import {
   common_failed_action_attempt,
   common_pending_action_attempt,
   common_succeeded_action_attempt,
 } from './common.js'
 
-const action_type = z.literal('READ_CARD')
+const action_type = z.literal('SCAN_CARD')
 
 const error = z.object({
   type: z.literal('no_card_on_encoder'),
   message: z.string(),
 })
 
+const acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential)
+
 const result = z.object({
-  // TODO acs_credential_id: z
-  //   .string()
-  //   .uuid()
-  //   .nullable()
-  //   .describe("Matching acs_credential currently encoded on this card."),
-  card_number: z
-    .string()
+  acs_credential_on_encoder: acs_credential_on_encoder.describe(
+    'Snapshot of the card data read from the physical encoder.',
+  ),
+  acs_credential_on_seam: acs_credential_on_seam
     .nullable()
-    .describe('A number or string that physically identifies this card.'),
-  // TODO visionline_metadata: visionline_credential_metadata,
+    .describe('Matching acs_credential currently encoded on this card.'),
 })
 
-export const read_card_action_attempt = z.discriminatedUnion('status', [
+export const scan_card_action_attempt = z.discriminatedUnion('status', [
   common_pending_action_attempt
     .extend({
       action_type,
@@ -43,4 +46,4 @@ export const read_card_action_attempt = z.discriminatedUnion('status', [
     .describe('Reading card data from physical encoder failed.'),
 ])
 
-export type ReadCardActionAttempt = z.infer<typeof read_card_action_attempt>
+export type ScanCardActionAttempt = z.infer<typeof scan_card_action_attempt>