@seamapi/types 1.438.0 → 1.440.0

package/README.md

@@ -15,7 +15,8 @@ have a single source of truth that stays up to date with the API.
 
 ### Structure
 
-The main entrypoint for this module is empty: there is dedicated entrypoint for each Seam API namespace.
+There is dedicated entrypoint for each Seam API namespace.
+The main entrypoint for this module is re-exports the connect namespace.
 
 Each directory under `src/lib/seam/*` is owned by an upstream Seam repository.
 These files should not be edited manually as they will be overridden by automation.

package/dist/connect.cjs

@@ -19,6 +19,7 @@ __export(schemas_exports, {
   acs_system: () => acs_system,
   acs_user: () => acs_user,
   action_attempt: () => action_attempt,
+  batch: () => batch,
   bridge: () => bridge,
   bridge_client_session: () => bridge_client_session,
   building_block_type: () => building_block_type,
@@ -3960,6 +3961,37 @@ var action_attempt = zod.z.union([
 
   See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).
 `);
+var space = zod.z.object({
+  space_id: zod.z.string().uuid().describe("ID of the space."),
+  workspace_id: zod.z.string().uuid().describe(
+    "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space."
+  ),
+  name: zod.z.string().describe("Name of the space."),
+  display_name: zod.z.string().describe("Display name for the space."),
+  created_at: zod.z.string().datetime().describe("Date and time at which the space was created.")
+}).describe(`
+  ---
+  draft: Early access.
+  route_path: /spaces
+  ---
+  Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.
+  `);
+
+// src/lib/seam/connect/models/batches/spaces.ts
+var spaces_batch = zod.z.object({
+  batch_type: zod.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.");
+
+// src/lib/seam/connect/models/batches/batch.ts
+var batch = spaces_batch.describe(`
+  ---
+  route_path: /
+  ---
+  Represents a resource batch.
+`);
 var bridge = zod.z.object({
   bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
   workspace_id: zod.z.string().uuid().describe(
@@ -5252,7 +5284,7 @@ var seam_event = zod.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.
 `);
 var event_types = seam_event.options.map(
@@ -48800,6 +48832,189 @@ var openapi_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.",