@seamapi/types 1.438.0 → 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.438.0",
+  "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/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/openapi.ts

@@ -47116,6 +47116,191 @@ export default {
         'x-title': 'Get a Space',
       },
     },
+    '/spaces/get_related': {
+      get: {
+        description: 'Gets all related resources for one or more Spaces.',
+        operationId: 'spacesGetRelatedGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'space_ids',
+            required: true,
+            schema: {
+              description:
+                'IDs of the spaces that you want to get along with their related resources.',
+              items: { format: 'uuid', type: 'string' },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'include',
+            required: false,
+            schema: {
+              items: {
+                enum: ['spaces', 'devices', 'acs_entrances'],
+                type: 'string',
+              },
+              type: 'array',
+            },
+          },
+          {
+            in: 'query',
+            name: 'exclude',
+            required: false,
+            schema: {
+              items: {
+                enum: ['spaces', 'devices', 'acs_entrances'],
+                type: 'string',
+              },
+              type: 'array',
+            },
+          },
+        ],
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    batch: {
+                      description: 'Represents a resource batch.',
+                      properties: {
+                        acs_entrances: {
+                          items: { $ref: '#/components/schemas/acs_entrance' },
+                          type: 'array',
+                        },
+                        batch_type: { enum: ['spaces'], type: 'string' },
+                        devices: {
+                          items: { $ref: '#/components/schemas/device' },
+                          type: 'array',
+                        },
+                        spaces: {
+                          items: { $ref: '#/components/schemas/space' },
+                          type: 'array',
+                        },
+                      },
+                      required: ['batch_type'],
+                      type: 'object',
+                      'x-route-path': '/',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['batch', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/spaces/get_related',
+        tags: [],
+        'x-batch-type': 'spaces',
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['spaces'],
+        'x-fern-sdk-method-name': 'get_related',
+        'x-fern-sdk-return-value': 'batch',
+        'x-response-key': 'batch',
+        'x-title': 'Get related Space resources',
+      },
+      post: {
+        description: 'Gets all related resources for one or more Spaces.',
+        operationId: 'spacesGetRelatedPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  exclude: {
+                    items: {
+                      enum: ['spaces', 'devices', 'acs_entrances'],
+                      type: 'string',
+                    },
+                    type: 'array',
+                  },
+                  include: {
+                    items: {
+                      enum: ['spaces', 'devices', 'acs_entrances'],
+                      type: 'string',
+                    },
+                    type: 'array',
+                  },
+                  space_ids: {
+                    description:
+                      'IDs of the spaces that you want to get along with their related resources.',
+                    items: { format: 'uuid', type: 'string' },
+                    type: 'array',
+                  },
+                },
+                required: ['space_ids'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    batch: {
+                      description: 'Represents a resource batch.',
+                      properties: {
+                        acs_entrances: {
+                          items: { $ref: '#/components/schemas/acs_entrance' },
+                          type: 'array',
+                        },
+                        batch_type: { enum: ['spaces'], type: 'string' },
+                        devices: {
+                          items: { $ref: '#/components/schemas/device' },
+                          type: 'array',
+                        },
+                        spaces: {
+                          items: { $ref: '#/components/schemas/space' },
+                          type: 'array',
+                        },
+                      },
+                      required: ['batch_type'],
+                      type: 'object',
+                      'x-route-path': '/',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['batch', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/spaces/get_related',
+        tags: [],
+        'x-batch-type': 'spaces',
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['spaces'],
+        'x-fern-sdk-method-name': 'get_related',
+        'x-fern-sdk-return-value': 'batch',
+        'x-response-key': 'batch',
+        'x-title': 'Get related Space resources',
+      },
+    },
     '/spaces/list': {
       get: {
         description: 'Returns a list of all spaces.',