@seamapi/types 1.714.0 → 1.716.0

package/package.json

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

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

@@ -708,6 +708,24 @@ export const device_metadata = z
           .describe(`IANA timezone for the Ultraloq device.`),
       })
       .describe(`Metadata for an Ultraloq device.`),
+
+    korelock_metadata: z
+      .object({
+        device_id: z.string().describe(`Device ID for a Korelock device.`),
+        device_name: z.string().describe(`Device name for a Korelock device.`),
+        model_code: z.string().describe(`Model code for a Korelock device.`),
+        serial_number: z
+          .string()
+          .describe(`Serial number for a Korelock device.`),
+        firmware_version: z
+          .string()
+          .describe(`Firmware version for a Korelock device.`),
+        wifi_signal_strength: z
+          .number()
+          .describe(`WiFi signal strength (0-1) for a Korelock device.`),
+      })
+      .partial()
+      .describe(`Metadata for a Korelock device.`),
   })
   .partial().describe(`
           ---

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

@@ -52,6 +52,7 @@ export const DEVICE_PROVIDERS = {
   SENSI: 'sensi',
   KWIKSET2: 'kwikset2',
   KEYNEST: 'keynest',
+  KORELOCK: 'korelock',
   DORMAKABA_AMBIANCE: 'dormakaba_ambiance',
   ULTRALOQ: 'ultraloq',
 } as const

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

@@ -30,6 +30,7 @@ export const LOCK_DEVICE_TYPE = {
   TEDEE_LOCK: 'tedee_lock',
   AKILES_LOCK: 'akiles_lock',
   ULTRALOQ_LOCK: 'ultraloq_lock',
+  KORELOCK_LOCK: 'korelock_lock',
 } as const
 
 type LockDeviceTypeFromMapping =

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

@@ -9770,6 +9770,7 @@ export default {
                   'tedee_lock',
                   'akiles_lock',
                   'ultraloq_lock',
+                  'korelock_lock',
                 ],
                 type: 'string',
               },
@@ -11244,6 +11245,39 @@ export default {
                         },
                         type: 'object',
                       },
+                      korelock_metadata: {
+                        description: 'Metadata for a Korelock device.',
+                        properties: {
+                          device_id: {
+                            description: 'Device ID for a Korelock device.',
+                            type: 'string',
+                          },
+                          device_name: {
+                            description: 'Device name for a Korelock device.',
+                            type: 'string',
+                          },
+                          firmware_version: {
+                            description:
+                              'Firmware version for a Korelock device.',
+                            type: 'string',
+                          },
+                          model_code: {
+                            description: 'Model code for a Korelock device.',
+                            type: 'string',
+                          },
+                          serial_number: {
+                            description: 'Serial number for a Korelock device.',
+                            type: 'string',
+                          },
+                          wifi_signal_strength: {
+                            description:
+                              'WiFi signal strength (0-1) for a Korelock device.',
+                            format: 'float',
+                            type: 'number',
+                          },
+                        },
+                        type: 'object',
+                      },
                       kwikset_metadata: {
                         description: 'Metadata for a Kwikset device.',
                         properties: {
@@ -13611,6 +13645,7 @@ export default {
               'sensi',
               'kwikset2',
               'keynest',
+              'korelock',
               'dormakaba_ambiance',
               'ultraloq',
             ],
@@ -25118,6 +25153,7 @@ export default {
                   'tedee_lock',
                   'akiles_lock',
                   'ultraloq_lock',
+                  'korelock_lock',
                 ],
                 type: 'string',
               },
@@ -27026,23 +27062,6 @@ export default {
                       'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
-                  is_offline_access_code: {
-                    description:
-                      'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
-                    type: 'boolean',
-                  },
-                  is_one_time_use: {
-                    description:
-                      'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
-                    type: 'boolean',
-                  },
-                  max_time_rounding: {
-                    default: '1hour',
-                    description:
-                      'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
-                    enum: ['1hour', '1day', '1h', '1d'],
-                    type: 'string',
-                  },
                   name: {
                     description:
                       "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n       Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n       To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n       To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
@@ -27055,7 +27074,7 @@ export default {
                   },
                   preferred_code_length: {
                     description:
-                      'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
+                      'Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.',
                     format: 'float',
                     type: 'number',
                   },
@@ -27064,16 +27083,6 @@ export default {
                       'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
                     type: 'string',
                   },
-                  use_backup_access_code_pool: {
-                    description:
-                      'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
-                    type: 'boolean',
-                  },
-                  use_offline_access_code: {
-                    deprecated: true,
-                    type: 'boolean',
-                    'x-deprecated': 'Use `is_offline_access_code` instead.',
-                  },
                 },
                 required: ['device_ids'],
                 type: 'object',
@@ -27166,23 +27175,6 @@ export default {
                       'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
-                  is_offline_access_code: {
-                    description:
-                      'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
-                    type: 'boolean',
-                  },
-                  is_one_time_use: {
-                    description:
-                      'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
-                    type: 'boolean',
-                  },
-                  max_time_rounding: {
-                    default: '1hour',
-                    description:
-                      'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
-                    enum: ['1hour', '1day', '1h', '1d'],
-                    type: 'string',
-                  },
                   name: {
                     description:
                       "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n       Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n       To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n       To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
@@ -27195,7 +27187,7 @@ export default {
                   },
                   preferred_code_length: {
                     description:
-                      'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
+                      'Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.',
                     format: 'float',
                     type: 'number',
                   },
@@ -27204,16 +27196,6 @@ export default {
                       'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
                     type: 'string',
                   },
-                  use_backup_access_code_pool: {
-                    description:
-                      'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).',
-                    type: 'boolean',
-                  },
-                  use_offline_access_code: {
-                    deprecated: true,
-                    type: 'boolean',
-                    'x-deprecated': 'Use `is_offline_access_code` instead.',
-                  },
                 },
                 required: ['device_ids'],
                 type: 'object',
@@ -40932,6 +40914,7 @@ export default {
                         'sensi',
                         'kwikset2',
                         'keynest',
+                        'korelock',
                         'dormakaba_ambiance',
                         'ultraloq',
                         'yale_access',
@@ -44837,6 +44820,7 @@ export default {
                     'tedee_lock',
                     'akiles_lock',
                     'ultraloq_lock',
+                    'korelock_lock',
                   ],
                   type: 'string',
                 },
@@ -44909,6 +44893,7 @@ export default {
                       'tedee_lock',
                       'akiles_lock',
                       'ultraloq_lock',
+                      'korelock_lock',
                     ],
                     type: 'string',
                   },
@@ -44982,14 +44967,15 @@ export default {
                 'akiles',
                 'ecobee',
                 'honeywell_resideo',
+                'keynest',
+                'korelock',
                 'kwikset2',
                 'minut',
                 'nest',
                 'noiseaware',
-                'tado',
                 'sensi',
                 'smartthings',
-                'keynest',
+                'tado',
                 'ultraloq',
               ],
               type: 'string',
@@ -45278,6 +45264,7 @@ export default {
                           'tedee_lock',
                           'akiles_lock',
                           'ultraloq_lock',
+                          'korelock_lock',
                         ],
                         type: 'string',
                       },
@@ -45348,6 +45335,7 @@ export default {
                             'tedee_lock',
                             'akiles_lock',
                             'ultraloq_lock',
+                            'korelock_lock',
                           ],
                           type: 'string',
                         },
@@ -45483,14 +45471,15 @@ export default {
                       'akiles',
                       'ecobee',
                       'honeywell_resideo',
+                      'keynest',
+                      'korelock',
                       'kwikset2',
                       'minut',
                       'nest',
                       'noiseaware',
-                      'tado',
                       'sensi',
                       'smartthings',
-                      'keynest',
+                      'tado',
                       'ultraloq',
                     ],
                     type: 'string',
@@ -46709,6 +46698,7 @@ export default {
                     'tedee_lock',
                     'akiles_lock',
                     'ultraloq_lock',
+                    'korelock_lock',
                   ],
                   type: 'string',
                 },
@@ -46781,6 +46771,7 @@ export default {
                       'tedee_lock',
                       'akiles_lock',
                       'ultraloq_lock',
+                      'korelock_lock',
                     ],
                     type: 'string',
                   },
@@ -46854,14 +46845,15 @@ export default {
                 'akiles',
                 'ecobee',
                 'honeywell_resideo',
+                'keynest',
+                'korelock',
                 'kwikset2',
                 'minut',
                 'nest',
                 'noiseaware',
-                'tado',
                 'sensi',
                 'smartthings',
-                'keynest',
+                'tado',
                 'ultraloq',
               ],
               type: 'string',
@@ -47149,6 +47141,7 @@ export default {
                           'tedee_lock',
                           'akiles_lock',
                           'ultraloq_lock',
+                          'korelock_lock',
                         ],
                         type: 'string',
                       },
@@ -47219,6 +47212,7 @@ export default {
                             'tedee_lock',
                             'akiles_lock',
                             'ultraloq_lock',
+                            'korelock_lock',
                           ],
                           type: 'string',
                         },
@@ -47354,14 +47348,15 @@ export default {
                       'akiles',
                       'ecobee',
                       'honeywell_resideo',
+                      'keynest',
+                      'korelock',
                       'kwikset2',
                       'minut',
                       'nest',
                       'noiseaware',
-                      'tado',
                       'sensi',
                       'smartthings',
-                      'keynest',
+                      'tado',
                       'ultraloq',
                     ],
                     type: 'string',
@@ -49348,6 +49343,7 @@ export default {
                 'tedee_lock',
                 'akiles_lock',
                 'ultraloq_lock',
+                'korelock_lock',
               ],
               type: 'string',
             },
@@ -49388,6 +49384,7 @@ export default {
                   'tedee_lock',
                   'akiles_lock',
                   'ultraloq_lock',
+                  'korelock_lock',
                 ],
                 type: 'string',
               },
@@ -49426,6 +49423,7 @@ export default {
                 'dormakaba_oracode',
                 'tedee',
                 'akiles',
+                'korelock',
                 'kwikset2',
                 'smartthings',
                 'ultraloq',
@@ -49715,6 +49713,7 @@ export default {
                       'tedee_lock',
                       'akiles_lock',
                       'ultraloq_lock',
+                      'korelock_lock',
                     ],
                     type: 'string',
                   },
@@ -49752,6 +49751,7 @@ export default {
                         'tedee_lock',
                         'akiles_lock',
                         'ultraloq_lock',
+                        'korelock_lock',
                       ],
                       type: 'string',
                     },
@@ -49850,6 +49850,7 @@ export default {
                       'dormakaba_oracode',
                       'tedee',
                       'akiles',
+                      'korelock',
                       'kwikset2',
                       'smartthings',
                       'ultraloq',
@@ -62700,9 +62701,9 @@ export default {
                 'ecobee',
                 'honeywell_resideo',
                 'nest',
-                'tado',
                 'sensi',
                 'smartthings',
+                'tado',
               ],
               type: 'string',
             },
@@ -63057,9 +63058,9 @@ export default {
                       'ecobee',
                       'honeywell_resideo',
                       'nest',
-                      'tado',
                       'sensi',
                       'smartthings',
+                      'tado',
                     ],
                     type: 'string',
                   },