@seamapi/types 1.531.0 → 1.532.0

package/lib/seam/connect/route-types.d.ts

@@ -11365,6 +11365,11 @@ export type Routes = {
                         /** Indicates whether the entrance is connected. */
                         is_connected: boolean;
                     } | undefined;
+                    /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    hotek_metadata?: {
+                        /** Room number of the entrance. */
+                        room_number: string;
+                    } | undefined;
                     /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     visionline_metadata?: {
                         /** Name of the door in the Visionline access system. */
@@ -14488,6 +14493,11 @@ export type Routes = {
                         /** Indicates whether the entrance is connected. */
                         is_connected: boolean;
                     } | undefined;
+                    /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    hotek_metadata?: {
+                        /** Room number of the entrance. */
+                        room_number: string;
+                    } | undefined;
                     /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     visionline_metadata?: {
                         /** Name of the door in the Visionline access system. */
@@ -20390,6 +20400,11 @@ export type Routes = {
                     /** Indicates whether the entrance is connected. */
                     is_connected: boolean;
                 } | undefined;
+                /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                hotek_metadata?: {
+                    /** Room number of the entrance. */
+                    room_number: string;
+                } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
                     /** Name of the door in the Visionline access system. */
@@ -21740,6 +21755,11 @@ export type Routes = {
                     /** Indicates whether the entrance is connected. */
                     is_connected: boolean;
                 } | undefined;
+                /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                hotek_metadata?: {
+                    /** Room number of the entrance. */
+                    room_number: string;
+                } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
                     /** Name of the door in the Visionline access system. */
@@ -25175,6 +25195,11 @@ export type Routes = {
                     /** Indicates whether the entrance is connected. */
                     is_connected: boolean;
                 } | undefined;
+                /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                hotek_metadata?: {
+                    /** Room number of the entrance. */
+                    room_number: string;
+                } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
                     /** Name of the door in the Visionline access system. */
@@ -25335,6 +25360,11 @@ export type Routes = {
                     /** Indicates whether the entrance is connected. */
                     is_connected: boolean;
                 } | undefined;
+                /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                hotek_metadata?: {
+                    /** Room number of the entrance. */
+                    room_number: string;
+                } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
                     /** Name of the door in the Visionline access system. */
@@ -26765,6 +26795,11 @@ export type Routes = {
                     /** Indicates whether the entrance is connected. */
                     is_connected: boolean;
                 } | undefined;
+                /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                hotek_metadata?: {
+                    /** Room number of the entrance. */
+                    room_number: string;
+                } | undefined;
                 /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                 visionline_metadata?: {
                     /** Name of the door in the Visionline access system. */
@@ -30266,7 +30301,7 @@ export type Routes = {
             /** Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key. */
             customer_key?: string | undefined;
             /** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters. */
-            accepted_providers?: ('dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
+            accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
             /** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter. */
             provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
             /** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). */
@@ -34028,7 +34063,7 @@ export type Routes = {
         formData: {};
         jsonResponse: {
             device_providers: {
-                device_provider_name: 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance';
+                device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance';
                 display_name: string;
                 image_url: string;
                 provider_categories: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems')[];
@@ -58052,6 +58087,11 @@ export type Routes = {
                                 /** Indicates whether the entrance is connected. */
                                 is_connected: boolean;
                             } | undefined;
+                            /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                            hotek_metadata?: {
+                                /** Room number of the entrance. */
+                                room_number: string;
+                            } | undefined;
                             /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                             visionline_metadata?: {
                                 /** Name of the door in the Visionline access system. */
@@ -59564,6 +59604,11 @@ export type Routes = {
                         /** Indicates whether the entrance is connected. */
                         is_connected: boolean;
                     } | undefined;
+                    /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    hotek_metadata?: {
+                        /** Room number of the entrance. */
+                        room_number: string;
+                    } | undefined;
                     /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     visionline_metadata?: {
                         /** Name of the door in the Visionline access system. */
@@ -80270,6 +80315,11 @@ export type Routes = {
                         /** Indicates whether the entrance is connected. */
                         is_connected: boolean;
                     } | undefined;
+                    /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+                    hotek_metadata?: {
+                        /** Room number of the entrance. */
+                        room_number: string;
+                    } | undefined;
                     /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
                     visionline_metadata?: {
                         /** Name of the door in the Visionline access system. */

package/package.json

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

package/src/lib/seam/connect/models/acs/acs-entrance.ts

@@ -4,6 +4,7 @@ import { acs_entrance_dormakaba_ambiance_metadata } from './metadata/dormakaba-a
 import {
   acs_entrance_assa_abloy_vostio_metadata,
   acs_entrance_dormakaba_community_metadata,
+  acs_entrance_hotek_metadata,
   acs_entrance_latch_metadata,
   acs_entrance_salto_ks_metadata,
   acs_entrance_visionline_metadata,
@@ -85,6 +86,11 @@ export const acs_entrance = z
       .describe(
         'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
       ),
+    hotek_metadata: acs_entrance_hotek_metadata
+      .optional()
+      .describe(
+        'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+      ),
     visionline_metadata: acs_entrance_visionline_metadata
       .optional()
       .describe(

package/src/lib/seam/connect/models/acs/metadata/hotek.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod'
+
+export const acs_entrance_hotek_metadata = z
+  .object({
+    room_number: z.string().describe('Room number of the entrance.'),
+  })
+  .describe('Hotek-specific metadata associated with the entrance.')
+
+export type AcsEntranceHotekMetadata = z.infer<
+  typeof acs_entrance_hotek_metadata
+>

package/src/lib/seam/connect/models/acs/metadata/index.ts

@@ -1,6 +1,7 @@
 export * from './assa-abloy-vostio.js'
 export * from './dormakaba-ambiance.js'
 export * from './dormakaba-community.js'
+export * from './hotek.js'
 export * from './latch.js'
 export * from './salto.js'
 export * from './visionline.js'

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

@@ -4,6 +4,7 @@ import type { ProviderCapability } from '../provider-capability.js'
 import { device_capability_flags } from './device.js'
 
 export const DEVICE_PROVIDERS = {
+  HOTEK: 'hotek',
   DORMAKABA_COMMUNITY: 'dormakaba_community',
   LEGIC_CONNECT: 'legic_connect',
   AKUVOX: 'akuvox',
@@ -122,6 +123,7 @@ export const PROVIDER_CATEGORY_MAP = {
     'dormakaba_ambiance',
     'dormakaba_community',
     'legic_connect',
+    'hotek',
   ],
 
   internal_beta: ALL_DEVICE_PROVIDERS,

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

@@ -2851,6 +2851,18 @@ export default {
             },
             type: 'array',
           },
+          hotek_metadata: {
+            description:
+              'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+            properties: {
+              room_number: {
+                description: 'Room number of the entrance.',
+                type: 'string',
+              },
+            },
+            required: ['room_number'],
+            type: 'object',
+          },
           latch_metadata: {
             description:
               'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -12932,6 +12944,7 @@ export default {
           can_unlock_with_code: { type: 'boolean' },
           device_provider_name: {
             enum: [
+              'hotek',
               'dormakaba_community',
               'legic_connect',
               'akuvox',
@@ -19572,6 +19585,18 @@ export default {
                               },
                               type: 'array',
                             },
+                            hotek_metadata: {
+                              description:
+                                'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
+                              properties: {
+                                room_number: {
+                                  description: 'Room number of the entrance.',
+                                  type: 'string',
+                                },
+                              },
+                              required: ['room_number'],
+                              type: 'object',
+                            },
                             latch_metadata: {
                               description:
                                 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -37226,6 +37251,7 @@ export default {
                       'Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.',
                     items: {
                       enum: [
+                        'hotek',
                         'dormakaba_community',
                         'legic_connect',
                         'akuvox',

package/src/lib/seam/connect/route-types.ts

@@ -12953,6 +12953,13 @@ export type Routes = {
                     is_connected: boolean
                   }
                 | undefined
+              /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              hotek_metadata?:
+                | {
+                    /** Room number of the entrance. */
+                    room_number: string
+                  }
+                | undefined
               /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
               visionline_metadata?:
                 | {
@@ -16711,6 +16718,13 @@ export type Routes = {
                     is_connected: boolean
                   }
                 | undefined
+              /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              hotek_metadata?:
+                | {
+                    /** Room number of the entrance. */
+                    room_number: string
+                  }
+                | undefined
               /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
               visionline_metadata?:
                 | {
@@ -23669,6 +23683,13 @@ export type Routes = {
               is_connected: boolean
             }
           | undefined
+        /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        hotek_metadata?:
+          | {
+              /** Room number of the entrance. */
+              room_number: string
+            }
+          | undefined
         /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
         visionline_metadata?:
           | {
@@ -25254,6 +25275,13 @@ export type Routes = {
               is_connected: boolean
             }
           | undefined
+        /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        hotek_metadata?:
+          | {
+              /** Room number of the entrance. */
+              room_number: string
+            }
+          | undefined
         /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
         visionline_metadata?:
           | {
@@ -29209,6 +29237,13 @@ export type Routes = {
               is_connected: boolean
             }
           | undefined
+        /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        hotek_metadata?:
+          | {
+              /** Room number of the entrance. */
+              room_number: string
+            }
+          | undefined
         /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
         visionline_metadata?:
           | {
@@ -29394,6 +29429,13 @@ export type Routes = {
               is_connected: boolean
             }
           | undefined
+        /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        hotek_metadata?:
+          | {
+              /** Room number of the entrance. */
+              room_number: string
+            }
+          | undefined
         /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
         visionline_metadata?:
           | {
@@ -31118,6 +31160,13 @@ export type Routes = {
               is_connected: boolean
             }
           | undefined
+        /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        hotek_metadata?:
+          | {
+              /** Room number of the entrance. */
+              room_number: string
+            }
+          | undefined
         /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
         visionline_metadata?:
           | {
@@ -35083,6 +35132,7 @@ export type Routes = {
       /** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters. */
       accepted_providers?:
         | (
+            | 'hotek'
             | 'dormakaba_community'
             | 'legic_connect'
             | 'akuvox'
@@ -39835,6 +39885,7 @@ export type Routes = {
     jsonResponse: {
       device_providers: {
         device_provider_name:
+          | 'hotek'
           | 'dormakaba_community'
           | 'legic_connect'
           | 'akuvox'
@@ -69065,6 +69116,13 @@ export type Routes = {
                     is_connected: boolean
                   }
                 | undefined
+              /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              hotek_metadata?:
+                | {
+                    /** Room number of the entrance. */
+                    room_number: string
+                  }
+                | undefined
               /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
               visionline_metadata?:
                 | {
@@ -70950,6 +71008,13 @@ export type Routes = {
                     is_connected: boolean
                   }
                 | undefined
+              /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              hotek_metadata?:
+                | {
+                    /** Room number of the entrance. */
+                    room_number: string
+                  }
+                | undefined
               /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
               visionline_metadata?:
                 | {
@@ -95472,6 +95537,13 @@ export type Routes = {
                     is_connected: boolean
                   }
                 | undefined
+              /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              hotek_metadata?:
+                | {
+                    /** Room number of the entrance. */
+                    room_number: string
+                  }
+                | undefined
               /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
               visionline_metadata?:
                 | {