@seamapi/types 1.176.0 → 1.177.1

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

@@ -1 +1 @@
-export { connect_webview, custom_metadata, seam_event } from './models/index.js';
+export { action_attempt, connect_webview, custom_metadata, seam_event, } from './models/index.js';

package/lib/seam/connect/schemas.js

@@ -1,2 +1,2 @@
-export { connect_webview, custom_metadata, seam_event } from './models/index.js';
+export { action_attempt, connect_webview, custom_metadata, seam_event, } 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,EAAE,eAAe,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,eAAe,EACf,eAAe,EACf,UAAU,GACX,MAAM,mBAAmB,CAAA"}

package/package.json

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

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

@@ -1,4 +1,5 @@
 export type {
+  ActionAttempt,
   ConnectWebview,
   CustomMetadata,
   SeamEvent,

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

@@ -0,0 +1,25 @@
+import { z } from 'zod'
+
+import { deprecated_action_attempts } from './deprecated.js'
+import { lock_door_action_attempt } from './lock-door.js'
+import { reset_sandbox_workspace_action_attempt } from './reset-sandbox-workspace.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'
+import { set_heat_cool_action_attempt } from './set-heat-cool.js'
+import { set_thermostat_off_action_attempt } from './set-thermostat-off.js'
+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,
+  ...reset_sandbox_workspace_action_attempt.options,
+  ...set_cool_action_attempt.options,
+  ...set_heat_action_attempt.options,
+  ...set_heat_cool_action_attempt.options,
+  ...set_fan_mode_action_attempt.options,
+  ...set_thermostat_off_action_attempt.options,
+  ...deprecated_action_attempts,
+])
+
+export type ActionAttempt = z.infer<typeof action_attempt>

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

@@ -0,0 +1,27 @@
+import { z } from 'zod'
+
+export const common_action_attempt = z.object({
+  action_attempt_id: z.string().uuid().describe(`
+    ---
+    title: Action Attempt ID
+    ---
+    The ID of the action attempt.
+  `),
+  status: z.enum(['pending', 'success', 'error']),
+})
+
+export const common_pending_action_attempt = common_action_attempt.extend({
+  status: z.literal('pending'),
+  result: z.null(),
+  error: z.null(),
+})
+
+export const common_succeeded_action_attempt = common_action_attempt.extend({
+  status: z.literal('success'),
+  error: z.null(),
+})
+
+export const common_failed_action_attempt = common_action_attempt.extend({
+  status: z.literal('error'),
+  result: z.null(),
+})

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

