Type Alias UnmanagedDevice

Represents an unmanaged device. An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any access codes on an unmanaged device are unmanaged. To control an unmanaged device with Seam, convert it to a managed device.

type UnmanagedDevice = {
    can_configure_auto_lock?: boolean;
    can_hvac_cool?: boolean;
    can_hvac_heat?: boolean;
    can_hvac_heat_cool?: boolean;
    can_program_offline_access_codes?: boolean;
    can_program_online_access_codes?: boolean;
    can_program_thermostat_programs_as_different_each_day?: boolean;
    can_program_thermostat_programs_as_same_each_day?: boolean;
    can_program_thermostat_programs_as_weekday_weekend?: boolean;
    can_remotely_lock?: boolean;
    can_remotely_unlock?: boolean;
    can_run_thermostat_programs?: boolean;
    can_simulate_connection?: boolean;
    can_simulate_disconnection?: boolean;
    can_simulate_hub_connection?: boolean;
    can_simulate_hub_disconnection?: boolean;
    can_simulate_paid_subscription?: boolean;
    can_simulate_removal?: boolean;
    can_turn_off_hvac?: boolean;
    can_unlock_with_code?: boolean;
    capabilities_supported: (
        | "access_code"
        | "lock"
        | "noise_detection"
        | "thermostat"
        | "battery"
        | "phone"
    )[];
    connected_account_id: string;
    created_at: string;
    custom_metadata: Record<string, unknown>;
    device_id: string;
    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"
        | "smartthings_lock"
        | "wyze_lock"
        | "yale_lock"
        | "two_n_intercom"
        | "controlbyweb_device"
        | "ttlock_lock"
        | "igloohome_lock"
        | "four_suites_door"
        | "dormakaba_oracode_door"
        | "tedee_lock"
        | "akiles_lock"
        | "ultraloq_lock"
        | "keyincode_lock"
        | "omnitec_lock"
        | "kisi_lock"
        | "aqara_lock"
        | "keynest_key"
        | "noiseaware_activity_zone"
        | "minut_sensor"
        | "ecobee_thermostat"
        | "nest_thermostat"
        | "honeywell_resideo_thermostat"
        | "tado_thermostat"
        | "sensi_thermostat"
        | "smartthings_thermostat"
        | "ios_phone"
        | "android_phone"
        | "ring_camera";
    errors: (
        | {
            created_at: string;
            error_code: "account_disconnected";
            is_connected_account_error: boolean;
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "salto_ks_subscription_limit_exceeded";
            is_connected_account_error: boolean;
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "dormakaba_sites_disconnected";
            is_connected_account_error: boolean;
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "device_offline";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "device_removed";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "hub_disconnected";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "device_disconnected";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "empty_backup_access_code_pool";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "august_lock_not_authorized";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "missing_device_credentials";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "auxiliary_heat_running";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "subscription_required";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "bridge_disconnected";
            is_bridge_error?: boolean;
            is_connected_account_error?: boolean;
            message: string;
        }
    )[];
    is_managed: boolean;
    location?: {
        location_name?: string;
        time_zone?: string;
        timezone?: string;
    };
    properties: {
        accessory_keypad?: {
            battery?: { level: number };
            is_connected: boolean;
        };
        battery?: { level: number; status: "critical"
        | "low"
        | "good"
        | "full" };
        battery_level?: number;
        image_alt_text?: string;
        image_url?: string;
        manufacturer?: string;
        model: {
            accessory_keypad_supported?: boolean;
            can_connect_accessory_keypad?: boolean;
            display_name: string;
            has_built_in_keypad?: boolean;
            manufacturer_display_name: string;
            offline_access_codes_supported?: boolean;
            online_access_codes_supported?: boolean;
        };
        name: string;
        offline_access_codes_enabled?: boolean;
        online: boolean;
        online_access_codes_enabled?: boolean;
    };
    warnings: (
        | {
            created_at: string;
            message: string;
            warning_code: "partial_backup_access_code_pool";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "many_active_backup_codes";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "third_party_integration_detected";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "ttlock_weak_gateway_signal";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "power_saving_mode";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "temperature_threshold_exceeded";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "device_communication_degraded";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "scheduled_maintenance_window";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "device_has_flaky_connection";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "salto_ks_office_mode";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "salto_ks_privacy_mode";
        }
        | { created_at: string; message: string; warning_code: "privacy_mode" }
        | {
            created_at: string;
            message: string;
            warning_code: "salto_ks_subscription_limit_almost_reached";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "salto_ks_lock_access_code_support_removed";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "unknown_issue_with_phone";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "lockly_time_zone_not_configured";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "ultraloq_time_zone_unknown";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "time_zone_unknown";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "time_zone_mismatch";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "two_n_device_missing_timezone";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "hub_required_for_additional_capabilities";
        }
        | { created_at: string; message: string; warning_code: "provider_issue" }
        | {
            created_at: string;
            message: string;
            warning_code: "keynest_unsupported_locker";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "accessory_keypad_setup_required";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "unreliable_online_status";
        }
        | {
            active_access_code_count: number;
            created_at: string;
            max_active_access_code_count: number;
            message: string;
            warning_code: "max_access_codes_reached";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "insufficient_permissions";
        }
    )[];
    workspace_id: string;
}

