@seamapi/types 1.932.0 → 1.934.0

package/lib/seam/devicedb/models/device-model.d.ts

@@ -545,6 +545,7 @@ export declare const base_device_model_v1: z.ZodObject<{
     power_sources: z.ZodArray<z.ZodEnum<["battery", "hardwired", "mechanical_harvesting", "wireless", "ethernet"]>, "many">;
 }, "strip", z.ZodTypeAny, {
     display_name: string;
+    description: string;
     manufacturer: {
         display_name: string;
         manufacturer_id: string;
@@ -573,7 +574,6 @@ export declare const base_device_model_v1: z.ZodObject<{
         us_customer_support_contact_url?: string | undefined;
         seam_api_guide?: string | undefined;
     };
-    description: string;
     hardware: {
         has_physical_key?: boolean | undefined;
     };
@@ -605,6 +605,7 @@ export declare const base_device_model_v1: z.ZodObject<{
     product_url?: string | undefined;
 }, {
     display_name: string;
+    description: string;
     manufacturer: {
         display_name: string;
         manufacturer_id: string;
@@ -633,7 +634,6 @@ export declare const base_device_model_v1: z.ZodObject<{
         us_customer_support_contact_url?: string | undefined;
         seam_api_guide?: string | undefined;
     };
-    description: string;
     hardware: {
         has_physical_key?: boolean | undefined;
     };
@@ -864,6 +864,7 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
     power_sources: z.ZodArray<z.ZodEnum<["battery", "hardwired", "mechanical_harvesting", "wireless", "ethernet"]>, "many">;
 }, "strip", z.ZodTypeAny, {
     display_name: string;
+    description: string;
     manufacturer: {
         display_name: string;
         manufacturer_id: string;
@@ -892,7 +893,6 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
         us_customer_support_contact_url?: string | undefined;
         seam_api_guide?: string | undefined;
     };
-    description: string;
     hardware: {
         has_physical_key?: boolean | undefined;
     };
@@ -924,6 +924,7 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
     product_url?: string | undefined;
 }, {
     display_name: string;
+    description: string;
     manufacturer: {
         display_name: string;
         manufacturer_id: string;
@@ -952,7 +953,6 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
         us_customer_support_contact_url?: string | undefined;
         seam_api_guide?: string | undefined;
     };
-    description: string;
     hardware: {
         has_physical_key?: boolean | undefined;
     };

package/lib/seam/devicedb/route-specs.d.ts

@@ -210,6 +210,7 @@ export declare const routes: {
                 power_sources: z.ZodArray<z.ZodEnum<["battery", "hardwired", "mechanical_harvesting", "wireless", "ethernet"]>, "many">;
             }, "strip", z.ZodTypeAny, {
                 display_name: string;
+                description: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -238,7 +239,6 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                description: string;
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
@@ -270,6 +270,7 @@ export declare const routes: {
                 product_url?: string | undefined;
             }, {
                 display_name: string;
+                description: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -298,7 +299,6 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                description: string;
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
@@ -593,6 +593,7 @@ export declare const routes: {
         }, "strip", z.ZodTypeAny, {
             device_model: {
                 display_name: string;
+                description: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -621,7 +622,6 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                description: string;
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
@@ -716,6 +716,7 @@ export declare const routes: {
         }, {
             device_model: {
                 display_name: string;
+                description: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -744,7 +745,6 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                description: string;
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
@@ -1070,6 +1070,7 @@ export declare const routes: {
                 power_sources: z.ZodArray<z.ZodEnum<["battery", "hardwired", "mechanical_harvesting", "wireless", "ethernet"]>, "many">;
             }, "strip", z.ZodTypeAny, {
                 display_name: string;
+                description: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -1098,7 +1099,6 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                description: string;
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
@@ -1130,6 +1130,7 @@ export declare const routes: {
                 product_url?: string | undefined;
             }, {
                 display_name: string;
+                description: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -1158,7 +1159,6 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                description: string;
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
@@ -1453,6 +1453,7 @@ export declare const routes: {
         }, "strip", z.ZodTypeAny, {
             device_models: ({
                 display_name: string;
+                description: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -1481,7 +1482,6 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                description: string;
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };
@@ -1576,6 +1576,7 @@ export declare const routes: {
         }, {
             device_models: ({
                 display_name: string;
+                description: string;
                 manufacturer: {
                     display_name: string;
                     manufacturer_id: string;
@@ -1604,7 +1605,6 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 };
-                description: string;
                 hardware: {
                     has_physical_key?: boolean | undefined;
                 };

package/package.json

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

package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts

@@ -43,22 +43,20 @@ export type AccessCodeConstraint = z.infer<typeof access_code_constraint>
 
 const time_frame_option_time_pair = z
   .object({
-    display_name: z
-      .string()
-      .describe('Label for the check-in/check-out time pairing.'),
-    check_in_time: z
+    display_name: z.string().describe('Label for the start/end time pairing.'),
+    start_time: z
       .string()
       .describe(
-        "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
+        "Start time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
       ),
-    check_out_time: z
+    end_time: z
       .string()
       .describe(
-        "Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date.",
+        "End time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. An `end_time` earlier on the clock than `start_time` means the end falls on a later date.",
       ),
   })
   .describe(
-    'Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
+    'Fixed start/end time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.',
   )
 
 export const time_frame_option = z
@@ -66,7 +64,7 @@ export const time_frame_option = z
     display_name: z
       .string()
       .describe(
-        'Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed check-in times`).',
+        'Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed start times`).',
       ),
     min_duration: z
       .string()
@@ -84,25 +82,25 @@ export const time_frame_option = z
       .literal(true)
       .optional()
       .describe(
-        'When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.',
+        'When `true`, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.',
       ),
     time_pairs: z
       .array(time_frame_option_time_pair)
       .optional()
       .describe(
-        'Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
+        'Fixed start/end time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.',
       ),
     start_date_recurrence_rule: z
       .string()
       .optional()
       .describe(
-        'iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.',
+        'iCalendar recurrence rule (RRULE) that the start date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.',
       ),
     end_date_recurrence_rule: z
       .string()
       .optional()
       .describe(
-        'iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.',
+        'iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.',
       ),
     time_zone: z
       .string()

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

@@ -797,6 +797,21 @@ export const device_metadata = z
       })
       .partial()
       .describe(`Metadata for a Korelock device.`),
+
+    kisi_metadata: z
+      .object({
+        lock_id: z.number().describe(`Lock ID for a Kisi device.`),
+        lock_name: z.string().describe(`Lock name for a Kisi device.`),
+        place_name: z
+          .string()
+          .nullable()
+          .describe(`Place name for a Kisi device.`),
+        description: z
+          .string()
+          .nullable()
+          .describe(`Description for a Kisi device.`),
+      })
+      .describe(`Metadata for a Kisi device.`),
   })
   .partial().describe(`
           ---

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

@@ -64,6 +64,7 @@ export const DEVICE_PROVIDERS = {
   GUESTY: 'guesty',
   ACUITY_SCHEDULING: 'acuity_scheduling',
   OMNITEC: 'omnitec',
+  KISI: 'kisi',
 } as const
 
 export type DeviceProviderName =
@@ -142,7 +143,7 @@ export const PROVIDER_CATEGORY_MAP = {
     'thirty_three_lock',
   ],
 
-  beta: [],
+  beta: ['kisi'],
 
   thermostats: ['ecobee', 'nest', 'sensi', 'honeywell_resideo', 'first_alert'],
   noise_sensors: ['minut', 'noiseaware'],

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

@@ -30,6 +30,7 @@ export const LOCK_DEVICE_TYPE = {
   ULTRALOQ_LOCK: 'ultraloq_lock',
   KEYINCODE_LOCK: 'keyincode_lock',
   OMNITEC_LOCK: 'omnitec_lock',
+  KISI_LOCK: 'kisi_lock',
 } as const
 
 type LockDeviceTypeFromMapping =