@seamapi/types 1.456.0 → 1.457.1

package/dist/index.cjs

@@ -520,220 +520,6 @@ var capability_properties = zod.z.intersection(
   access_code_capability_properties.partial().merge(lock_capability_properties.partial()),
   thermostat_capability_properties
 );
-
-// src/lib/seam/devicedb/models/index.ts
-var models_exports = {};
-__export(models_exports, {
-  base_device_model_v1: () => base_device_model_v1,
-  device_capability_flags: () => device_capability_flags,
-  device_category: () => device_category,
-  device_connection_type: () => device_connection_type,
-  device_model_category_specific_properties: () => device_model_category_specific_properties,
-  device_model_v1: () => device_model_v1,
-  image_reference: () => image_reference,
-  manufacturer: () => manufacturer,
-  manufacturer_annotation: () => manufacturer_annotation,
-  manufacturer_annotation_code: () => manufacturer_annotation_code,
-  manufacturer_integration_support_level: () => manufacturer_integration_support_level,
-  thermostat: () => thermostat
-});
-var device_capability_flags = zod.z.object({
-  can_remotely_unlock: zod.z.boolean(),
-  can_remotely_lock: zod.z.boolean(),
-  can_program_offline_access_codes: zod.z.boolean(),
-  can_program_online_access_codes: zod.z.boolean(),
-  can_hvac_heat: zod.z.boolean(),
-  can_hvac_cool: zod.z.boolean(),
-  can_hvac_heat_cool: zod.z.boolean(),
-  can_turn_off_hvac: zod.z.boolean()
-}).partial();
-var device_model_capability_flags_map = {
-  can_remotely_lock: zod.z.literal(true),
-  can_remotely_unlock: zod.z.literal(true),
-  can_program_offline_access_codes: zod.z.literal(true),
-  can_program_online_access_codes: zod.z.literal(true),
-  can_hvac_heat: zod.z.literal(true),
-  can_hvac_cool: zod.z.literal(true),
-  can_hvac_heat_cool: zod.z.literal(true),
-  can_turn_off_hvac: zod.z.literal(true)
-};
-var device_model_capability_flags = zod.z.object(device_model_capability_flags_map).partial();
-var hardware = zod.z.object({
-  has_physical_key: zod.z.boolean()
-}).partial();
-var image_reference = zod.z.object({
-  url: zod.z.string().url(),
-  width: zod.z.number(),
-  height: zod.z.number()
-});
-var manufacturer_integration_support_level = zod.z.enum([
-  "stable",
-  "beta",
-  "planned",
-  "unsupported",
-  "inquire"
-]);
-var manufacturer_annotation_code = zod.z.enum(["subscription_required"]);
-var manufacturer_annotation = zod.z.object({
-  annotation_code: manufacturer_annotation_code,
-  message: zod.z.string().trim().nonempty()
-});
-var manufacturer = zod.z.object({
-  manufacturer_id: zod.z.string().uuid(),
-  display_name: zod.z.string(),
-  logo: image_reference.optional(),
-  /** @deprecated */
-  integration: manufacturer_integration_support_level,
-  integration_support_level: manufacturer_integration_support_level,
-  is_connect_webview_supported: zod.z.boolean(),
-  requires_seam_support_to_add_account: zod.z.boolean(),
-  device_model_count: zod.z.number(),
-  annotations: zod.z.array(manufacturer_annotation),
-  website: zod.z.string().url().optional(),
-  legal_name: zod.z.string().optional(),
-  parent_organization: zod.z.string().optional(),
-  headquarters: zod.z.array(zod.z.string()).optional(),
-  countries_of_origin: zod.z.array(zod.z.string()).optional(),
-  founding_year: zod.z.string().optional(),
-  us_customer_support_tel: zod.z.string().optional(),
-  us_customer_support_email: zod.z.string().email().optional(),
-  us_customer_support_contact_url: zod.z.string().url().optional(),
-  seam_api_guide: zod.z.string().optional(),
-  description: zod.z.string().optional()
-});
-
-// src/lib/seam/devicedb/models/device-model.ts
-var device_category = zod.z.enum([
-  "smartlock",
-  "sensor",
-  "thermostat",
-  "relay",
-  "intercom",
-  "accessory"
-]);
-var device_connection_type = zod.z.enum([
-  "wifi",
-  "zwave",
-  "zigbee",
-  "unknown"
-]);
-var smartlock = zod.z.object({
-  main_category: zod.z.literal(device_category.enum.smartlock),
-  physical_properties: zod.z.object({
-    lock_type: zod.z.enum([
-      "deadbolt",
-      "lever",
-      "mortise",
-      "lockbox",
-      "cylinder",
-      "padlock",
-      "locker",
-      "unknown"
-    ]),
-    has_physical_key: zod.z.boolean(),
-    has_camera: zod.z.boolean()
-  }),
-  software_features: zod.z.object({
-    can_remotely_unlock: zod.z.boolean(),
-    can_program_access_codes: zod.z.boolean(),
-    can_program_access_schedules: zod.z.boolean(),
-    can_program_access_codes_offline: zod.z.boolean()
-  })
-}).merge(
-  device_model_capability_flags.pick({
-    can_remotely_lock: true,
-    can_remotely_unlock: true,
-    can_program_offline_access_codes: true,
-    can_program_online_access_codes: true
-  })
-);
-var sensor = zod.z.object({
-  main_category: zod.z.literal(device_category.enum.sensor),
-  physical_properties: zod.z.object({
-    has_noise_sensor: zod.z.boolean(),
-    has_humidity_sensor: zod.z.boolean(),
-    has_temperature_sensor: zod.z.boolean(),
-    has_occupancy_detection: zod.z.boolean()
-  })
-});
-var thermostat = zod.z.object({
-  main_category: zod.z.literal(device_category.enum.thermostat),
-  physical_properties: zod.z.object({
-    available_modes: zod.z.enum(["heat", "cool", "fan", "eco"]).array(),
-    is_heat_pump_compatible: zod.z.boolean(),
-    has_occupancy_detection: zod.z.boolean(),
-    supports_demand_response: zod.z.boolean(),
-    has_humidity_sensor: zod.z.boolean(),
-    has_temperature_sensor: zod.z.boolean(),
-    supports_emergency_heating_mode: zod.z.boolean()
-  }),
-  software_features: zod.z.object({
-    can_program_climate_schedules: zod.z.boolean()
-  })
-}).merge(
-  device_model_capability_flags.pick({
-    can_hvac_heat: true,
-    can_hvac_cool: true,
-    can_hvac_heat_cool: true,
-    can_turn_off_hvac: true
-  })
-);
-var relay = zod.z.object({
-  main_category: zod.z.literal(device_category.enum.relay)
-});
-var intercom = zod.z.object({
-  main_category: zod.z.literal(device_category.enum.intercom),
-  physical_properties: zod.z.object({
-    has_camera: zod.z.boolean(),
-    has_rfid_reader: zod.z.boolean().default(false),
-    has_nfc_reader: zod.z.boolean().default(false),
-    has_wiegand_interface: zod.z.boolean().default(false)
-  }),
-  software_features: zod.z.object({
-    can_remotely_unlock: zod.z.boolean(),
-    can_program_access_codes: zod.z.boolean(),
-    can_unlock_with_face_recognition: zod.z.boolean().default(false),
-    supports_onvif: zod.z.boolean().default(false)
-  })
-});
-var accessory = zod.z.object({
-  main_category: zod.z.literal(device_category.enum.accessory)
-});
-var device_model_category_specific_properties = zod.z.discriminatedUnion(
-  "main_category",
-  [smartlock, sensor, thermostat, relay, intercom, accessory]
-);
-var base_device_model_v1 = zod.z.object({
-  device_model_id: zod.z.string().uuid(),
-  manufacturer: manufacturer.omit({
-    device_model_count: true
-  }),
-  is_device_supported: zod.z.boolean(),
-  display_name: zod.z.string(),
-  description: zod.z.string(),
-  product_url: zod.z.string().optional(),
-  main_connection_type: device_connection_type,
-  hardware,
-  aesthetic_variants: zod.z.object({
-    slug: zod.z.string(),
-    display_name: zod.z.string(),
-    primary_color_hex: zod.z.string().optional(),
-    manufacturer_sku: zod.z.string().optional(),
-    front_image: image_reference.optional(),
-    back_image: image_reference.optional(),
-    images: image_reference.array()
-  }).array(),
-  power_sources: zod.z.enum([
-    "battery",
-    "hardwired",
-    "mechanical_harvesting",
-    "wireless",
-    "ethernet"
-  ]).array()
-});
-var device_model_v1 = base_device_model_v1.and(
-  device_model_category_specific_properties
-);
 zod.z.record(
   zod.z.string().max(40),
   zod.z.union([zod.z.string().max(500), zod.z.boolean(), zod.z.null()])
@@ -1324,12 +1110,20 @@ var phone_specific_properties = zod.z.object({
           `);
 
 // src/lib/seam/connect/models/devices/device.ts
-var device_capability_flags2 = models_exports.device_capability_flags.extend({
-  can_simulate_removal: zod.z.boolean().optional(),
-  can_simulate_connection: zod.z.boolean().optional(),
-  can_simulate_disconnection: zod.z.boolean().optional(),
-  can_unlock_with_code: zod.z.boolean().optional()
-});
+var device_capability_flags = zod.z.object({
+  can_remotely_unlock: zod.z.boolean(),
+  can_remotely_lock: zod.z.boolean(),
+  can_program_offline_access_codes: zod.z.boolean(),
+  can_program_online_access_codes: zod.z.boolean(),
+  can_hvac_heat: zod.z.boolean(),
+  can_hvac_cool: zod.z.boolean(),
+  can_hvac_heat_cool: zod.z.boolean(),
+  can_turn_off_hvac: zod.z.boolean(),
+  can_simulate_removal: zod.z.boolean(),
+  can_simulate_connection: zod.z.boolean(),
+  can_simulate_disconnection: zod.z.boolean(),
+  can_unlock_with_code: zod.z.boolean()
+}).partial();
 var battery_status = zod.z.enum(["critical", "low", "good", "full"]).describe(`Represents the current status of the battery charge level. Values are \`critical\`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; \`low\`, which signifies that the battery is under the preferred threshold and should be charged soon; \`good\`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and \`full\`, which represents a battery that is fully charged, providing the maximum duration of usage.
           `);
 var common_device_error = zod.z.object({
@@ -1878,7 +1672,7 @@ var device = zod.z.object({
     "Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices)."
   ),
   custom_metadata
-}).merge(device_capability_flags2).describe(`
+}).merge(device_capability_flags).describe(`
     ---
     route_path: /devices
     property_groups:
@@ -2012,7 +1806,7 @@ var device_provider = zod.z.object({
   display_name: zod.z.string(),
   image_url: zod.z.string(),
   provider_categories: zod.z.array(zod.z.enum(PUBLIC_PROVIDER_CATEGORIES))
-}).extend(device_capability_flags2.shape).describe(`
+}).extend(device_capability_flags.shape).describe(`
     ---
     route_path: /devices
     ---
@@ -2061,7 +1855,7 @@ var unmanaged_device = device.pick({
     ---
     properties of the device.
   `)
-}).merge(device_capability_flags2).describe(`
+}).merge(device_capability_flags).describe(`
     ---
     route_path: /devices/unmanaged
     property_groups:
@@ -3993,6 +3787,12 @@ var access_grants_batch = zod.z.object({
   devices: device.array().optional(),
   acs_entrances: acs_entrance.array().optional()
 });
+var access_methods_batch = zod.z.object({
+  batch_type: zod.z.literal("access_methods"),
+  spaces: space.array().optional(),
+  devices: device.array().optional(),
+  acs_entrances: acs_entrance.array().optional()
+});
 var spaces_batch = zod.z.object({
   batch_type: zod.z.literal("spaces"),
   spaces: space.array().optional(),
@@ -4001,7 +3801,11 @@ var spaces_batch = zod.z.object({
 }).describe("ID of the affected access system user.");
 
 // src/lib/seam/connect/models/batches/batch.ts
-var batch = zod.z.union([spaces_batch, access_grants_batch]).describe(`
+var batch = zod.z.union([
+  spaces_batch,
+  access_grants_batch,
+  access_methods_batch
+]).describe(`
   ---
   route_path: /
   ---
@@ -30767,6 +30571,30 @@ var openapi_default = {
                           },
                           required: ["batch_type"],
                           type: "object"
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: "#/components/schemas/acs_entrance"
+                              },
+                              type: "array"
+                            },
+                            batch_type: {
+                              enum: ["access_methods"],
+                              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": "/"
@@ -30886,6 +30714,30 @@ var openapi_default = {
                           },
                           required: ["batch_type"],
                           type: "object"
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: "#/components/schemas/acs_entrance"
+                              },
+                              type: "array"
+                            },
+                            batch_type: {
+                              enum: ["access_methods"],
+                              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": "/"
@@ -31497,6 +31349,299 @@ var openapi_default = {
         "x-title": "Get an Access Method"
       }
     },
+    "/access_methods/get_related": {
+      get: {
+        description: "Gets all related resources for one or more Access Methods.",
+        operationId: "accessMethodsGetRelatedGet",
+        parameters: [
+          {
+            in: "query",
+            name: "access_method_ids",
+            required: true,
+            schema: {
+              description: "IDs of the access methods 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.",
+                      oneOf: [
+                        {
+                          description: "ID of the affected access system user.",
+                          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"
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: "#/components/schemas/acs_entrance"
+                              },
+                              type: "array"
+                            },
+                            batch_type: {
+                              enum: ["access_grants"],
+                              type: "string"
+                            },
+                            devices: {
+                              items: { $ref: "#/components/schemas/device" },
+                              type: "array"
+                            },
+                            spaces: {
+                              items: { $ref: "#/components/schemas/space" },
+                              type: "array"
+                            }
+                          },
+                          required: ["batch_type"],
+                          type: "object"
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: "#/components/schemas/acs_entrance"
+                              },
+                              type: "array"
+                            },
+                            batch_type: {
+                              enum: ["access_methods"],
+                              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: "/access_methods/get_related",
+        tags: [],
+        "x-batch-type": "access_methods",
+        "x-draft": "Early access.",
+        "x-fern-sdk-group-name": ["access_methods"],
+        "x-fern-sdk-method-name": "get_related",
+        "x-fern-sdk-return-value": "batch",
+        "x-response-key": "batch",
+        "x-title": "Get related Access Method resources"
+      },
+      post: {
+        description: "Gets all related resources for one or more Access Methods.",
+        operationId: "accessMethodsGetRelatedPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: {
+                  access_method_ids: {
+                    description: "IDs of the access methods that you want to get along with their related resources.",
+                    items: { format: "uuid", type: "string" },
+                    type: "array"
+                  },
+                  exclude: {
+                    items: {
+                      enum: ["spaces", "devices", "acs_entrances"],
+                      type: "string"
+                    },
+                    type: "array"
+                  },
+                  include: {
+                    items: {
+                      enum: ["spaces", "devices", "acs_entrances"],
+                      type: "string"
+                    },
+                    type: "array"
+                  }
+                },
+                required: ["access_method_ids"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: {
+                    batch: {
+                      description: "Represents a resource batch.",
+                      oneOf: [
+                        {
+                          description: "ID of the affected access system user.",
+                          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"
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: "#/components/schemas/acs_entrance"
+                              },
+                              type: "array"
+                            },
+                            batch_type: {
+                              enum: ["access_grants"],
+                              type: "string"
+                            },
+                            devices: {
+                              items: { $ref: "#/components/schemas/device" },
+                              type: "array"
+                            },
+                            spaces: {
+                              items: { $ref: "#/components/schemas/space" },
+                              type: "array"
+                            }
+                          },
+                          required: ["batch_type"],
+                          type: "object"
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: "#/components/schemas/acs_entrance"
+                              },
+                              type: "array"
+                            },
+                            batch_type: {
+                              enum: ["access_methods"],
+                              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: "/access_methods/get_related",
+        tags: [],
+        "x-batch-type": "access_methods",
+        "x-draft": "Early access.",
+        "x-fern-sdk-group-name": ["access_methods"],
+        "x-fern-sdk-method-name": "get_related",
+        "x-fern-sdk-return-value": "batch",
+        "x-response-key": "batch",
+        "x-title": "Get related Access Method resources"
+      }
+    },
     "/access_methods/list": {
       get: {
         description: "Lists all access methods, usually filtered by Access Grant.",
@@ -41998,7 +42143,7 @@ var openapi_default = {
     },
     "/devices/simulate/connect_to_hub": {
       post: {
-        description: "Simulates bringing the Wi-Fi hub (bridge) back online for a device.  \nOnly applicable for [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) and August locks today, but designed so we can extend to other providers later.  \nThis will clear the `hub_disconnected` error on the device.",
+        description: "Simulates bringing the Wi\u2011Fi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.",
         operationId: "devicesSimulateConnectToHubPost",
         requestBody: {
           content: {
@@ -49444,6 +49589,30 @@ var openapi_default = {
                           },
                           required: ["batch_type"],
                           type: "object"
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: "#/components/schemas/acs_entrance"
+                              },
+                              type: "array"
+                            },
+                            batch_type: {
+                              enum: ["access_methods"],
+                              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": "/"
@@ -49563,6 +49732,30 @@ var openapi_default = {
                           },
                           required: ["batch_type"],
                           type: "object"
+                        },
+                        {
+                          properties: {
+                            acs_entrances: {
+                              items: {
+                                $ref: "#/components/schemas/acs_entrance"
+                              },
+                              type: "array"
+                            },
+                            batch_type: {
+                              enum: ["access_methods"],
+                              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": "/"