@seamapi/types 1.437.1 → 1.439.0

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

@@ -1 +1 @@
-export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, 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_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, 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_encoder, acs_entrance, acs_system, acs_user, action_attempt, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, 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_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, building_block_type, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, 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,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,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,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,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.437.1",
+  "version": "1.439.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/internal/schemas.ts

@@ -72,6 +72,7 @@ export {
   room_resource,
   space,
   neutral_resource as space_resource,
+  spaces_batch,
   tenant_resource,
   thermostat_capability_properties,
   thermostat_device_type,

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

@@ -13,6 +13,7 @@ export type {
   ActionAttempt,
   Bridge,
   BuildingBlockType,
+  Bundle,
   ClientSession,
   ConnectedAccount,
   ConnectedAccountError,

package/src/lib/seam/connect/models/batches/batch.ts

@@ -0,0 +1,12 @@
+import type { z } from 'zod'
+
+import { spaces_batch } from './spaces.js'
+
+export const batch = spaces_batch.describe(`
+  ---
+  route_path: /
+  ---
+  Represents a resource batch.
+`)
+
+export type Bundle = z.infer<typeof batch>

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

@@ -0,0 +1,2 @@
+export * from './batch.js'
+export * from './spaces.js'

package/src/lib/seam/connect/models/batches/spaces.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod'
+
+import { acs_entrance } from '../acs/index.js'
+import { device } from '../devices/index.js'
+import { space } from '../spaces/index.js'
+
+export const spaces_batch = z
+  .object({
+    batch_type: z.literal('spaces'),
+    spaces: space.array().optional(),
+    devices: device.array().optional(),
+    acs_entrances: acs_entrance.array().optional(),
+  })
+  .describe('ID of the affected access system user.')
+
+export type SpacesBundle = z.infer<typeof spaces_batch>

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

@@ -1,5 +1,6 @@
 import { z } from 'zod'
 
+import { custom_metadata } from '../custom-metadata.js'
 import { common_event } from './common.js'
 
 const access_code_event = common_event.extend({
@@ -14,6 +15,16 @@ const access_code_event = common_event.extend({
     .describe(
       'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code.',
     ),
+  device_custom_metadata: custom_metadata
+    .optional()
+    .describe(
+      'Custom metadata of the device, present when device_id is provided.',
+    ),
+  connected_account_custom_metadata: custom_metadata
+    .optional()
+    .describe(
+      'Custom metadata of the connected account, present when connected_account_id is provided.',
+    ),
 })
 
 const code = z.string().describe('Code for the affected access code.')

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

@@ -1,5 +1,6 @@
 import { z } from 'zod'
 
+import { custom_metadata } from '../custom-metadata.js'
 import { common_event } from './common.js'
 
 const connect_webview_event = common_event.extend({
@@ -18,10 +19,17 @@ const connected_account_id = z
     'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event.',
   )
 
+const connected_account_custom_metadata = custom_metadata
+  .optional()
+  .describe(
+    'Custom metadata of the connected account; present when connected_account_id is provided.',
+  )
+
 export const connect_webview_login_succeeded_event =
   connect_webview_event.extend({
     event_type: z.literal('connect_webview.login_succeeded'),
     connected_account_id,
+    connected_account_custom_metadata,
   }).describe(`
     ---
     route_path: /connect_webviews

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

@@ -1,5 +1,6 @@
 import { z } from 'zod'
 
+import { custom_metadata } from '../custom-metadata.js'
 import { common_event } from './common.js'
 
 const connected_account_event = common_event.extend({
@@ -9,6 +10,11 @@ const connected_account_event = common_event.extend({
     .describe(
       'ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
     ),
+  connected_account_custom_metadata: custom_metadata
+    .optional()
+    .describe(
+      'Custom metadata of the connected account, present when connected_account_id is provided.',
+    ),
 })
 
 const connect_webview_id = z

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

@@ -1,5 +1,6 @@
 import { z } from 'zod'
 
+import { custom_metadata } from '../custom-metadata.js'
 import { climate_setting } from '../thermostats/climate-preset.js'
 import { common_event } from './common.js'
 
@@ -11,6 +12,16 @@ const device_event = common_event.extend({
     .describe(
       'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event.',
     ),
+  device_custom_metadata: custom_metadata
+    .optional()
+    .describe(
+      'Custom metadata of the device, present when device_id is provided.',
+    ),
+  connected_account_custom_metadata: custom_metadata
+    .optional()
+    .describe(
+      'Custom metadata of the connected account, present when connected_account_id is provided.',
+    ),
 })
 
 const battery_level = z

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

@@ -1,9 +1,15 @@
 import { z } from 'zod'
 
+import { custom_metadata } from '../custom-metadata.js'
 import { common_event } from './common.js'
 
 const phone_event = common_event.extend({
   device_id: z.string().uuid().describe('ID of the affected phone device.'),
+  device_custom_metadata: custom_metadata
+    .optional()
+    .describe(
+      'Custom metadata of the device; present when device_id is provided.',
+    ),
 })
 
 export const phone_deactivated_event = phone_event.extend({

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

@@ -29,7 +29,7 @@ export const seam_event = z.discriminatedUnion('event_type', [
   route_path: /events
   ---
   Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event.
-  
+
   As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
 `)
 

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

@@ -2,6 +2,7 @@ export * from './access-codes/index.js'
 export * from './access-grants/index.js'
 export * from './acs/index.js'
 export * from './action-attempts/index.js'
+export * from './batches/index.js'
 export * from './bridges/index.js'
 export * from './bridges/index.js'
 export * from './client-sessions/index.js'

package/src/lib/seam/connect/models/user-identities/user-identity.ts

@@ -143,6 +143,11 @@ export const user_identity = z.object({
     .describe(
       'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
     ),
+  acs_user_ids: z
+    .array(z.string().uuid())
+    .describe(
+      'Array of access system user IDs associated with the user identity.',
+    ),
 }).describe(`
   ---
   route_path: /user_identities