@seamapi/types 1.384.0 → 1.386.0

package/package.json

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

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

@@ -20,6 +20,11 @@ export const access_grant = z.object({
   requested_access_methods: z
     .array(requested_access_method)
     .describe('Access methods that the user requested for this access grant.'),
+  access_method_ids: z
+    .array(z.string().uuid())
+    .describe(
+      'IDs of the access methods that were created for this access grant.',
+    ),
   display_name: z.string().describe('Display name of the access grant.'),
   created_at: z
     .string()

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

@@ -13,9 +13,11 @@ export const requested_access_method = z.object({
     .describe(
       'Date and time at which the requested access method was added to this access grant.',
     ),
-  provisioned_access_method_ids: z
+  created_access_method_ids: z
     .array(z.string().uuid())
-    .describe('IDs of the locations to which access is being given.'),
+    .describe(
+      'IDs of the access methods that were created for this requested access method.',
+    ),
 }).describe(`
   ---
   undocumented: Unreleased.

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

@@ -8,6 +8,8 @@ import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspac
 import { scan_credential_action_attempt } from './scan-credential.js'
 import { set_fan_mode_action_attempt } from './set-fan-mode.js'
 import { set_hvac_mode_action_attempt } from './set-hvac-mode.js'
+import { simulate_keypad_code_entry_action_attempt } from './simulate-keypad-code-entry.js'
+import { simulate_manual_lock_via_keypad_action_attempt } from './simulate-manual-lock-via-keypad.js'
 import { unlock_door_action_attempt } from './unlock-door.js'
 
 export const action_attempt = z.union([
@@ -19,6 +21,8 @@ export const action_attempt = z.union([
   ...set_fan_mode_action_attempt.options,
   ...set_hvac_mode_action_attempt.options,
   ...activate_climate_preset_action_attempt.options,
+  ...simulate_keypad_code_entry_action_attempt.options,
+  ...simulate_manual_lock_via_keypad_action_attempt.options,
   ...deprecated_action_attempts,
 ]).describe(`
   ---

package/src/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod'
+
+import {
+  common_failed_action_attempt,
+  common_pending_action_attempt,
+  common_succeeded_action_attempt,
+} from './common.js'
+
+const action_type = z.literal('SIMULATE_KEYPAD_CODE_ENTRY')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const simulate_keypad_code_entry_action_attempt = z.discriminatedUnion(
+  'status',
+  [
+    common_pending_action_attempt
+      .extend({
+        action_type,
+      })
+      .describe('Simulating keypad code entry.'),
+    common_succeeded_action_attempt
+      .extend({
+        action_type,
+        result,
+      })
+      .describe('Simulating keypad code entry succeeded.'),
+    common_failed_action_attempt
+      .extend({
+        action_type,
+        error,
+      })
+      .describe('Simulating keypad code entry failed.'),
+  ],
+)

package/src/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.ts

@@ -0,0 +1,37 @@
+import { z } from 'zod'
+
+import {
+  common_failed_action_attempt,
+  common_pending_action_attempt,
+  common_succeeded_action_attempt,
+} from './common.js'
+
+const action_type = z.literal('SIMULATE_MANUAL_LOCK_VIA_KEYPAD')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const simulate_manual_lock_via_keypad_action_attempt =
+  z.discriminatedUnion('status', [
+    common_pending_action_attempt
+      .extend({
+        action_type,
+      })
+      .describe('Simulating manual lock via keypad.'),
+    common_succeeded_action_attempt
+      .extend({
+        action_type,
+        result,
+      })
+      .describe('Simulating manual lock via keypad succeeded.'),
+    common_failed_action_attempt
+      .extend({
+        action_type,
+        error,
+      })
+      .describe('Simulating manual lock via keypad failed.'),
+  ])

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

@@ -0,0 +1,9 @@
+import { z } from 'zod'
+
+export const hex_color_code = z.string().refine((value) => {
+  if (value != null) {
+    return /^#[\da-fa-z]{3,6}$/i.test(value)
+  }
+
+  return true
+}, 'Must be a hex color')

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

@@ -0,0 +1,92 @@
+import { z } from 'zod'
+
+import { common_event } from './common.js'
+
+const access_grant_event = common_event.extend({
+  access_grant_id: z.string().uuid().describe('ID of the access grant.'),
+})
+
+export const access_grant_created_event = access_grant_event.extend({
+  event_type: z.literal('access_grant.created'),
+}).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    An access grant was created.
+  `)
+
+export type AccessGrantCreatedEvent = z.infer<typeof access_grant_created_event>
+
+export const access_grant_deleted_event = access_grant_event.extend({
+  event_type: z.literal('access_grant.deleted'),
+}).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    An access grant was deleted.
+  `)
+
+export type AccessGrantDeleteddEvent = z.infer<
+  typeof access_grant_deleted_event
+>
+
+export const access_grant_access_granted_to_all_doors_event =
+  access_grant_event.extend({
+    event_type: z.literal('access_grant.access_granted_to_all_doors'),
+  }).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    All access requested for an access grant was successfully granted.
+  `)
+
+export type AccessGrantAccessGrantedToAllDoorsEvent = z.infer<
+  typeof access_grant_access_granted_to_all_doors_event
+>
+
+const acs_entrance_id = z
+  .string()
+  .uuid()
+  .describe(
+    'ID of the door, an [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
+  )
+
+export const access_grant_access_granted_to_door_event =
+  access_grant_event.extend({
+    event_type: z.literal('access_grant.access_granted_to_door'),
+    acs_entrance_id,
+  }).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    Access requested as part of an access grant to a particular door was successfully granted.
+  `)
+
+export type AccessGrantAccessGrantedToDoorEvent = z.infer<
+  typeof access_grant_access_granted_to_door_event
+>
+
+export const access_grant_access_to_door_lost_event = access_grant_event.extend(
+  {
+    event_type: z.literal('access_grant.access_to_door_lost'),
+    acs_entrance_id,
+  },
+).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    Access to a particular door that was requested as part of an access grant was lost.
+  `)
+
+export type AccessGrantAccessToDoorLostEvent = z.infer<
+  typeof access_grant_access_to_door_lost_event
+>
+
+export const access_code_events = [
+  access_grant_created_event,
+  access_grant_deleted_event,
+  access_grant_access_granted_to_all_doors_event,
+  access_grant_access_granted_to_door_event,
+  access_grant_access_to_door_lost_event,
+  access_grant_deleted_event,
+] as const

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

@@ -0,0 +1,51 @@
+import { z } from 'zod'
+
+import { common_event } from './common.js'
+
+const access_method_event = common_event.extend({
+  access_method_id: z.string().uuid().describe('ID of the access method.'),
+})
+
+export const access_method_issued_event = access_method_event.extend({
+  event_type: z.literal('access_method.issued'),
+}).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    An access method was issued.
+  `)
+
+export type AccessMethodIssuedEvent = z.infer<typeof access_method_issued_event>
+
+export const access_method_card_encoding_required_event =
+  access_method_event.extend({
+    event_type: z.literal('access_method.card_encoding_required'),
+  }).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    An access method representing a physical card requires encoding.
+  `)
+
+export type AccessMethodCardEncodingRequiredEvent = z.infer<
+  typeof access_method_card_encoding_required_event
+>
+
+export const access_method_revoked_event = access_method_event.extend({
+  event_type: z.literal('access_method.revoked'),
+}).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    An access method was revoked.
+  `)
+
+export type AccessMethodRevokedEvent = z.infer<
+  typeof access_method_revoked_event
+>
+
+export const access_code_events = [
+  access_method_issued_event,
+  access_method_revoked_event,
+  access_method_card_encoding_required_event,
+] as const

package/src/lib/seam/connect/models/workspaces/workspace.ts

@@ -1,10 +1,19 @@
 import { z } from 'zod'
 
+import { hex_color_code } from '../colors.js'
+
 export const workspace = z.object({
   workspace_id: z.string().uuid(),
   name: z.string(),
   company_name: z.string(),
   is_sandbox: z.boolean(),
+  connect_webview_customization: z.object({
+    primary_button_color: hex_color_code.optional(),
+    primary_button_text_color: hex_color_code.optional(),
+    success_message: z.string().optional(),
+    logo_shape: z.enum(['circle', 'square']).optional(),
+    inviter_logo_url: z.string().optional(),
+  }),
   is_suspended: z
     .boolean()
     .describe('True if a sandbox workspace has not been accessed in 14 days'),