@seamapi/types 1.130.0 → 1.131.0

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

@@ -1938,16 +1938,18 @@ export 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;
@@ -2434,16 +2436,18 @@ export 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;
@@ -2958,7 +2962,7 @@ export 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;
@@ -3043,7 +3047,7 @@ export 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;
@@ -3253,16 +3257,18 @@ export 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;
@@ -3726,16 +3732,18 @@ export 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;
@@ -4222,16 +4230,18 @@ export 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;
@@ -4695,16 +4705,18 @@ export 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;
@@ -5474,6 +5486,10 @@ export 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: {
@@ -5543,6 +5559,10 @@ export 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: {
@@ -5797,16 +5817,18 @@ export 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;
@@ -6369,16 +6391,18 @@ export 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;
@@ -7126,16 +7150,18 @@ export 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;

package/lib/seam/connect/unstable/models/devices/managed-device.d.ts

@@ -6,7 +6,6 @@ export type BatteryStatus = z.infer<typeof battery_status>;
 export declare const common_device_properties: z.ZodObject<{
     online: z.ZodBoolean;
     name: z.ZodString;
-    nickname: z.ZodOptional<z.ZodString>;
     appearance: z.ZodObject<{
         name: z.ZodString;
     }, "strip", z.ZodTypeAny, {
@@ -66,7 +65,6 @@ export declare const common_device_properties: z.ZodObject<{
         online_access_codes_supported?: boolean | undefined;
         accessory_keypad_supported?: boolean | undefined;
     };
-    nickname?: string | undefined;
     has_direct_power?: boolean | undefined;
     battery_level?: number | undefined;
     battery?: {
@@ -94,7 +92,6 @@ export declare const common_device_properties: z.ZodObject<{
         online_access_codes_supported?: boolean | undefined;
         accessory_keypad_supported?: boolean | undefined;
     };
-    nickname?: string | undefined;
     has_direct_power?: boolean | undefined;
     battery_level?: number | undefined;
     battery?: {
@@ -127,10 +124,10 @@ export declare const managed_device: z.ZodObject<{
     custom_metadata: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNull]>>, Record<string, string | boolean | null>, Record<string, string | boolean | null>>>;
     device_id: z.ZodString;
     is_managed: z.ZodLiteral<true>;
+    display_name: z.ZodString;
     properties: z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
         online: z.ZodBoolean;
         name: z.ZodString;
-        nickname: z.ZodOptional<z.ZodString>;
         appearance: z.ZodObject<{
             name: z.ZodString;
         }, "strip", z.ZodTypeAny, {
@@ -190,7 +187,6 @@ export declare const managed_device: z.ZodObject<{
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
         };
-        nickname?: string | undefined;
         has_direct_power?: boolean | undefined;
         battery_level?: number | undefined;
         battery?: {
@@ -218,7 +214,6 @@ export declare const managed_device: z.ZodObject<{
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
         };
-        nickname?: string | undefined;
         has_direct_power?: boolean | undefined;
         battery_level?: number | undefined;
         battery?: {
@@ -2054,6 +2049,7 @@ export declare const managed_device: z.ZodObject<{
         message: string;
         warning_code: string;
     }>, "many">;
+    nickname: z.ZodOptional<z.ZodString>;
     can_remotely_unlock: z.ZodOptional<z.ZodBoolean>;
     can_remotely_lock: z.ZodOptional<z.ZodBoolean>;
     can_program_online_access_codes: z.ZodOptional<z.ZodBoolean>;
@@ -2067,6 +2063,7 @@ export declare const managed_device: z.ZodObject<{
     created_at: string;
     device_id: string;
     is_managed: true;
+    display_name: string;
     properties: ({
         name: string;
         appearance: {
@@ -2080,7 +2077,6 @@ export declare const managed_device: z.ZodObject<{
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
         };
-        nickname?: string | undefined;
         has_direct_power?: boolean | undefined;
         battery_level?: number | undefined;
         battery?: {
@@ -2492,7 +2488,6 @@ export declare const managed_device: z.ZodObject<{
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
         };
-        nickname?: string | undefined;
         has_direct_power?: boolean | undefined;
         battery_level?: number | undefined;
         battery?: {
@@ -2903,6 +2898,7 @@ export declare const managed_device: z.ZodObject<{
         warning_code: string;
     }[];
     custom_metadata?: Record<string, string | boolean | null> | undefined;
+    nickname?: string | undefined;
     can_remotely_unlock?: boolean | undefined;
     can_remotely_lock?: boolean | undefined;
     can_program_online_access_codes?: boolean | undefined;
@@ -2916,6 +2912,7 @@ export declare const managed_device: z.ZodObject<{
     created_at: string;
     device_id: string;
     is_managed: true;
+    display_name: string;
     properties: ({
         name: string;
         appearance: {
@@ -2929,7 +2926,6 @@ export declare const managed_device: z.ZodObject<{
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
         };
-        nickname?: string | undefined;
         has_direct_power?: boolean | undefined;
         battery_level?: number | undefined;
         battery?: {
@@ -3341,7 +3337,6 @@ export declare const managed_device: z.ZodObject<{
             online_access_codes_supported?: boolean | undefined;
             accessory_keypad_supported?: boolean | undefined;
         };
-        nickname?: string | undefined;
         has_direct_power?: boolean | undefined;
         battery_level?: number | undefined;
         battery?: {
@@ -3752,6 +3747,7 @@ export declare const managed_device: z.ZodObject<{
         warning_code: string;
     }[];
     custom_metadata?: Record<string, string | boolean | null> | undefined;
+    nickname?: string | undefined;
     can_remotely_unlock?: boolean | undefined;
     can_remotely_lock?: boolean | undefined;
     can_program_online_access_codes?: boolean | undefined;

package/lib/seam/connect/unstable/models/devices/managed-device.js

@@ -11,11 +11,7 @@ export const common_device_properties = z.object({
     online: z.boolean().describe('Indicates whether the device is online.'),
     name: z
         .string()
-        .describe('Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.'),
-    nickname: z
-        .string()
-        .optional()
-        .describe('Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices.'),
+        .describe('Name of the device. Deprecated - use device.display_name instead'),
     appearance: z.object({
         name: z
             .string()
@@ -86,6 +82,13 @@ export const managed_device = z
     .object({
     device_id: z.string().uuid().describe('Unique identifier for the device.'),
     device_type: any_device_type.describe('Type of the device.'),
+    nickname: z
+        .string()
+        .optional()
+        .describe('Optional nickname to describe the device, settable through Seam'),
+    display_name: z
+        .string()
+        .describe('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.'),
     capabilities_supported: z
         .array(capabilities)
         .describe('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.'),

package/lib/seam/connect/unstable/models/devices/managed-device.js.map

@@ -1 +1 @@
-{"version":3,"file":"managed-device.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/unstable/models/devices/managed-device.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAErE,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAA;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;AAIzE,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;IACvE,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,CACP,iIAAiI,CAClI;IACH,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,8KAA8K,CAC/K;IACH,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,QAAQ,CACP,8FAA8F,CAC/F;KACJ,CAAC;IACF,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;QACd,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;QACtE,yBAAyB,EAAE,CAAC;aACzB,MAAM,EAAE;aACR,QAAQ,CACP,wFAAwF,CACzF;QAEH,8BAA8B,EAAE,CAAC;aAC9B,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,QAAQ,CAAC,6DAA6D,CAAC;QAC1E,6BAA6B,EAAE,CAAC;aAC7B,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,QAAQ,CAAC,4DAA4D,CAAC;QACzE,0BAA0B,EAAE,CAAC;aAC1B,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,QAAQ,CAAC,4DAA4D,CAAC;KAC1E,CAAC;IACF,gBAAgB,EAAE,CAAC;SAChB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,gDAAgD,CAAC;IAC7D,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CACP,0FAA0F,CAC3F;IACH,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,MAAM,EAAE,cAAc;KACvB,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CACP,0fAA0f,CAC3f;IACH,iBAAiB;IACjB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IAC3E,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IAC5E,cAAc,EAAE,CAAC;SACd,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,gCAAgC,CAAC;IAC7C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAE7E,2BAA2B,EAAE,CAAC;SAC3B,OAAO,EAAE;SACT,QAAQ,CACP,uFAAuF,CACxF;SACA,QAAQ,EAAE;IACb,4BAA4B,EAAE,CAAC;SAC5B,OAAO,EAAE;SACT,QAAQ,CACP,wFAAwF,CACzF;SACA,QAAQ,EAAE;IAEb,6CAA6C;IAC7C,yBAAyB,EAAE,CAAC;SACzB,OAAO,EAAE;SACT,QAAQ,CAAC,mDAAmD,CAAC;SAC7D,QAAQ,EAAE;IACb,6BAA6B,EAAE,CAAC;SAC7B,OAAO,EAAE;SACT,QAAQ,CAAC,+CAA+C,CAAC;SACzD,QAAQ,EAAE;CACd,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,CAAC;IACN,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;IAC1E,WAAW,EAAE,eAAe,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IAC5D,sBAAsB,EAAE,CAAC;SACtB,KAAK,CAAC,YAAY,CAAC;SACnB,QAAQ,CACP,onBAAonB,CACrnB;IACH,UAAU,EAAE,wBAAwB;SACjC,GAAG,CAAC,yBAAyB,CAAC,OAAO,EAAE,CAAC;SACxC,GAAG,CAAC,eAAe,CAAC;SACpB,GAAG,CAAC,qBAAqB,CAAC;SAC1B,QAAQ,CAAC,2BAA2B,CAAC;IACxC,QAAQ,EAAE,CAAC;QACT,qCAAqC;SACpC,MAAM,CAAC;QACN,aAAa,EAAE,CAAC;aACb,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,8BAA8B,CAAC;QAC3C,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,mCAAmC,CAAC;KACjD,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,sCAAsC,CAAC;IACnD,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,+DAA+D,CAChE;IACH,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,sEAAsE,CACvE;IACH,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,QAAQ,CACP,mYAAmY,CACpY;IACH,QAAQ,EAAE,CAAC;SACR,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;QACxB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,QAAQ,CACP,+YAA+Y,CAChZ;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IACpE,UAAU,EAAE,CAAC;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC,4CAA4C,CAAC;IACzD,eAAe,EAAE,eAAe,CAAC,QAAQ,EAAE;CAC5C,CAAC;KACD,KAAK,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAA"}
+{"version":3,"file":"managed-device.js","sourceRoot":"","sources":["../../../../../../src/lib/seam/connect/unstable/models/devices/managed-device.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAErE,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAA;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;AAIzE,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;IACvE,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,CACP,kEAAkE,CACnE;IACH,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;QACnB,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,QAAQ,CACP,8FAA8F,CAC/F;KACJ,CAAC;IACF,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;QACd,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;QACtE,yBAAyB,EAAE,CAAC;aACzB,MAAM,EAAE;aACR,QAAQ,CACP,wFAAwF,CACzF;QAEH,8BAA8B,EAAE,CAAC;aAC9B,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,QAAQ,CAAC,6DAA6D,CAAC;QAC1E,6BAA6B,EAAE,CAAC;aAC7B,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,QAAQ,CAAC,4DAA4D,CAAC;QACzE,0BAA0B,EAAE,CAAC;aAC1B,OAAO,EAAE;aACT,QAAQ,EAAE;aACV,QAAQ,CAAC,4DAA4D,CAAC;KAC1E,CAAC;IACF,gBAAgB,EAAE,CAAC;SAChB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,gDAAgD,CAAC;IAC7D,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CACP,0FAA0F,CAC3F;IACH,OAAO,EAAE,CAAC;SACP,MAAM,CAAC;QACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,MAAM,EAAE,cAAc;KACvB,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CACP,0fAA0f,CAC3f;IACH,iBAAiB;IACjB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IAC3E,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IAC5E,cAAc,EAAE,CAAC;SACd,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,gCAAgC,CAAC;IAC7C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAE7E,2BAA2B,EAAE,CAAC;SAC3B,OAAO,EAAE;SACT,QAAQ,CACP,uFAAuF,CACxF;SACA,QAAQ,EAAE;IACb,4BAA4B,EAAE,CAAC;SAC5B,OAAO,EAAE;SACT,QAAQ,CACP,wFAAwF,CACzF;SACA,QAAQ,EAAE;IAEb,6CAA6C;IAC7C,yBAAyB,EAAE,CAAC;SACzB,OAAO,EAAE;SACT,QAAQ,CAAC,mDAAmD,CAAC;SAC7D,QAAQ,EAAE;IACb,6BAA6B,EAAE,CAAC;SAC7B,OAAO,EAAE;SACT,QAAQ,CAAC,+CAA+C,CAAC;SACzD,QAAQ,EAAE;CACd,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,CAAC;IACN,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;IAC1E,WAAW,EAAE,eAAe,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IAC5D,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,iEAAiE,CAClE;IACH,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,CACP,sNAAsN,CACvN;IACH,sBAAsB,EAAE,CAAC;SACtB,KAAK,CAAC,YAAY,CAAC;SACnB,QAAQ,CACP,onBAAonB,CACrnB;IACH,UAAU,EAAE,wBAAwB;SACjC,GAAG,CAAC,yBAAyB,CAAC,OAAO,EAAE,CAAC;SACxC,GAAG,CAAC,eAAe,CAAC;SACpB,GAAG,CAAC,qBAAqB,CAAC;SAC1B,QAAQ,CAAC,2BAA2B,CAAC;IACxC,QAAQ,EAAE,CAAC;QACT,qCAAqC;SACpC,MAAM,CAAC;QACN,aAAa,EAAE,CAAC;aACb,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,8BAA8B,CAAC;QAC3C,QAAQ,EAAE,CAAC;aACR,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,mCAAmC,CAAC;KACjD,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,sCAAsC,CAAC;IACnD,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,+DAA+D,CAChE;IACH,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,sEAAsE,CACvE;IACH,MAAM,EAAE,CAAC;SACN,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;QACtB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,QAAQ,CACP,mYAAmY,CACpY;IACH,QAAQ,EAAE,CAAC;SACR,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;QACxB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;KACpB,CAAC,CACH;SACA,QAAQ,CACP,+YAA+Y,CAChZ;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IACpE,UAAU,EAAE,CAAC;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC,4CAA4C,CAAC;IACzD,eAAe,EAAE,eAAe,CAAC,QAAQ,EAAE;CAC5C,CAAC;KACD,KAAK,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAA"}

package/lib/seam/connect/unstable/models/devices/phone.d.ts

@@ -16,6 +16,7 @@ export declare const phone: z.ZodObject<{
     custom_metadata: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean, z.ZodNull]>>, Record<string, string | boolean | null>, Record<string, string | boolean | null>>>;
     device_id: z.ZodString;
     is_managed: z.ZodLiteral<true>;
+    display_name: z.ZodString;
     device_type: z.ZodEnum<["android_phone", "ios_phone"]>;
     capabilities_supported: z.ZodArray<z.ZodEnum<["access_code", "lock", "noise_detection", "thermostat", "battery", "phone"]>, "many">;
     errors: z.ZodArray<z.ZodObject<{
@@ -41,6 +42,7 @@ export declare const phone: z.ZodObject<{
     can_remotely_unlock: z.ZodOptional<z.ZodBoolean>;
     can_remotely_lock: z.ZodOptional<z.ZodBoolean>;
     can_program_online_access_codes: z.ZodOptional<z.ZodBoolean>;
+    nickname: z.ZodOptional<z.ZodString>;
     properties: z.ZodObject<{
         assa_abloy_credential_service_metadata: z.ZodOptional<z.ZodObject<{
             has_active_endpoint: z.ZodBoolean;
@@ -93,6 +95,7 @@ export declare const phone: z.ZodObject<{
     created_at: string;
     device_id: string;
     is_managed: true;
+    display_name: string;
     properties: {
         assa_abloy_credential_service_metadata?: {
             has_active_endpoint: boolean;
@@ -116,6 +119,7 @@ export declare const phone: z.ZodObject<{
     can_remotely_unlock?: boolean | undefined;
     can_remotely_lock?: boolean | undefined;
     can_program_online_access_codes?: boolean | undefined;
+    nickname?: string | undefined;
 }, {
     location: {
         location_name?: string | undefined;
@@ -125,6 +129,7 @@ export declare const phone: z.ZodObject<{
     created_at: string;
     device_id: string;
     is_managed: true;
+    display_name: string;
     properties: {
         assa_abloy_credential_service_metadata?: {
             has_active_endpoint: boolean;
@@ -148,4 +153,5 @@ export declare const phone: z.ZodObject<{
     can_remotely_unlock?: boolean | undefined;
     can_remotely_lock?: boolean | undefined;
     can_program_online_access_codes?: boolean | undefined;
+    nickname?: string | undefined;
 }>;

package/lib/seam/connect/unstable/models/devices/unmanaged-device.d.ts

@@ -8,7 +8,6 @@ export declare const unmanaged_device: z.ZodObject<{
     properties: z.ZodObject<Pick<{
         online: z.ZodBoolean;
         name: z.ZodString;
-        nickname: z.ZodOptional<z.ZodString>;
         appearance: z.ZodObject<{
             name: z.ZodString;
         }, "strip", z.ZodTypeAny, {

package/package.json

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

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

@@ -616,6 +616,11 @@ 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.',
@@ -649,6 +654,11 @@ export default {
             },
             type: 'object',
           },
+          nickname: {
+            description:
+              'Optional nickname to describe the device, settable through Seam',
+            type: 'string',
+          },
           properties: {
             allOf: [
               {
@@ -742,12 +752,7 @@ export default {
                           },
                           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.',
+                              'Name of the device. Deprecated - use device.display_name instead',
                             type: 'string',
                           },
                           offline_access_codes_enabled: {
@@ -1726,6 +1731,7 @@ export default {
         required: [
           'device_id',
           'device_type',
+          'display_name',
           'capabilities_supported',
           'properties',
           'location',
@@ -1903,6 +1909,11 @@ 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.',
@@ -1936,6 +1947,11 @@ export default {
             },
             type: 'object',
           },
+          nickname: {
+            description:
+              'Optional nickname to describe the device, settable through Seam',
+            type: 'string',
+          },
           properties: {
             properties: {
               assa_abloy_credential_service_metadata: {
@@ -1982,6 +1998,7 @@ export default {
         required: [
           'device_id',
           'device_type',
+          'display_name',
           'capabilities_supported',
           'properties',
           'location',
@@ -2244,7 +2261,7 @@ export default {
               },
               name: {
                 description:
-                  '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',
                 type: 'string',
               },
               offline_access_codes_enabled: {