@@ -0,0 +1,122 @@
+import { z } from 'zod'
+
+import {
+  common_failed_action_attempt,
+  common_pending_action_attempt,
+  common_succeeded_action_attempt,
+} from './common.js'
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.any()
+
+const sync_access_codes_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt.extend({
+    action_type: z.literal('SYNC_ACCESS_CODES'),
+  }),
+  common_succeeded_action_attempt.extend({
+    action_type: z.literal('SYNC_ACCESS_CODES'),
+    result,
+  }),
+  common_failed_action_attempt.extend({
+    action_type: z.literal('SYNC_ACCESS_CODES'),
+    error,
+  }),
+])
+
+const create_access_code_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt.extend({
+    action_type: z.literal('CREATE_ACCESS_CODE'),
+  }),
+  common_succeeded_action_attempt.extend({
+    action_type: z.literal('CREATE_ACCESS_CODE'),
+    result,
+  }),
+  common_failed_action_attempt.extend({
+    action_type: z.literal('CREATE_ACCESS_CODE'),
+    error,
+  }),
+])
+
+const delete_access_code_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt.extend({
+    action_type: z.literal('DELETE_ACCESS_CODE'),
+  }),
+  common_succeeded_action_attempt.extend({
+    action_type: z.literal('DELETE_ACCESS_CODE'),
+    result,
+  }),
+  common_failed_action_attempt.extend({
+    action_type: z.literal('DELETE_ACCESS_CODE'),
+    error,
+  }),
+])
+
+const update_access_code_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt.extend({
+    action_type: z.literal('UPDATE_ACCESS_CODE'),
+  }),
+  common_succeeded_action_attempt.extend({
+    action_type: z.literal('UPDATE_ACCESS_CODE'),
+    result,
+  }),
+  common_failed_action_attempt.extend({
+    action_type: z.literal('UPDATE_ACCESS_CODE'),
+    error,
+  }),
+])
+
+const create_noise_threshold_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt.extend({
+    action_type: z.literal('CREATE_NOISE_THRESHOLD'),
+  }),
+  common_succeeded_action_attempt.extend({
+    action_type: z.literal('CREATE_NOISE_THRESHOLD'),
+    result,
+  }),
+  common_failed_action_attempt.extend({
+    action_type: z.literal('CREATE_NOISE_THRESHOLD'),
+    error,
+  }),
+])
+
+const delete_noise_threshold_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt.extend({
+    action_type: z.literal('DELETE_NOISE_THRESHOLD'),
+  }),
+  common_succeeded_action_attempt.extend({
+    action_type: z.literal('DELETE_NOISE_THRESHOLD'),
+    result,
+  }),
+  common_failed_action_attempt.extend({
+    action_type: z.literal('DELETE_NOISE_THRESHOLD'),
+    error,
+  }),
+])
+
+const update_noise_threshold_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt.extend({
+    action_type: z.literal('UPDATE_NOISE_THRESHOLD'),
+  }),
+  common_succeeded_action_attempt.extend({
+    action_type: z.literal('UPDATE_NOISE_THRESHOLD'),
+    result,
+  }),
+  common_failed_action_attempt.extend({
+    action_type: z.literal('UPDATE_NOISE_THRESHOLD'),
+    error,
+  }),
+])
+
+export const deprecated_action_attempts = [
+  ...sync_access_codes_action_attempt.options,
+  ...create_access_code_action_attempt.options,
+  ...delete_access_code_action_attempt.options,
+  ...update_access_code_action_attempt.options,
+  ...create_noise_threshold_action_attempt.options,
+  ...delete_noise_threshold_action_attempt.options,
+  ...update_noise_threshold_action_attempt.options,
+] as const

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

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

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

@@ -0,0 +1,35 @@
+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('LOCK_DOOR')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const lock_door_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt
+    .extend({
+      action_type,
+    })
+    .describe('Locking door.'),
+  common_succeeded_action_attempt
+    .extend({
+      action_type,
+      result,
+    })
+    .describe('Locking door succeeded.'),
+  common_failed_action_attempt
+    .extend({ action_type, error })
+    .describe('Locking door failed.'),
+])
+
+export type LockDoorActionAttempt = z.infer<typeof lock_door_action_attempt>

package/src/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.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('RESET_SANDBOX_WORKSPACE')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const reset_sandbox_workspace_action_attempt = z.discriminatedUnion(
+  'status',
+  [
+    common_pending_action_attempt
+      .extend({
+        action_type,
+      })
+      .describe('Resetting sandbox workspace.'),
+    common_succeeded_action_attempt
+      .extend({
+        action_type,
+        result,
+      })
+      .describe('Resetting sandbox workspace succeeded.'),
+    common_failed_action_attempt
+      .extend({
+        action_type,
+        error,
+      })
+      .describe('Resetting sandbox workspace failed.'),
+  ],
+)

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

@@ -0,0 +1,33 @@
+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('SET_COOL')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const set_cool_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt
+    .extend({
+      action_type,
+    })
+    .describe('Setting HVAC to cool.'),
+  common_succeeded_action_attempt
+    .extend({
+      action_type,
+      result,
+    })
+    .describe('Setting HVAC to cool succeeded.'),
+  common_failed_action_attempt
+    .extend({ action_type, error })
+    .describe('Setting HVAC to cool failed.'),
+])

package/src/lib/seam/connect/models/action-attempts/set-fan-mode.ts

@@ -0,0 +1,33 @@
+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('SET_FAN_MODE')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const set_fan_mode_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt
+    .extend({
+      action_type,
+    })
+    .describe('Setting fan mode.'),
+  common_succeeded_action_attempt
+    .extend({
+      action_type,
+      result,
+    })
+    .describe('Setting fan mode succeeded.'),
+  common_failed_action_attempt
+    .extend({ action_type, error })
+    .describe('Setting fan mode failed.'),
+])

package/src/lib/seam/connect/models/action-attempts/set-heat-cool.ts

