@seamapi/types 1.550.0 → 1.552.0

package/package.json

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

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

@@ -618,7 +618,69 @@ export const device_metadata = z
 
     keynest_metadata: z
       .object({
+        key_id: z.string().describe(`Key ID for a KeyNest device.`),
         device_name: z.string().describe(`Device name for a KeyNest device.`),
+        property_id: z
+          .string()
+          .nullable()
+          .describe(`Property ID for a KeyNest device.`),
+        property_postcode: z
+          .string()
+          .nullable()
+          .describe(`Property postcode for a KeyNest device.`),
+        key_notes: z
+          .string()
+          .nullable()
+          .describe(`Key notes for a KeyNest device.`),
+        subscription_plan: z
+          .string()
+          .describe(`Subscription plan for a KeyNest device.`),
+        status_type: z.string().describe(`Status type for a KeyNest device.`),
+        current_or_last_store_id: z
+          .number()
+          .describe(`Current or last store ID for a KeyNest device.`),
+        last_movement: z
+          .string()
+          .describe(`Last movement timestamp for a KeyNest device.`),
+        address: z
+          .string()
+          .nullable()
+          .describe(`Address for a KeyNest device.`),
+        current_status: z
+          .string()
+          .nullable()
+          .describe(`Current status for a KeyNest device.`),
+        current_user_name: z
+          .string()
+          .nullable()
+          .describe(`Current user name for a KeyNest device.`),
+        current_user_email: z
+          .string()
+          .nullable()
+          .describe(`Current user email for a KeyNest device.`),
+        current_user_phone_number: z
+          .string()
+          .nullable()
+          .describe(`Current user phone number for a KeyNest device.`),
+        current_user_company: z
+          .string()
+          .nullable()
+          .describe(`Current user company for a KeyNest device.`),
+        handover_method: z
+          .string()
+          .nullable()
+          .describe(`Handover method for a KeyNest device.`),
+        keynest_app_user: z
+          .string()
+          .nullable()
+          .describe(`KeyNest app user for a KeyNest device.`),
+        default_office_id: z
+          .number()
+          .describe(`Default office ID for a KeyNest device.`),
+        fob_id: z.number().describe(`Fob ID for a KeyNest device.`),
+        has_photo: z
+          .boolean()
+          .describe(`Whether the KeyNest device has a photo.`),
       })
       .partial()
       .describe(`Metadata for a KeyNest device.`),

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

