@seamapi/types 1.865.0 → 1.867.0

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

@@ -23553,6 +23553,11 @@ export type Routes = {
         commonParams: {
             /** ID of the encoder to use for the scan. */
             acs_encoder_id: string;
+            /** Salto KS-specific metadata for the scan action. */
+            salto_ks_metadata?: {
+                /** When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false. */
+                detect_new_tags?: boolean;
+            } | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -25071,6 +25076,11 @@ export type Routes = {
             acs_user_id?: string | undefined;
             /** ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created. */
             user_identity_id?: string | undefined;
+            /** Salto KS-specific metadata for the scan action. */
+            salto_ks_metadata?: {
+                /** When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false. */
+                detect_new_tags?: boolean;
+            } | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -34332,7 +34342,7 @@ export type Routes = {
             /** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
             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?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'acuity_scheduling' | 'omnitec' | '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' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | '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' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | '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). */
@@ -37390,7 +37400,7 @@ export type Routes = {
             /** Array of device types for which you want to list devices. */
             device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'keyincode_lock' | 'omnitec_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera')[] | undefined;
             /** Manufacturer for which you want to list devices. */
-            manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'acuity_scheduling' | 'omnitec') | undefined;
+            manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec') | undefined;
             /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
             /** Numerical limit on the number of devices to return. */
@@ -38789,7 +38799,7 @@ export type Routes = {
         formData: {};
         jsonResponse: {
             device_providers: {
-                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' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'acuity_scheduling' | 'omnitec';
+                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' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec';
                 display_name: string;
                 image_url: string;
                 provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors')[];
@@ -39402,7 +39412,7 @@ export type Routes = {
             /** Array of device types for which you want to list devices. */
             device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'keyincode_lock' | 'omnitec_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera')[] | undefined;
             /** Manufacturer for which you want to list devices. */
-            manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'acuity_scheduling' | 'omnitec') | undefined;
+            manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec') | undefined;
             /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
             /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
@@ -68978,7 +68988,7 @@ export type Routes = {
         queryParams: {};
         jsonBody: {
             /** Type of connector to create */
-            connector_type: 'mock' | 'mews' | 'rms' | 'cloudbeds' | 'smoobu' | 'zonal' | 'ical' | 'lodgify' | 'hostaway' | 'acuity_scheduling';
+            connector_type: 'mock' | 'mews' | 'rms' | 'cloudbeds' | 'smoobu' | 'zonal' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling';
             /** Key identifying the customer */
             customer_key?: string | undefined;
             /** Instance-specific configuration for the connector */

package/package.json

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

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

@@ -57,6 +57,7 @@ export const DEVICE_PROVIDERS = {
   ICAL: 'ical',
   LODGIFY: 'lodgify',
   HOSTAWAY: 'hostaway',
+  GUESTY: 'guesty',
   ACUITY_SCHEDULING: 'acuity_scheduling',
   OMNITEC: 'omnitec',
 } as const
@@ -149,7 +150,7 @@ export const PROVIDER_CATEGORY_MAP = {
 
   cameras: ['ring'],
 
-  connectors: ['ical', 'lodgify', 'hostaway', 'acuity_scheduling'],
+  connectors: ['ical', 'lodgify', 'hostaway', 'guesty', 'acuity_scheduling'],
 
   internal_beta: ALL_DEVICE_PROVIDERS,
 } as const satisfies Record<string, readonly DeviceProviderName[]>

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

@@ -16489,6 +16489,7 @@ const openapi: OpenAPISpec = {
               'ical',
               'lodgify',
               'hostaway',
+              'guesty',
               'acuity_scheduling',
               'omnitec',
             ],
@@ -45754,6 +45755,19 @@ const openapi: OpenAPISpec = {
                     format: 'uuid',
                     type: 'string',
                   },
+                  salto_ks_metadata: {
+                    description:
+                      'Salto KS-specific metadata for the scan action.',
+                    properties: {
+                      detect_new_tags: {
+                        default: false,
+                        description:
+                          'When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.',
+                        type: 'boolean',
+                      },
+                    },
+                    type: 'object',
+                  },
                 },
                 required: ['acs_encoder_id'],
                 type: 'object',
@@ -45819,6 +45833,19 @@ const openapi: OpenAPISpec = {
                     format: 'uuid',
                     type: 'string',
                   },
+                  salto_ks_metadata: {
+                    description:
+                      'Salto KS-specific metadata for the scan action.',
+                    properties: {
+                      detect_new_tags: {
+                        default: false,
+                        description:
+                          'When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false.',
+                        type: 'boolean',
+                      },
+                    },
+                    type: 'object',
+                  },
                   user_identity_id: {
                     description:
                       'ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created.',
@@ -50560,6 +50587,7 @@ const openapi: OpenAPISpec = {
                         'ical',
                         'lodgify',
                         'hostaway',
+                        'guesty',
                         'acuity_scheduling',
                         'omnitec',
                         'yale_access',
@@ -54903,6 +54931,7 @@ const openapi: OpenAPISpec = {
                 'ical',
                 'lodgify',
                 'hostaway',
+                'guesty',
                 'acuity_scheduling',
                 'omnitec',
               ],
@@ -55424,6 +55453,7 @@ const openapi: OpenAPISpec = {
                       'ical',
                       'lodgify',
                       'hostaway',
+                      'guesty',
                       'acuity_scheduling',
                       'omnitec',
                     ],
@@ -57703,6 +57733,7 @@ const openapi: OpenAPISpec = {
                 'ical',
                 'lodgify',
                 'hostaway',
+                'guesty',
                 'acuity_scheduling',
                 'omnitec',
               ],
@@ -58223,6 +58254,7 @@ const openapi: OpenAPISpec = {
                       'ical',
                       'lodgify',
                       'hostaway',
+                      'guesty',
                       'acuity_scheduling',
                       'omnitec',
                     ],
@@ -66922,6 +66954,7 @@ const openapi: OpenAPISpec = {
                       'ical',
                       'lodgify',
                       'hostaway',
+                      'guesty',
                       'acuity_scheduling',
                     ],
                     type: 'string',

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

@@ -27330,6 +27330,13 @@ export type Routes = {
     commonParams: {
       /** ID of the encoder to use for the scan. */
       acs_encoder_id: string
+      /** Salto KS-specific metadata for the scan action. */
+      salto_ks_metadata?:
+        | {
+            /** When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false. */
+            detect_new_tags?: boolean
+          }
+        | undefined
     }
     formData: {}
     jsonResponse: {
@@ -29100,6 +29107,13 @@ export type Routes = {
       acs_user_id?: string | undefined
       /** ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created. */
       user_identity_id?: string | undefined
+      /** Salto KS-specific metadata for the scan action. */
+      salto_ks_metadata?:
+        | {
+            /** When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false. */
+            detect_new_tags?: boolean
+          }
+        | undefined
     }
     formData: {}
     jsonResponse: {
@@ -39922,6 +39936,7 @@ export type Routes = {
             | 'ical'
             | 'lodgify'
             | 'hostaway'
+            | 'guesty'
             | 'acuity_scheduling'
             | 'omnitec'
             | 'yale_access'
@@ -43679,6 +43694,7 @@ export type Routes = {
             | 'ical'
             | 'lodgify'
             | 'hostaway'
+            | 'guesty'
             | 'acuity_scheduling'
             | 'omnitec'
           )
@@ -45523,6 +45539,7 @@ export type Routes = {
           | 'ical'
           | 'lodgify'
           | 'hostaway'
+          | 'guesty'
           | 'acuity_scheduling'
           | 'omnitec'
         display_name: string
@@ -47678,6 +47695,7 @@ export type Routes = {
             | 'ical'
             | 'lodgify'
             | 'hostaway'
+            | 'guesty'
             | 'acuity_scheduling'
             | 'omnitec'
           )
@@ -82931,6 +82949,7 @@ export type Routes = {
         | 'ical'
         | 'lodgify'
         | 'hostaway'
+        | 'guesty'
         | 'acuity_scheduling'
       /** Key identifying the customer */
       customer_key?: string | undefined