npm - @seamapi/types - Versions diffs - 1.130.0 → 1.132.0 - Mend

@seamapi/types 1.130.0 → 1.132.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

package/dist/connect.d.cts CHANGED Viewed

@@ -227,6 +227,9 @@ declare const _default: {
                         format: string;
                         type: string;
                     };
+                    can_automate_enrollment: {
+                        type: string;
+                    };
                     connected_account_ids: {
                         items: {
                             type: string;
@@ -786,6 +789,10 @@ declare const _default: {
                             type: string;
                         }[];
                     };
+                    display_name: {
+                        description: string;
+                        type: string;
+                    };
                     errors: {
                         description: string;
                         items: {
@@ -822,6 +829,10 @@ declare const _default: {
                         };
                         type: string;
                     };
+                    nickname: {
+                        description: string;
+                        type: string;
+                    };
                     properties: {
                         allOf: ({
                             allOf: ({
@@ -906,10 +917,6 @@ declare const _default: {
                                             description: string;
                                             type: string;
                                         };
-                                        nickname: {
-                                            description: string;
-                                            type: string;
-                                        };
                                         offline_access_codes_enabled: {
                                             description: string;
                                             type: string;
@@ -973,7 +980,6 @@ declare const _default: {
                                         manufacturer?: never;
                                         model?: never;
                                         name?: never;
-                                        nickname?: never;
                                         offline_access_codes_enabled?: never;
                                         online?: never;
                                         online_access_codes_enabled?: never;
@@ -2400,6 +2406,10 @@ declare const _default: {
                         enum: string[];
                         type: string;
                     };
+                    display_name: {
+                        description: string;
+                        type: string;
+                    };
                     errors: {
                         description: string;
                         items: {
@@ -2436,6 +2446,10 @@ declare const _default: {
                         };
                         type: string;
                     };
+                    nickname: {
+                        description: string;
+                        type: string;
+                    };
                     properties: {
                         properties: {
                             assa_abloy_credential_service_metadata: {
@@ -18151,6 +18165,7 @@ interface Routes {
                 connected_account_ids: string[];
                 image_url: string;
                 image_alt_text: string;
+                can_automate_enrollment?: boolean | undefined;
             };
         };
     };
@@ -18178,6 +18193,7 @@ interface Routes {
                 connected_account_ids: string[];
                 image_url: string;
                 image_alt_text: string;
+                can_automate_enrollment?: boolean | undefined;
             }>;
         };
     };
@@ -18890,16 +18906,18 @@ interface Routes {
                 device_id: string;
                 /** Type of the device. */
                 device_type: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 /** Properties of the device. */
                 properties: (({
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
-                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-                    nickname?: string | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
                         name: string;
@@ -19386,16 +19404,18 @@ interface Routes {
                 device_id: string;
                 /** Type of the device. */
                 device_type: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 /** Properties of the device. */
                 properties: (({
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
-                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-                    nickname?: string | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
                         name: string;
@@ -19910,7 +19930,7 @@ interface Routes {
                 created_at: string;
                 is_managed: false;
                 properties: {
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
                     /** Indicates whether the device is online. */
                     online: boolean;
@@ -19995,7 +20015,7 @@ interface Routes {
                 created_at: string;
                 is_managed: false;
                 properties: {
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
                     /** Indicates whether the device is online. */
                     online: boolean;
@@ -20205,16 +20225,18 @@ interface Routes {
                 device_id: string;
                 /** Type of the device. */
                 device_type: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 /** Properties of the device. */
                 properties: (({
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
-                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-                    nickname?: string | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
                         name: string;
@@ -20678,16 +20700,18 @@ interface Routes {
                 device_id: string;
                 /** Type of the device. */
                 device_type: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 /** Properties of the device. */
                 properties: (({
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
-                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-                    nickname?: string | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
                         name: string;
@@ -21174,16 +21198,18 @@ interface Routes {
                 device_id: string;
                 /** Type of the device. */
                 device_type: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 /** Properties of the device. */
                 properties: (({
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
-                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-                    nickname?: string | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
                         name: string;
@@ -21647,16 +21673,18 @@ interface Routes {
                 device_id: string;
                 /** Type of the device. */
                 device_type: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 /** Properties of the device. */
                 properties: (({
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
-                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-                    nickname?: string | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
                         name: string;
@@ -22426,6 +22454,10 @@ interface Routes {
                 /** Unique identifier for the device. */
                 device_id: string;
                 device_type: 'android_phone' | 'ios_phone';
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 properties: {
@@ -22495,6 +22527,10 @@ interface Routes {
                 /** Unique identifier for the device. */
                 device_id: string;
                 device_type: 'android_phone' | 'ios_phone';
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 properties: {
@@ -22749,16 +22785,18 @@ interface Routes {
                 device_id: string;
                 /** Type of the device. */
                 device_type: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 /** Properties of the device. */
                 properties: (({
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
-                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-                    nickname?: string | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
                         name: string;
@@ -23321,16 +23359,18 @@ interface Routes {
                 device_id: string;
                 /** Type of the device. */
                 device_type: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 /** Properties of the device. */
                 properties: (({
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
-                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-                    nickname?: string | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
                         name: string;
@@ -24078,16 +24118,18 @@ interface Routes {
                 device_id: string;
                 /** Type of the device. */
                 device_type: ('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' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
+                /** Optional nickname to describe the device, settable through Seam */
+                nickname?: string | undefined;
+                /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                display_name: string;
                 /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
                 capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
                 /** Properties of the device. */
                 properties: (({
                     /** Indicates whether the device is online. */
                     online: boolean;
-                    /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+                    /** Name of the device. Deprecated - use device.display_name instead */
                     name: string;
-                    /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
-                    nickname?: string | undefined;
                     appearance: {
                         /** Name of the device as seen from the provider API and application, not settable through Seam. */
                         name: string;
@@ -24572,6 +24614,7 @@ interface Routes {
                 connected_account_ids: string[];
                 image_url: string;
                 image_alt_text: string;
+                can_automate_enrollment?: boolean | undefined;
             }>;
         };
     };

package/lib/seam/connect/openapi.d.ts CHANGED Viewed

@@ -153,6 +153,9 @@ declare const _default: {
                         format: string;
                         type: string;
                     };
+                    can_automate_enrollment: {
+                        type: string;
+                    };
                     connected_account_ids: {
                         items: {
                             type: string;
@@ -712,6 +715,10 @@ declare const _default: {
                             type: string;
                         }[];
                     };
+                    display_name: {
+                        description: string;
+                        type: string;
+                    };
                     errors: {
                         description: string;
                         items: {
@@ -748,6 +755,10 @@ declare const _default: {
                         };
                         type: string;
                     };
+                    nickname: {
+                        description: string;
+                        type: string;
+                    };
                     properties: {
                         allOf: ({
                             allOf: ({
@@ -832,10 +843,6 @@ declare const _default: {
                                             description: string;
                                             type: string;
                                         };
-                                        nickname: {
-                                            description: string;
-                                            type: string;
-                                        };
                                         offline_access_codes_enabled: {
                                             description: string;
                                             type: string;
@@ -899,7 +906,6 @@ declare const _default: {
                                         manufacturer?: never;
                                         model?: never;
                                         name?: never;
-                                        nickname?: never;
                                         offline_access_codes_enabled?: never;
                                         online?: never;
                                         online_access_codes_enabled?: never;
@@ -2326,6 +2332,10 @@ declare const _default: {
                         enum: string[];
                         type: string;
                     };
+                    display_name: {
+                        description: string;
+                        type: string;
+                    };
                     errors: {
                         description: string;
                         items: {
@@ -2362,6 +2372,10 @@ declare const _default: {
                         };
                         type: string;
                     };
+                    nickname: {
+                        description: string;
+                        type: string;
+                    };
                     properties: {
                         properties: {
                             assa_abloy_credential_service_metadata: {

package/lib/seam/connect/openapi.js CHANGED Viewed

@@ -168,6 +168,7 @@ export default {
             acs_system: {
                 properties: {
                     acs_system_id: { format: 'uuid', type: 'string' },
+                    can_automate_enrollment: { type: 'boolean' },
                     connected_account_ids: { items: { type: 'string' }, type: 'array' },
                     created_at: { format: 'date-time', type: 'string' },
                     external_type: {
@@ -595,6 +596,10 @@ export default {
                             { enum: ['ios_phone', 'android_phone'], type: 'string' },
                         ],
                     },
+                    display_name: {
+                        description: 'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                        type: 'string',
+                    },
                     errors: {
                         description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
                         items: {
@@ -627,6 +632,10 @@ export default {
                         },
                         type: 'object',
                     },
+                    nickname: {
+                        description: 'Optional nickname to describe the device, settable through Seam',
+                        type: 'string',
+                    },
                     properties: {
                         allOf: [
                             {
@@ -710,11 +719,7 @@ export default {
                                                         type: 'object',
                                                     },
                                                     name: {
-                                                        description: 'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
-                                                        type: 'string',
-                                                    },
-                                                    nickname: {
-                                                        description: 'Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                                                        description: 'Name of the device. Deprecated - use device.display_name instead',
                                                         type: 'string',
                                                     },
                                                     offline_access_codes_enabled: {
@@ -1683,6 +1688,7 @@ export default {
                 required: [
                     'device_id',
                     'device_type',
+                    'display_name',
                     'capabilities_supported',
                     'properties',
                     'location',
@@ -1858,6 +1864,10 @@ export default {
                         type: 'string',
                     },
                     device_type: { enum: ['android_phone', 'ios_phone'], type: 'string' },
+                    display_name: {
+                        description: 'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                        type: 'string',
+                    },
                     errors: {
                         description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
                         items: {
@@ -1890,6 +1900,10 @@ export default {
                         },
                         type: 'object',
                     },
+                    nickname: {
+                        description: 'Optional nickname to describe the device, settable through Seam',
+                        type: 'string',
+                    },
                     properties: {
                         properties: {
                             assa_abloy_credential_service_metadata: {
@@ -1934,6 +1948,7 @@ export default {
                 required: [
                     'device_id',
                     'device_type',
+                    'display_name',
                     'capabilities_supported',
                     'properties',
                     'location',
@@ -2177,7 +2192,7 @@ export default {
                                 type: 'object',
                             },
                             name: {
-                                description: 'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                                description: 'Name of the device. Deprecated - use device.display_name instead',
                                 type: 'string',
                             },
                             offline_access_codes_enabled: {