Properties

`Optional`can_configure_auto_lock

can_configure_auto_lock?: boolean

Indicates whether the lock supports configuring automatic locking.

`Optional`can_hvac_cool

can_hvac_cool?: boolean

Indicates whether the thermostat supports cooling.

`Optional`can_hvac_heat

can_hvac_heat?: boolean

Indicates whether the thermostat supports heating.

`Optional`can_hvac_heat_cool

can_hvac_heat_cool?: boolean

Indicates whether the thermostat supports simultaneous heating and cooling.

`Optional`can_program_offline_access_codes

can_program_offline_access_codes?: boolean

Indicates whether the device supports programming offline access codes.

`Optional`can_program_online_access_codes

can_program_online_access_codes?: boolean

Indicates whether the device supports programming online access codes.

`Optional`can_program_thermostat_programs_as_different_each_day

can_program_thermostat_programs_as_different_each_day?: boolean

Indicates whether the thermostat supports different climate programs for each day of the week.

`Optional`can_program_thermostat_programs_as_same_each_day

can_program_thermostat_programs_as_same_each_day?: boolean

Indicates whether the thermostat supports a single climate program applied to every day.

`Optional`can_program_thermostat_programs_as_weekday_weekend

can_program_thermostat_programs_as_weekday_weekend?: boolean

Indicates whether the thermostat supports weekday/weekend climate programs.

`Optional`can_remotely_lock

can_remotely_lock?: boolean

Indicates whether the device supports remote locking.

`Optional`can_remotely_unlock

can_remotely_unlock?: boolean

Indicates whether the device supports remote unlocking.

`Optional`can_run_thermostat_programs

can_run_thermostat_programs?: boolean

Indicates whether the thermostat supports running climate programs.

`Optional`can_simulate_connection

can_simulate_connection?: boolean

Indicates whether the device supports simulating connection in a sandbox.

`Optional`can_simulate_disconnection

can_simulate_disconnection?: boolean

Indicates whether the device supports simulating disconnection in a sandbox.

`Optional`can_simulate_hub_connection

can_simulate_hub_connection?: boolean

Indicates whether the hub supports simulating connection in a sandbox.

`Optional`can_simulate_hub_disconnection

can_simulate_hub_disconnection?: boolean

Indicates whether the hub supports simulating disconnection in a sandbox.

`Optional`can_simulate_paid_subscription

can_simulate_paid_subscription?: boolean

Indicates whether the device supports simulating a paid subscription in a sandbox.

`Optional`can_simulate_removal

can_simulate_removal?: boolean

Indicates whether the device supports simulating removal in a sandbox.

`Optional`can_turn_off_hvac

can_turn_off_hvac?: boolean

Indicates whether the thermostat can be turned off.

`Optional`can_unlock_with_code

can_unlock_with_code?: boolean

Indicates whether the lock supports unlocking with an access code.

capabilities_supported

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; battery, which indicates that the device can manage battery life and health; and phone, which indicates that the device is a mobile device, such as a smartphone. Important: Superseded by capability flags.

connected_account_id

connected_account_id: string

Unique identifier for the account associated with the device.

created_at

created_at: string

Date and time at which the device object was created.

custom_metadata

custom_metadata: Record<string, unknown>

Set of key:value pairs. Adding custom metadata to a resource, such as a Connect Webview, connected account, or device, enables you to store custom information, like customer details or internal IDs from your application.

device_id

device_id: string

ID of the device.

device_type

Type of the device.

errors