@@ -45,6 +45,23 @@ export const lock_device_type = z.enum(
 
 export type LockDeviceType = z.infer<typeof lock_device_type>
 
+/** Keys */
+export const KEY_DEVICE_TYPE = {
+  KEYNEST_KEY: 'keynest_key',
+} as const
+
+type KeyDeviceTypeFromMapping =
+  (typeof KEY_DEVICE_TYPE)[keyof typeof KEY_DEVICE_TYPE]
+
+export const KEY_DEVICE_TYPE_LIST = Object.values(KEY_DEVICE_TYPE)
+
+export const key_device_type = z.enum(
+  Object.values(KEY_DEVICE_TYPE) as [KeyDeviceTypeFromMapping],
+).describe(`Device type for keys.
+          `)
+
+export type KeyDeviceType = z.infer<typeof key_device_type>
+
 /** Noise Sensors */
 export const NOISE_SENSOR_DEVICE_TYPE = {
   NOISEAWARE_ACTIVITY_ZONE: 'noiseaware_activity_zone',
@@ -111,6 +128,7 @@ export type PhoneDeviceType = z.infer<typeof phone_device_type>
 
 export const any_device_type = z.union([
   lock_device_type,
+  key_device_type,
   noise_sensor_device_type,
   thermostat_device_type,
   phone_device_type,

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

@@ -26,6 +26,12 @@ export const access_method_issued_event = access_method_event.extend({
     .describe(
       "The actual PIN code for code access methods (only present when mode is 'code').",
     ),
+  is_backup_code: z
+    .boolean()
+    .optional()
+    .describe(
+      "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used).",
+    ),
 }).describe(`
     ---
     route_path: /access_methods
@@ -75,6 +81,12 @@ export const access_method_reissued_event = access_method_event.extend({
     .describe(
       "The actual PIN code for code access methods (only present when mode is 'code').",
     ),
+  is_backup_code: z
+    .boolean()
+    .optional()
+    .describe(
+      "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used).",
+    ),
 }).describe(`
     ---
     route_path: /access_methods

package/src/lib/seam/connect/openapi.ts

@@ -9386,6 +9386,11 @@ export default {
                 ],
                 type: 'string',
               },
+              {
+                description: 'Device type for keys.\n          ',
+                enum: ['keynest_key'],
+                type: 'string',
+              },
               {
                 description: 'Device type for noise sensors.\n          ',
                 enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -10773,10 +10778,112 @@ export default {
                       keynest_metadata: {
                         description: 'Metadata for a KeyNest device.',
                         properties: {
+                          address: {
+                            description: 'Address for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          current_or_last_store_id: {
+                            description:
+                              'Current or last store ID for a KeyNest device.',
+                            format: 'float',
+                            type: 'number',
+                          },
+                          current_status: {
+                            description: 'Current status for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          current_user_company: {
+                            description:
+                              'Current user company for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          current_user_email: {
+                            description:
+                              'Current user email for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          current_user_name: {
+                            description:
+                              'Current user name for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          current_user_phone_number: {
+                            description:
+                              'Current user phone number for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          default_office_id: {
+                            description:
+                              'Default office ID for a KeyNest device.',
+                            format: 'float',
+                            type: 'number',
+                          },
                           device_name: {
                             description: 'Device name for a KeyNest device.',
                             type: 'string',
                           },
+                          fob_id: {
+                            description: 'Fob ID for a KeyNest device.',
+                            format: 'float',
+                            type: 'number',
+                          },
+                          handover_method: {
+                            description:
+                              'Handover method for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          has_photo: {
+                            description:
+                              'Whether the KeyNest device has a photo.',
+                            type: 'boolean',
+                          },
+                          key_id: {
+                            description: 'Key ID for a KeyNest device.',
+                            type: 'string',
+                          },
+                          key_notes: {
+                            description: 'Key notes for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          keynest_app_user: {
+                            description:
+                              'KeyNest app user for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          last_movement: {
+                            description:
+                              'Last movement timestamp for a KeyNest device.',
+                            type: 'string',
+                          },
+                          property_id: {
+                            description: 'Property ID for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          property_postcode: {
+                            description:
+                              'Property postcode for a KeyNest device.',
+                            nullable: true,
+                            type: 'string',
+                          },
+                          status_type: {
+                            description: 'Status type for a KeyNest device.',
+                            type: 'string',
+                          },
+                          subscription_plan: {
+                            description:
+                              'Subscription plan for a KeyNest device.',
+                            type: 'string',
+                          },
                         },
                         type: 'object',
                       },
@@ -14665,6 +14772,11 @@ export default {
                 type: 'string',
               },
               event_type: { enum: ['access_method.issued'], type: 'string' },
+              is_backup_code: {
+                description:
+                  "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used).",
+                type: 'boolean',
+              },
               occurred_at: {
                 description: 'Date and time at which the event occurred.',
                 format: 'date-time',
@@ -14895,6 +15007,11 @@ export default {
                 type: 'string',
               },
               event_type: { enum: ['access_method.reissued'], type: 'string' },
+              is_backup_code: {
+                description:
+                  "Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used).",
+                type: 'boolean',
+              },
               occurred_at: {
                 description: 'Date and time at which the event occurred.',
                 format: 'date-time',
@@ -23837,6 +23954,11 @@ export default {
                 ],
                 type: 'string',
               },
+              {
+                description: 'Device type for keys.\n          ',
+                enum: ['keynest_key'],
+                type: 'string',
+              },
               {
                 description: 'Device type for noise sensors.\n          ',
                 enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -40657,6 +40779,11 @@ export default {
                   ],
                   type: 'string',
                 },
+                {
+                  description: 'Device type for keys.\n          ',
+                  enum: ['keynest_key'],
+                  type: 'string',
+                },
                 {
                   description: 'Device type for noise sensors.\n          ',
                   enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -40723,6 +40850,11 @@ export default {
                     ],
                     type: 'string',
                   },
+                  {
+                    description: 'Device type for keys.\n          ',
+                    enum: ['keynest_key'],
+                    type: 'string',
+                  },
                   {
                     description: 'Device type for noise sensors.\n          ',
                     enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -41079,6 +41211,11 @@ export default {
                         ],
                         type: 'string',
                       },
+                      {
+                        description: 'Device type for keys.\n          ',
+                        enum: ['keynest_key'],
+                        type: 'string',
+                      },
                       {
                         description:
                           'Device type for noise sensors.\n          ',
@@ -41143,6 +41280,11 @@ export default {
                           ],
                           type: 'string',
                         },
+                        {
+                          description: 'Device type for keys.\n          ',
+                          enum: ['keynest_key'],
+                          type: 'string',
+                        },
                         {
                           description:
                             'Device type for noise sensors.\n          ',
@@ -41986,6 +42128,11 @@ export default {
                   ],
                   type: 'string',
                 },
+                {
+                  description: 'Device type for keys.\n          ',
+                  enum: ['keynest_key'],
+                  type: 'string',
+                },
                 {
                   description: 'Device type for noise sensors.\n          ',
                   enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -42052,6 +42199,11 @@ export default {
                     ],
                     type: 'string',
                   },
+                  {
+                    description: 'Device type for keys.\n          ',
+                    enum: ['keynest_key'],
+                    type: 'string',
+                  },
                   {
                     description: 'Device type for noise sensors.\n          ',
                     enum: ['noiseaware_activity_zone', 'minut_sensor'],
@@ -42405,6 +42557,11 @@ export default {
                         ],
                         type: 'string',
                       },
+                      {
+                        description: 'Device type for keys.\n          ',
+                        enum: ['keynest_key'],
+                        type: 'string',
+                      },
                       {
                         description:
                           'Device type for noise sensors.\n          ',
@@ -42469,6 +42626,11 @@ export default {
                           ],
                           type: 'string',
                         },
+                        {
+                          description: 'Device type for keys.\n          ',
+                          enum: ['keynest_key'],
+                          type: 'string',
+                        },
                         {
                           description:
                             'Device type for noise sensors.\n          ',