@@ -0,0 +1,33 @@
+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('SET_HEAT_COOL')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const set_heat_cool_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt
+    .extend({
+      action_type,
+    })
+    .describe('Setting HVAC to heat-cool mode.'),
+  common_succeeded_action_attempt
+    .extend({
+      action_type,
+      result,
+    })
+    .describe('Setting HVAC to heat-cool mode succeeded.'),
+  common_failed_action_attempt
+    .extend({ action_type, error })
+    .describe('Setting heat-cool mode failed.'),
+])

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

@@ -0,0 +1,33 @@
+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('SET_HEAT')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const set_heat_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt
+    .extend({
+      action_type,
+    })
+    .describe('Setting HVAC to heat mode.'),
+  common_succeeded_action_attempt
+    .extend({
+      action_type,
+      result,
+    })
+    .describe('Setting HVAC to heat mode succeeded.'),
+  common_failed_action_attempt
+    .extend({ action_type, error })
+    .describe('Setting HVAC to heat mode failed.'),
+])

package/src/lib/seam/connect/models/action-attempts/set-thermostat-off.ts

@@ -0,0 +1,36 @@
+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('SET_THERMOSTAT_OFF')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const set_thermostat_off_action_attempt = z.discriminatedUnion(
+  'status',
+  [
+    common_pending_action_attempt
+      .extend({
+        action_type,
+      })
+      .describe('Turning HVAC off.'),
+    common_succeeded_action_attempt
+      .extend({
+        action_type,
+        result,
+      })
+      .describe('Turning HVAC off succeeded.'),
+    common_failed_action_attempt
+      .extend({ action_type, error })
+      .describe('Turning HVAC off failed.'),
+  ],
+)

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

@@ -0,0 +1,35 @@
+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('UNLOCK_DOOR')
+
+const error = z.object({
+  type: z.string(),
+  message: z.string(),
+})
+
+const result = z.object({})
+
+export const unlock_door_action_attempt = z.discriminatedUnion('status', [
+  common_pending_action_attempt
+    .extend({
+      action_type,
+    })
+    .describe('Unlocking door.'),
+  common_succeeded_action_attempt
+    .extend({
+      action_type,
+      result,
+    })
+    .describe('Unlocking door succeeded.'),
+  common_failed_action_attempt
+    .extend({ action_type, error })
+    .describe('Unlocking door failed.'),
+])
+
+export type UnlockDoorActionAttempt = z.infer<typeof unlock_door_action_attempt>

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

@@ -77,7 +77,13 @@ export const common_device_properties = z.object({
     accessory_keypad_supported: z
       .boolean()
       .optional()
-      .describe('Indicates whether the device supports an accessory keypad.'),
+      .describe(
+        `
+      ---
+      deprecated: use device.properties.model.can_connect_accessory_keypad
+      ---
+      `,
+      ),
   }),
   has_direct_power: z
     .boolean()
@@ -128,7 +134,7 @@ export const common_device_properties = z.object({
     .describe(
       `
       ---
-      deprecated: use model.accessory_keypad_supported
+      deprecated: use device.properties.model.can_connect_accessory_keypad
       ---
       `,
     )

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

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { common_event } from './common.js'
 

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

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { common_event } from '../common.js'
 

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

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { common_acs_event } from './common.js'
 

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

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { common_acs_event } from './common.js'
 

package/src/lib/seam/connect/models/events/client-sessions.ts

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { common_event } from './common.js'
 

package/src/lib/seam/connect/models/events/common.ts

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 export const common_event = z.object({
   workspace_id: z.string().uuid().describe(`

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

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { common_event } from './common.js'
 

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

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { common_event } from './common.js'
 

package/src/lib/seam/connect/models/events/enrollment-automations.ts

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { common_event } from './common.js'
 

package/src/lib/seam/connect/models/events/phones.ts

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { common_event } from './common.js'
 

package/src/lib/seam/connect/models/events/seam-event.ts

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import { z } from 'zod'
 
 import { access_code_events } from './access-codes.js'
 import { acs_events } from './acs/index.js'

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

@@ -1,5 +1,6 @@
 export * from './access-codes/index.js'
 export * from './acs/index.js'
+export * from './action-attempts/index.js'
 export * from './capability-properties/index.js'
 export * from './connect-webviews/index.js'
 export * from './custom-metadata.js'