errors: (
    | {
        created_at: string;
        error_code: "account_disconnected";
        is_connected_account_error: boolean;
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "salto_ks_subscription_limit_exceeded";
        is_connected_account_error: boolean;
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "dormakaba_sites_disconnected";
        is_connected_account_error: boolean;
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "device_offline";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "device_removed";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "hub_disconnected";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "device_disconnected";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "empty_backup_access_code_pool";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "august_lock_not_authorized";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "missing_device_credentials";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "auxiliary_heat_running";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "subscription_required";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "bridge_disconnected";
        is_bridge_error?: boolean;
        is_connected_account_error?: boolean;
        message: string;
    }
)[]

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.

Type Declaration

{
    created_at: string;
    error_code: "account_disconnected";
    is_connected_account_error: boolean;
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "account_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_connected_account_error: boolean
  
  Indicates that the error is a connected account error.
- is_device_error: boolean
  
  Indicates that the error is not a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "salto_ks_subscription_limit_exceeded";
    is_connected_account_error: boolean;
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "salto_ks_subscription_limit_exceeded"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_connected_account_error: boolean
  
  Indicates that the error is a connected account error.
- is_device_error: boolean
  
  Indicates that the error is not a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "dormakaba_sites_disconnected";
    is_connected_account_error: boolean;
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "dormakaba_sites_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_connected_account_error: boolean
  
  Indicates that the error is a connected account error.
- is_device_error: boolean
  
  Indicates that the error is not a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "device_offline";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "device_offline"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "device_removed";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "device_removed"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "hub_disconnected";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "hub_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "device_disconnected";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "device_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "empty_backup_access_code_pool";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "empty_backup_access_code_pool"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "august_lock_not_authorized";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "august_lock_not_authorized"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "missing_device_credentials";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "missing_device_credentials"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "auxiliary_heat_running";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "auxiliary_heat_running"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "subscription_required";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "subscription_required"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "bridge_disconnected";
    is_bridge_error?: boolean;
    is_connected_account_error?: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "bridge_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- Optionalis_bridge_error?: boolean
  
  Indicates whether the error is related to Seam Bridge.
- Optionalis_connected_account_error?: boolean
  
  Indicates whether the error is related specifically to the connected account.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

is_managed

is_managed: boolean

Indicates that Seam does not manage the device.

`Optional`location

location?: { location_name?: string; time_zone?: string; timezone?: string }

Location information for the device.

Type Declaration

Optionallocation_name?: string

Name of the device location.
Optionaltime_zone?: string

Time zone of the device location.
Optionaltimezone?: string

Time zone of the device location.

Deprecated
Use time_zone instead.

properties

properties: {
    accessory_keypad?: {
        battery?: { level: number };
        is_connected: boolean;
    };
    battery?: { level: number; status: "critical"
    | "low"
    | "good"
    | "full" };
    battery_level?: number;
    image_alt_text?: string;
    image_url?: string;
    manufacturer?: string;
    model: {
        accessory_keypad_supported?: boolean;
        can_connect_accessory_keypad?: boolean;
        display_name: string;
        has_built_in_keypad?: boolean;
        manufacturer_display_name: string;
        offline_access_codes_supported?: boolean;
        online_access_codes_supported?: boolean;
    };
    name: string;
    offline_access_codes_enabled?: boolean;
    online: boolean;
    online_access_codes_enabled?: boolean;
}

properties of the device.

Type Declaration

Optionalaccessory_keypad?: { battery?: { level: number }; is_connected: boolean }

Accessory keypad properties and state.
- Optionalbattery?: { level: number }
  
  Keypad battery properties.
- is_connected: boolean
  
  Indicates if an accessory keypad is connected to the device.
Optionalbattery?: { level: number; status: "critical" | "low" | "good" | "full" }

Represents the current status of the battery charge level.
- level: number
  
  Battery charge level as a value between 0 and 1, inclusive.
- status: "critical" | "low" | "good" | "full"
  
  Represents the current status of the battery charge level. Values are critical, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; low, which signifies that the battery is under the preferred threshold and should be charged soon; good, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and full, which represents a battery that is fully charged, providing the maximum duration of usage.
Optionalbattery_level?: number

Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
Optionalimage_alt_text?: string

Alt text for the device image.
Optionalimage_url?: string

Image URL for the device.
Optionalmanufacturer?: string

Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.
model: {
    accessory_keypad_supported?: boolean;
    can_connect_accessory_keypad?: boolean;
    display_name: string;
    has_built_in_keypad?: boolean;
    manufacturer_display_name: string;
    offline_access_codes_supported?: boolean;
    online_access_codes_supported?: boolean;
}

Device model-related properties.
- Optionalaccessory_keypad_supported?: boolean
  
  Deprecated
  use device.properties.model.can_connect_accessory_keypad
- Optionalcan_connect_accessory_keypad?: boolean
  
  Indicates whether the device can connect a accessory keypad.
- display_name: string
  
  Display name of the device model.
- Optionalhas_built_in_keypad?: boolean
  
  Indicates whether the device has a built in accessory keypad.
- manufacturer_display_name: string
  
  Display name that corresponds to the manufacturer-specific terminology for the device.
- Optionaloffline_access_codes_supported?: boolean
  
  Deprecated
  use device.can_program_offline_access_codes.
- Optionalonline_access_codes_supported?: boolean
  
  Deprecated
  use device.can_program_online_access_codes.
name: string

Name of the device.

Deprecated
use device.display_name instead
Optionaloffline_access_codes_enabled?: boolean

Indicates whether it is currently possible to use offline access codes for the device.

Deprecated
use device.can_program_offline_access_codes
online: boolean

Indicates whether the device is online.
Optionalonline_access_codes_enabled?: boolean

Indicates whether it is currently possible to use online access codes for the device.

Deprecated
use device.can_program_online_access_codes

warnings

warnings: (
    | {
        created_at: string;
        message: string;
        warning_code: "partial_backup_access_code_pool";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "many_active_backup_codes";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "third_party_integration_detected";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "ttlock_weak_gateway_signal";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "power_saving_mode";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "temperature_threshold_exceeded";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "device_communication_degraded";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "scheduled_maintenance_window";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "device_has_flaky_connection";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "salto_ks_office_mode";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "salto_ks_privacy_mode";
    }
    | { created_at: string; message: string; warning_code: "privacy_mode" }
    | {
        created_at: string;
        message: string;
        warning_code: "salto_ks_subscription_limit_almost_reached";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "salto_ks_lock_access_code_support_removed";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "unknown_issue_with_phone";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "lockly_time_zone_not_configured";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "ultraloq_time_zone_unknown";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "time_zone_unknown";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "time_zone_mismatch";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "two_n_device_missing_timezone";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "hub_required_for_additional_capabilities";
    }
    | { created_at: string; message: string; warning_code: "provider_issue" }
    | {
        created_at: string;
        message: string;
        warning_code: "keynest_unsupported_locker";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "accessory_keypad_setup_required";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "unreliable_online_status";
    }
    | {
        active_access_code_count: number;
        created_at: string;
        max_active_access_code_count: number;
        message: string;
        warning_code: "max_access_codes_reached";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "insufficient_permissions";
    }
)[]

Array of warnings associated with the device. Each warning object within the array contains two fields: warning_code and message. warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.

Type Declaration

{
    created_at: string;
    message: string;
    warning_code: "partial_backup_access_code_pool";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "partial_backup_access_code_pool"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "many_active_backup_codes";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "many_active_backup_codes"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "third_party_integration_detected";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "third_party_integration_detected"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "ttlock_lock_gateway_unlocking_not_enabled";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "ttlock_lock_gateway_unlocking_not_enabled"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "ttlock_weak_gateway_signal";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "ttlock_weak_gateway_signal"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "power_saving_mode" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "power_saving_mode"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "temperature_threshold_exceeded";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "temperature_threshold_exceeded"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "device_communication_degraded";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "device_communication_degraded"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "scheduled_maintenance_window";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "scheduled_maintenance_window"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "device_has_flaky_connection";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "device_has_flaky_connection"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "salto_ks_office_mode" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "salto_ks_office_mode"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "salto_ks_privacy_mode" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "salto_ks_privacy_mode"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "privacy_mode" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "privacy_mode"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "salto_ks_subscription_limit_almost_reached";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "salto_ks_subscription_limit_almost_reached"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "salto_ks_lock_access_code_support_removed";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "salto_ks_lock_access_code_support_removed"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "unknown_issue_with_phone";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "unknown_issue_with_phone"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "lockly_time_zone_not_configured";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "lockly_time_zone_not_configured"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "ultraloq_time_zone_unknown";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "ultraloq_time_zone_unknown"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "time_zone_unknown" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "time_zone_unknown"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "time_zone_mismatch" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "time_zone_mismatch"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "two_n_device_missing_timezone";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "two_n_device_missing_timezone"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "hub_required_for_additional_capabilities";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "hub_required_for_additional_capabilities"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "provider_issue" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "provider_issue"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "keynest_unsupported_locker";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "keynest_unsupported_locker"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "accessory_keypad_setup_required";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "accessory_keypad_setup_required"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "unreliable_online_status";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "unreliable_online_status"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    active_access_code_count: number;
    created_at: string;
    max_active_access_code_count: number;
    message: string;
    warning_code: "max_access_codes_reached";
}
- active_access_code_count: number
  
  Number of active access codes on the device when the warning was set.
- created_at: string
  
  Date and time at which Seam created the warning.
- max_active_access_code_count: number
  
  Maximum number of active access codes supported by the device.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "max_access_codes_reached"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "insufficient_permissions";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "insufficient_permissions"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

workspace_id

workspace_id: string

Unique identifier for the Seam workspace associated with the device.

Type Alias UnmanagedDevice

Index

Properties

Properties

Optionalcan_configure_auto_lock

Optionalcan_hvac_cool

Optionalcan_hvac_heat

Optionalcan_hvac_heat_cool

Optionalcan_program_offline_access_codes

Optionalcan_program_online_access_codes

Optionalcan_program_thermostat_programs_as_different_each_day

Optionalcan_program_thermostat_programs_as_same_each_day

Optionalcan_program_thermostat_programs_as_weekday_weekend

Optionalcan_remotely_lock

Optionalcan_remotely_unlock

Optionalcan_run_thermostat_programs

Optionalcan_simulate_connection

Optionalcan_simulate_disconnection

Optionalcan_simulate_hub_connection

Optionalcan_simulate_hub_disconnection

Optionalcan_simulate_paid_subscription

Optionalcan_simulate_removal

Optionalcan_turn_off_hvac

Optionalcan_unlock_with_code

capabilities_supported

connected_account_id

created_at

custom_metadata

device_id

device_type

errors

Type Declaration

created_at: string

error_code: "account_disconnected"

is_connected_account_error: boolean

is_device_error: boolean

message: string

created_at: string

error_code: "salto_ks_subscription_limit_exceeded"

is_connected_account_error: boolean

is_device_error: boolean

message: string

created_at: string

error_code: "dormakaba_sites_disconnected"

is_connected_account_error: boolean

is_device_error: boolean

message: string

created_at: string

error_code: "device_offline"

is_device_error: boolean

message: string

created_at: string

error_code: "device_removed"

is_device_error: boolean

message: string

created_at: string

error_code: "hub_disconnected"

is_device_error: boolean

message: string

created_at: string

error_code: "device_disconnected"

is_device_error: boolean

message: string

created_at: string

error_code: "empty_backup_access_code_pool"

is_device_error: boolean

message: string

created_at: string

error_code: "august_lock_not_authorized"

is_device_error: boolean

message: string

created_at: string

error_code: "missing_device_credentials"

is_device_error: boolean

message: string

created_at: string

error_code: "auxiliary_heat_running"

is_device_error: boolean

message: string

created_at: string

`Optional`can_configure_auto_lock

`Optional`can_hvac_cool

`Optional`can_hvac_heat

`Optional`can_hvac_heat_cool

`Optional`can_program_offline_access_codes

`Optional`can_program_online_access_codes

`Optional`can_program_thermostat_programs_as_different_each_day

`Optional`can_program_thermostat_programs_as_same_each_day

`Optional`can_program_thermostat_programs_as_weekday_weekend

`Optional`can_remotely_lock

`Optional`can_remotely_unlock

`Optional`can_run_thermostat_programs

`Optional`can_simulate_connection

`Optional`can_simulate_disconnection

`Optional`can_simulate_hub_connection

`Optional`can_simulate_hub_disconnection

`Optional`can_simulate_paid_subscription

`Optional`can_simulate_removal

`Optional`can_turn_off_hvac

`Optional`can_unlock_with_code

`Optional`is_bridge_error?: boolean

`Optional`is_connected_account_error?: boolean

`Optional`location

`Optional`location_name?: string

`Optional`time_zone?: string

`Optional`timezone?: string

`Optional`accessory_keypad?: { battery?: { level: number }; is_connected: boolean }

`Optional`battery?: { level: number }

`Optional`battery?: { level: number; status: "critical" | "low" | "good" | "full" }

`Optional`battery_level?: number

`Optional`image_alt_text?: string

`Optional`image_url?: string

`Optional`manufacturer?: string

model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
}

`Optional`accessory_keypad_supported?: boolean

`Optional`can_connect_accessory_keypad?: boolean

`Optional`has_built_in_keypad?: boolean

`Optional`offline_access_codes_supported?: boolean

`Optional`online_access_codes_supported?: boolean

`Optional`offline_access_codes_enabled?: boolean

`Optional`online_access_codes_enabled?: boolean