routes: {
"/api/v1/device_models/get": {
auth: "publishable_key";
jsonResponse: ZodObject<
{
device_model: ZodIntersection<
ZodObject<
{
aesthetic_variants: ZodArray<
ZodObject<
{
back_image: ZodOptional<(...)>;
display_name: ZodString;
front_image: ZodOptional<(...)>;
images: ZodArray<(...), (...)>;
manufacturer_sku: ZodOptional<(...)>;
primary_color_hex: ZodOptional<(...)>;
slug: ZodString;
},
"strip",
ZodTypeAny,
{
back_image?: (...)
| (...);
display_name: string;
front_image?: (...) | (...);
images: (...)[];
manufacturer_sku?: (...) | (...);
primary_color_hex?: (...) | (...);
slug: string;
},
{
back_image?: (...)
| (...);
display_name: string;
front_image?: (...) | (...);
images: (...)[];
manufacturer_sku?: (...) | (...);
primary_color_hex?: (...) | (...);
slug: string;
},
>,
"many",
>;
description: ZodString;
device_model_id: ZodString;
display_name: ZodString;
hardware: ZodObject<
{ has_physical_key: ZodOptional<ZodBoolean> },
"strip",
ZodTypeAny,
{ has_physical_key?: boolean },
{ has_physical_key?: boolean },
>;
is_device_supported: ZodBoolean;
main_connection_type: ZodEnum<["wifi", "zwave", "zigbee", "unknown"]>;
manufacturer: ZodObject<
Omit<
{
annotations: ZodArray<(...), (...)>;
countries_of_origin: ZodOptional<(...)>;
description: ZodOptional<(...)>;
device_model_count: ZodNumber;
display_name: ZodString;
founding_year: ZodOptional<(...)>;
headquarters: ZodOptional<(...)>;
integration: ZodEnum<(...)>;
integration_support_level: ZodEnum<(...)>;
is_connect_webview_supported: ZodBoolean;
legal_name: ZodOptional<(...)>;
logo: ZodOptional<(...)>;
manufacturer_id: ZodString;
parent_organization: ZodOptional<(...)>;
requires_seam_support_to_add_account: ZodBoolean;
seam_api_guide: ZodOptional<(...)>;
us_customer_support_contact_url: ZodOptional<(...)>;
us_customer_support_email: ZodOptional<(...)>;
us_customer_support_tel: ZodOptional<(...)>;
website: ZodOptional<(...)>;
},
"device_model_count",
>,
"strip",
ZodTypeAny,
{
annotations: { annotation_code: ...; message: ... }[];
countries_of_origin?: (...)[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: (...)[];
integration:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: ...; url: ...; width: ... };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
{
annotations: { annotation_code: ...; message: ... }[];
countries_of_origin?: (...)[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: (...)[];
integration:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: ...; url: ...; width: ... };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
>;
power_sources: ZodArray<
ZodEnum<
[
"battery",
"hardwired",
"mechanical_harvesting",
"wireless",
"ethernet",
],
>,
"many",
>;
product_url: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
aesthetic_variants: {
back_image?: { height: ...; url: ...; width: ... };
display_name: string;
front_image?: { height: ...; url: ...; width: ... };
images: { height: ...; url: ...; width: ... }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
},
{
aesthetic_variants: {
back_image?: { height: ...; url: ...; width: ... };
display_name: string;
front_image?: { height: ...; url: ...; width: ... };
images: { height: ...; url: ...; width: ... }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
},
>,
ZodDiscriminatedUnion<
"main_category",
[
ZodObject<
{
main_category: ZodLiteral<(...)>;
physical_properties: ZodObject<(...), (...), (...), (...), (...)>;
software_features: ZodObject<(...), (...), (...), (...), (...)>;
} & Pick<
{
can_hvac_cool: ...;
can_hvac_heat: ...;
can_hvac_heat_cool: ...;
can_program_offline_access_codes: ...;
can_program_online_access_codes: ...;
can_remotely_lock: ...;
can_remotely_unlock: ...;
can_turn_off_hvac: ...;
},
(...)
| (...)
| (...)
| (...),
>,
"strip",
ZodTypeAny,
{
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
},
{
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
},
>,
ZodObject<
{
main_category: ZodLiteral<"sensor">;
physical_properties: ZodObject<
{
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
},
"strip",
ZodTypeAny,
{
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
},
{
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
},
>;
},
"strip",
ZodTypeAny,
{
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
},
{
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
},
>,
ZodObject<
{
main_category: ZodLiteral<(...)>;
physical_properties: ZodObject<(...), (...), (...), (...), (...)>;
software_features: ZodObject<(...), (...), (...), (...), (...)>;
} & Pick<
{
can_hvac_cool: ...;
can_hvac_heat: ...;
can_hvac_heat_cool: ...;
can_program_offline_access_codes: ...;
can_program_online_access_codes: ...;
can_remotely_lock: ...;
can_remotely_unlock: ...;
can_turn_off_hvac: ...;
},
(...)
| (...)
| (...)
| (...),
>,
"strip",
ZodTypeAny,
{
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: (...)[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
},
{
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: (...)[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
},
>,
],
>,
>;
},
"strip",
ZodTypeAny,
{
device_model: {
aesthetic_variants: {
back_image?: { height: number; url: string; width: number };
display_name: string;
front_image?: { height: number; url: string; width: number };
images: { height: number; url: string; width: number }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
} & (
| {
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | "unknown"
| "deadbolt"
| "lever"
| "mortise"
| "lockbox"
| "cylinder"
| "padlock"
| "locker";
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
}
| {
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
}
| {
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: ("heat" | "cool" | "eco" | "fan")[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
}
| { main_category: "relay" }
| {
main_category: "intercom";
physical_properties: {
has_camera: boolean;
has_nfc_reader: boolean;
has_rfid_reader: boolean;
has_wiegand_interface: boolean;
};
software_features: {
can_program_access_codes: boolean;
can_remotely_unlock: boolean;
can_unlock_with_face_recognition: boolean;
supports_onvif: boolean;
};
}
| { main_category: "accessory" }
);
},
{
device_model: {
aesthetic_variants: {
back_image?: { height: number; url: string; width: number };
display_name: string;
front_image?: { height: number; url: string; width: number };
images: { height: number; url: string; width: number }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
} & (
| {
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | "unknown"
| "deadbolt"
| "lever"
| "mortise"
| "lockbox"
| "cylinder"
| "padlock"
| "locker";
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
}
| {
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
}
| {
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: ("heat" | "cool" | "eco" | "fan")[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
}
| { main_category: "relay" }
| {
main_category: "intercom";
physical_properties: {
has_camera: boolean;
has_nfc_reader?: boolean;
has_rfid_reader?: boolean;
has_wiegand_interface?: boolean;
};
software_features: {
can_program_access_codes: boolean;
can_remotely_unlock: boolean;
can_unlock_with_face_recognition?: boolean;
supports_onvif?: boolean;
};
}
| { main_category: "accessory" }
);
},
>;
methods: readonly ["GET", "OPTIONS"];
queryParams: ZodObject<
{ device_model_id: ZodString },
"strip",
ZodTypeAny,
{ device_model_id: string },
{ device_model_id: string },
>;
};
"/api/v1/device_models/list": {
auth: "publishable_key";
jsonResponse: ZodObject<
{
device_models: ZodArray<
ZodIntersection<
ZodObject<
{
aesthetic_variants: ZodArray<
ZodObject<
{
back_image: ...;
display_name: ...;
front_image: ...;
images: ...;
manufacturer_sku: ...;
primary_color_hex: ...;
slug: ...;
},
"strip",
ZodTypeAny,
{
back_image?: ...;
display_name: ...;
front_image?: ...;
images: ...;
manufacturer_sku?: ...;
primary_color_hex?: ...;
slug: ...;
},
{
back_image?: ...;
display_name: ...;
front_image?: ...;
images: ...;
manufacturer_sku?: ...;
primary_color_hex?: ...;
slug: ...;
},
>,
"many",
>;
description: ZodString;
device_model_id: ZodString;
display_name: ZodString;
hardware: ZodObject<
{ has_physical_key: ZodOptional<(...)> },
"strip",
ZodTypeAny,
{ has_physical_key?: (...) | (...) | (...) },
{ has_physical_key?: (...) | (...) | (...) },
>;
is_device_supported: ZodBoolean;
main_connection_type: ZodEnum<
["wifi", "zwave", "zigbee", "unknown"],
>;
manufacturer: ZodObject<
Omit<
{
annotations: ...;
countries_of_origin: ...;
description: ...;
device_model_count: ...;
display_name: ...;
founding_year: ...;
headquarters: ...;
integration: ...;
integration_support_level: ...;
is_connect_webview_supported: ...;
legal_name: ...;
logo: ...;
manufacturer_id: ...;
parent_organization: ...;
requires_seam_support_to_add_account: ...;
seam_api_guide: ...;
us_customer_support_contact_url: ...;
us_customer_support_email: ...;
us_customer_support_tel: ...;
website: ...;
},
"device_model_count",
>,
"strip",
ZodTypeAny,
{
annotations: (...)[];
countries_of_origin?: (...) | (...);
description?: (...) | (...);
display_name: string;
founding_year?: (...) | (...);
headquarters?: (...) | (...);
integration: (...) | (...) | (...) | (...) | (...);
integration_support_level: (...) | (...) | (...) | (...) | (...);
is_connect_webview_supported: boolean;
legal_name?: (...) | (...);
logo?: (...) | (...);
manufacturer_id: string;
parent_organization?: (...) | (...);
requires_seam_support_to_add_account: boolean;
seam_api_guide?: (...) | (...);
us_customer_support_contact_url?: (...) | (...);
us_customer_support_email?: (...) | (...);
us_customer_support_tel?: (...) | (...);
website?: (...) | (...);
},
{
annotations: (...)[];
countries_of_origin?: (...) | (...);
description?: (...) | (...);
display_name: string;
founding_year?: (...) | (...);
headquarters?: (...) | (...);
integration: (...) | (...) | (...) | (...) | (...);
integration_support_level: (...) | (...) | (...) | (...) | (...);
is_connect_webview_supported: boolean;
legal_name?: (...) | (...);
logo?: (...) | (...);
manufacturer_id: string;
parent_organization?: (...) | (...);
requires_seam_support_to_add_account: boolean;
seam_api_guide?: (...) | (...);
us_customer_support_contact_url?: (...) | (...);
us_customer_support_email?: (...) | (...);
us_customer_support_tel?: (...) | (...);
website?: (...) | (...);
},
>;
power_sources: ZodArray<
ZodEnum<[(...), (...), (...), (...), (...)]>,
"many",
>;
product_url: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
aesthetic_variants: {
back_image?: (...)
| (...);
display_name: string;
front_image?: (...) | (...);
images: (...)[];
manufacturer_sku?: (...) | (...);
primary_color_hex?: (...) | (...);
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: { annotation_code: ...; message: ... }[];
countries_of_origin?: (...)[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: (...)[];
integration:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: ...; url: ...; width: ... };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
},
{
aesthetic_variants: {
back_image?: (...)
| (...);
display_name: string;
front_image?: (...) | (...);
images: (...)[];
manufacturer_sku?: (...) | (...);
primary_color_hex?: (...) | (...);
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: { annotation_code: ...; message: ... }[];
countries_of_origin?: (...)[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: (...)[];
integration:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: ...; url: ...; width: ... };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
},
>,
ZodDiscriminatedUnion<
"main_category",
[
ZodObject<
{
main_category: ...;
physical_properties: ...;
software_features: ...;
} & Pick<(...), (...)>,
"strip",
ZodTypeAny,
{
can_program_offline_access_codes?: (...) | (...);
can_program_online_access_codes?: (...) | (...);
can_remotely_lock?: (...) | (...);
can_remotely_unlock?: (...) | (...);
main_category: "smartlock";
physical_properties: {
has_camera: ...;
has_physical_key: ...;
lock_type: ...;
};
software_features: {
can_program_access_codes: ...;
can_program_access_codes_offline: ...;
can_program_access_schedules: ...;
can_remotely_unlock: ...;
};
},
{
can_program_offline_access_codes?: (...)
| (...);
can_program_online_access_codes?: (...) | (...);
can_remotely_lock?: (...) | (...);
can_remotely_unlock?: (...) | (...);
main_category: "smartlock";
physical_properties: {
has_camera: ...;
has_physical_key: ...;
lock_type: ...;
};
software_features: {
can_program_access_codes: ...;
can_program_access_codes_offline: ...;
can_program_access_schedules: ...;
can_remotely_unlock: ...;
};
},
>,
ZodObject<
{
main_category: ZodLiteral<(...)>;
physical_properties: ZodObject<(...), (...), (...), (...), (...)>;
},
"strip",
ZodTypeAny,
{
main_category: "sensor";
physical_properties: {
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
};
},
{
main_category: "sensor";
physical_properties: {
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
};
},
>,
ZodObject<
{
main_category: ...;
physical_properties: ...;
software_features: ...;
} & Pick<(...), (...)>,
"strip",
ZodTypeAny,
{
can_hvac_cool?: (...) | (...);
can_hvac_heat?: (...) | (...);
can_hvac_heat_cool?: (...) | (...);
can_turn_off_hvac?: (...) | (...);
main_category: "thermostat";
physical_properties: {
available_modes: ...;
has_humidity_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
is_heat_pump_compatible: ...;
supports_demand_response: ...;
supports_emergency_heating_mode: ...;
};
software_features: { can_program_climate_schedules: ... };
},
{
can_hvac_cool?: (...)
| (...);
can_hvac_heat?: (...) | (...);
can_hvac_heat_cool?: (...) | (...);
can_turn_off_hvac?: (...) | (...);
main_category: "thermostat";
physical_properties: {
available_modes: ...;
has_humidity_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
is_heat_pump_compatible: ...;
supports_demand_response: ...;
supports_emergency_heating_mode: ...;
};
software_features: { can_program_climate_schedules: ... };
},
>,
],
>,
>,
"many",
>;
},
"strip",
ZodTypeAny,
{
device_models: (
{
aesthetic_variants: {
back_image?: { height: ...; url: ...; width: ... };
display_name: string;
front_image?: { height: ...; url: ...; width: ... };
images: { height: ...; url: ...; width: ... }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
} & (
| {
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | "unknown"
| "deadbolt"
| "lever"
| "mortise"
| "lockbox"
| "cylinder"
| "padlock"
| "locker";
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
}
| {
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
}
| {
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: ((...) | (...) | (...) | (...))[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
}
| { main_category: "relay" }
| {
main_category: "intercom";
physical_properties: {
has_camera: boolean;
has_nfc_reader: boolean;
has_rfid_reader: boolean;
has_wiegand_interface: boolean;
};
software_features: {
can_program_access_codes: boolean;
can_remotely_unlock: boolean;
can_unlock_with_face_recognition: boolean;
supports_onvif: boolean;
};
}
| { main_category: "accessory" }
)
)[];
},
{
device_models: (
{
aesthetic_variants: {
back_image?: { height: ...; url: ...; width: ... };
display_name: string;
front_image?: { height: ...; url: ...; width: ... };
images: { height: ...; url: ...; width: ... }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
} & (
| {
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | "unknown"
| "deadbolt"
| "lever"
| "mortise"
| "lockbox"
| "cylinder"
| "padlock"
| "locker";
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
}
| {
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
}
| {
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: ((...) | (...) | (...) | (...))[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
}
| { main_category: "relay" }
| {
main_category: "intercom";
physical_properties: {
has_camera: boolean;
has_nfc_reader?: boolean;
has_rfid_reader?: boolean;
has_wiegand_interface?: boolean;
};
software_features: {
can_program_access_codes: boolean;
can_remotely_unlock: boolean;
can_unlock_with_face_recognition?: boolean;
supports_onvif?: boolean;
};
}
| { main_category: "accessory" }
)
)[];
},
>;
methods: readonly ["GET", "OPTIONS"];
queryParams: ZodObject<
{
exclude_if: ZodOptional<ZodArray<ZodString, "many">>;
include_if: ZodOptional<ZodArray<ZodString, "many">>;
integration_status: ZodOptional<
ZodEnum<["stable", "beta", "planned", "unsupported", "inquire"]>,
>;
integration_support_levels: ZodOptional<
ZodArray<
ZodEnum<["stable", "beta", "planned", "unsupported", "inquire"]>,
"many",
>,
>;
main_category: ZodOptional<
ZodEnum<
[
"smartlock",
"sensor",
"thermostat",
"relay",
"intercom",
"accessory",
],
>,
>;
manufacturer_id: ZodOptional<ZodString>;
manufacturer_ids: ZodOptional<ZodArray<ZodString, "many">>;
text_search: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
exclude_if?: string[];
include_if?: string[];
integration_status?: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_levels?: (
"beta"
| "stable"
| "planned"
| "unsupported"
| "inquire"
)[];
main_category?:
| "relay"
| "thermostat"
| "sensor"
| "smartlock"
| "intercom"
| "accessory";
manufacturer_id?: string;
manufacturer_ids?: string[];
text_search?: string;
},
{
exclude_if?: string[];
include_if?: string[];
integration_status?: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_levels?: (
"beta"
| "stable"
| "planned"
| "unsupported"
| "inquire"
)[];
main_category?:
| "relay"
| "thermostat"
| "sensor"
| "smartlock"
| "intercom"
| "accessory";
manufacturer_id?: string;
manufacturer_ids?: string[];
text_search?: string;
},
>;
};
"/api/v1/manufacturers/get": {
auth: "publishable_key";
jsonResponse: ZodObject<
{
manufacturer: ZodObject<
{
annotations: ZodArray<
ZodObject<
{ annotation_code: ZodEnum<[(...)]>; message: ZodString },
"strip",
ZodTypeAny,
{ annotation_code: "subscription_required"; message: string },
{ annotation_code: "subscription_required"; message: string },
>,
"many",
>;
countries_of_origin: ZodOptional<ZodArray<ZodString, "many">>;
description: ZodOptional<ZodString>;
device_model_count: ZodNumber;
display_name: ZodString;
founding_year: ZodOptional<ZodString>;
headquarters: ZodOptional<ZodArray<ZodString, "many">>;
integration: ZodEnum<
["stable", "beta", "planned", "unsupported", "inquire"],
>;
integration_support_level: ZodEnum<
["stable", "beta", "planned", "unsupported", "inquire"],
>;
is_connect_webview_supported: ZodBoolean;
legal_name: ZodOptional<ZodString>;
logo: ZodOptional<
ZodObject<
{ height: ZodNumber; url: ZodString; width: ZodNumber },
"strip",
ZodTypeAny,
{ height: number; url: string; width: number },
{ height: number; url: string; width: number },
>,
>;
manufacturer_id: ZodString;
parent_organization: ZodOptional<ZodString>;
requires_seam_support_to_add_account: ZodBoolean;
seam_api_guide: ZodOptional<ZodString>;
us_customer_support_contact_url: ZodOptional<ZodString>;
us_customer_support_email: ZodOptional<ZodString>;
us_customer_support_tel: ZodOptional<ZodString>;
website: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
{
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
>;
},
"strip",
ZodTypeAny,
{
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
},
{
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
},
>;
methods: readonly ["GET", "OPTIONS"];
queryParams: ZodObject<
{ manufacturer_id: ZodString },
"strip",
ZodTypeAny,
{ manufacturer_id: string },
{ manufacturer_id: string },
>;
};
"/api/v1/manufacturers/list": {
auth: "publishable_key";
jsonResponse: ZodObject<
{
manufacturers: ZodArray<
ZodObject<
{
annotations: ZodArray<
ZodObject<
{ annotation_code: ZodEnum<(...)>; message: ZodString },
"strip",
ZodTypeAny,
{ annotation_code: "subscription_required"; message: string },
{ annotation_code: "subscription_required"; message: string },
>,
"many",
>;
countries_of_origin: ZodOptional<ZodArray<ZodString, "many">>;
description: ZodOptional<ZodString>;
device_model_count: ZodNumber;
display_name: ZodString;
founding_year: ZodOptional<ZodString>;
headquarters: ZodOptional<ZodArray<ZodString, "many">>;
integration: ZodEnum<
["stable", "beta", "planned", "unsupported", "inquire"],
>;
integration_support_level: ZodEnum<
["stable", "beta", "planned", "unsupported", "inquire"],
>;
is_connect_webview_supported: ZodBoolean;
legal_name: ZodOptional<ZodString>;
logo: ZodOptional<
ZodObject<
{ height: ZodNumber; url: ZodString; width: ZodNumber },
"strip",
ZodTypeAny,
{ height: number; url: string; width: number },
{ height: number; url: string; width: number },
>,
>;
manufacturer_id: ZodString;
parent_organization: ZodOptional<ZodString>;
requires_seam_support_to_add_account: ZodBoolean;
seam_api_guide: ZodOptional<ZodString>;
us_customer_support_contact_url: ZodOptional<ZodString>;
us_customer_support_email: ZodOptional<ZodString>;
us_customer_support_tel: ZodOptional<ZodString>;
website: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
{
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
>,
"many",
>;
},
"strip",
ZodTypeAny,
{
manufacturers: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
}[];
},
{
manufacturers: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
}[];
},
>;
methods: readonly ["GET", "OPTIONS"];
queryParams: ZodObject<
{
integration_status: ZodOptional<
ZodEnum<["stable", "beta", "planned", "unsupported", "inquire"]>,
>;
integration_support_levels: ZodOptional<
ZodArray<
ZodEnum<["stable", "beta", "planned", "unsupported", "inquire"]>,
"many",
>,
>;
liqe_query: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
integration_status?: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_levels?: (
"beta"
| "stable"
| "planned"
| "unsupported"
| "inquire"
)[];
liqe_query?: string;
},
{
integration_status?: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_levels?: (
"beta"
| "stable"
| "planned"
| "unsupported"
| "inquire"
)[];
liqe_query?: string;
},
>;
};
} = ...
Type declaration
Readonly/api/v1/device_models/get: {
auth: "publishable_key";
jsonResponse: ZodObject<
{
device_model: ZodIntersection<
ZodObject<
{
aesthetic_variants: ZodArray<
ZodObject<
{
back_image: ZodOptional<(...)>;
display_name: ZodString;
front_image: ZodOptional<(...)>;
images: ZodArray<(...), (...)>;
manufacturer_sku: ZodOptional<(...)>;
primary_color_hex: ZodOptional<(...)>;
slug: ZodString;
},
"strip",
ZodTypeAny,
{
back_image?: (...)
| (...);
display_name: string;
front_image?: (...) | (...);
images: (...)[];
manufacturer_sku?: (...) | (...);
primary_color_hex?: (...) | (...);
slug: string;
},
{
back_image?: (...)
| (...);
display_name: string;
front_image?: (...) | (...);
images: (...)[];
manufacturer_sku?: (...) | (...);
primary_color_hex?: (...) | (...);
slug: string;
},
>,
"many",
>;
description: ZodString;
device_model_id: ZodString;
display_name: ZodString;
hardware: ZodObject<
{ has_physical_key: ZodOptional<ZodBoolean> },
"strip",
ZodTypeAny,
{ has_physical_key?: boolean },
{ has_physical_key?: boolean },
>;
is_device_supported: ZodBoolean;
main_connection_type: ZodEnum<["wifi", "zwave", "zigbee", "unknown"]>;
manufacturer: ZodObject<
Omit<
{
annotations: ZodArray<(...), (...)>;
countries_of_origin: ZodOptional<(...)>;
description: ZodOptional<(...)>;
device_model_count: ZodNumber;
display_name: ZodString;
founding_year: ZodOptional<(...)>;
headquarters: ZodOptional<(...)>;
integration: ZodEnum<(...)>;
integration_support_level: ZodEnum<(...)>;
is_connect_webview_supported: ZodBoolean;
legal_name: ZodOptional<(...)>;
logo: ZodOptional<(...)>;
manufacturer_id: ZodString;
parent_organization: ZodOptional<(...)>;
requires_seam_support_to_add_account: ZodBoolean;
seam_api_guide: ZodOptional<(...)>;
us_customer_support_contact_url: ZodOptional<(...)>;
us_customer_support_email: ZodOptional<(...)>;
us_customer_support_tel: ZodOptional<(...)>;
website: ZodOptional<(...)>;
},
"device_model_count",
>,
"strip",
ZodTypeAny,
{
annotations: { annotation_code: ...; message: ... }[];
countries_of_origin?: (...)[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: (...)[];
integration:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: ...; url: ...; width: ... };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
{
annotations: { annotation_code: ...; message: ... }[];
countries_of_origin?: (...)[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: (...)[];
integration:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: ...; url: ...; width: ... };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
>;
power_sources: ZodArray<
ZodEnum<
[
"battery",
"hardwired",
"mechanical_harvesting",
"wireless",
"ethernet",
],
>,
"many",
>;
product_url: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
aesthetic_variants: {
back_image?: { height: ...; url: ...; width: ... };
display_name: string;
front_image?: { height: ...; url: ...; width: ... };
images: { height: ...; url: ...; width: ... }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
},
{
aesthetic_variants: {
back_image?: { height: ...; url: ...; width: ... };
display_name: string;
front_image?: { height: ...; url: ...; width: ... };
images: { height: ...; url: ...; width: ... }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
},
>,
ZodDiscriminatedUnion<
"main_category",
[
ZodObject<
{
main_category: ZodLiteral<(...)>;
physical_properties: ZodObject<(...), (...), (...), (...), (...)>;
software_features: ZodObject<(...), (...), (...), (...), (...)>;
} & Pick<
{
can_hvac_cool: ...;
can_hvac_heat: ...;
can_hvac_heat_cool: ...;
can_program_offline_access_codes: ...;
can_program_online_access_codes: ...;
can_remotely_lock: ...;
can_remotely_unlock: ...;
can_turn_off_hvac: ...;
},
(...)
| (...)
| (...)
| (...),
>,
"strip",
ZodTypeAny,
{
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
},
{
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
},
>,
ZodObject<
{
main_category: ZodLiteral<"sensor">;
physical_properties: ZodObject<
{
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
},
"strip",
ZodTypeAny,
{
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
},
{
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
},
>;
},
"strip",
ZodTypeAny,
{
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
},
{
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
},
>,
ZodObject<
{
main_category: ZodLiteral<(...)>;
physical_properties: ZodObject<(...), (...), (...), (...), (...)>;
software_features: ZodObject<(...), (...), (...), (...), (...)>;
} & Pick<
{
can_hvac_cool: ...;
can_hvac_heat: ...;
can_hvac_heat_cool: ...;
can_program_offline_access_codes: ...;
can_program_online_access_codes: ...;
can_remotely_lock: ...;
can_remotely_unlock: ...;
can_turn_off_hvac: ...;
},
(...)
| (...)
| (...)
| (...),
>,
"strip",
ZodTypeAny,
{
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: (...)[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
},
{
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: (...)[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
},
>,
],
>,
>;
},
"strip",
ZodTypeAny,
{
device_model: {
aesthetic_variants: {
back_image?: { height: number; url: string; width: number };
display_name: string;
front_image?: { height: number; url: string; width: number };
images: { height: number; url: string; width: number }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
} & (
| {
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | "unknown"
| "deadbolt"
| "lever"
| "mortise"
| "lockbox"
| "cylinder"
| "padlock"
| "locker";
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
}
| {
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
}
| {
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: ("heat" | "cool" | "eco" | "fan")[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
}
| { main_category: "relay" }
| {
main_category: "intercom";
physical_properties: {
has_camera: boolean;
has_nfc_reader: boolean;
has_rfid_reader: boolean;
has_wiegand_interface: boolean;
};
software_features: {
can_program_access_codes: boolean;
can_remotely_unlock: boolean;
can_unlock_with_face_recognition: boolean;
supports_onvif: boolean;
};
}
| { main_category: "accessory" }
);
},
{
device_model: {
aesthetic_variants: {
back_image?: { height: number; url: string; width: number };
display_name: string;
front_image?: { height: number; url: string; width: number };
images: { height: number; url: string; width: number }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
} & (
| {
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | "unknown"
| "deadbolt"
| "lever"
| "mortise"
| "lockbox"
| "cylinder"
| "padlock"
| "locker";
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
}
| {
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
}
| {
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: ("heat" | "cool" | "eco" | "fan")[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
}
| { main_category: "relay" }
| {
main_category: "intercom";
physical_properties: {
has_camera: boolean;
has_nfc_reader?: boolean;
has_rfid_reader?: boolean;
has_wiegand_interface?: boolean;
};
software_features: {
can_program_access_codes: boolean;
can_remotely_unlock: boolean;
can_unlock_with_face_recognition?: boolean;
supports_onvif?: boolean;
};
}
| { main_category: "accessory" }
);
},
>;
methods: readonly ["GET", "OPTIONS"];
queryParams: ZodObject<
{ device_model_id: ZodString },
"strip",
ZodTypeAny,
{ device_model_id: string },
{ device_model_id: string },
>;
}
Readonly/api/v1/device_models/list: {
auth: "publishable_key";
jsonResponse: ZodObject<
{
device_models: ZodArray<
ZodIntersection<
ZodObject<
{
aesthetic_variants: ZodArray<
ZodObject<
{
back_image: ...;
display_name: ...;
front_image: ...;
images: ...;
manufacturer_sku: ...;
primary_color_hex: ...;
slug: ...;
},
"strip",
ZodTypeAny,
{
back_image?: ...;
display_name: ...;
front_image?: ...;
images: ...;
manufacturer_sku?: ...;
primary_color_hex?: ...;
slug: ...;
},
{
back_image?: ...;
display_name: ...;
front_image?: ...;
images: ...;
manufacturer_sku?: ...;
primary_color_hex?: ...;
slug: ...;
},
>,
"many",
>;
description: ZodString;
device_model_id: ZodString;
display_name: ZodString;
hardware: ZodObject<
{ has_physical_key: ZodOptional<(...)> },
"strip",
ZodTypeAny,
{ has_physical_key?: (...) | (...) | (...) },
{ has_physical_key?: (...) | (...) | (...) },
>;
is_device_supported: ZodBoolean;
main_connection_type: ZodEnum<["wifi", "zwave", "zigbee", "unknown"]>;
manufacturer: ZodObject<
Omit<
{
annotations: ...;
countries_of_origin: ...;
description: ...;
device_model_count: ...;
display_name: ...;
founding_year: ...;
headquarters: ...;
integration: ...;
integration_support_level: ...;
is_connect_webview_supported: ...;
legal_name: ...;
logo: ...;
manufacturer_id: ...;
parent_organization: ...;
requires_seam_support_to_add_account: ...;
seam_api_guide: ...;
us_customer_support_contact_url: ...;
us_customer_support_email: ...;
us_customer_support_tel: ...;
website: ...;
},
"device_model_count",
>,
"strip",
ZodTypeAny,
{
annotations: (...)[];
countries_of_origin?: (...) | (...);
description?: (...) | (...);
display_name: string;
founding_year?: (...) | (...);
headquarters?: (...) | (...);
integration: (...) | (...) | (...) | (...) | (...);
integration_support_level: (...) | (...) | (...) | (...) | (...);
is_connect_webview_supported: boolean;
legal_name?: (...) | (...);
logo?: (...) | (...);
manufacturer_id: string;
parent_organization?: (...) | (...);
requires_seam_support_to_add_account: boolean;
seam_api_guide?: (...) | (...);
us_customer_support_contact_url?: (...) | (...);
us_customer_support_email?: (...) | (...);
us_customer_support_tel?: (...) | (...);
website?: (...) | (...);
},
{
annotations: (...)[];
countries_of_origin?: (...) | (...);
description?: (...) | (...);
display_name: string;
founding_year?: (...) | (...);
headquarters?: (...) | (...);
integration: (...) | (...) | (...) | (...) | (...);
integration_support_level: (...) | (...) | (...) | (...) | (...);
is_connect_webview_supported: boolean;
legal_name?: (...) | (...);
logo?: (...) | (...);
manufacturer_id: string;
parent_organization?: (...) | (...);
requires_seam_support_to_add_account: boolean;
seam_api_guide?: (...) | (...);
us_customer_support_contact_url?: (...) | (...);
us_customer_support_email?: (...) | (...);
us_customer_support_tel?: (...) | (...);
website?: (...) | (...);
},
>;
power_sources: ZodArray<
ZodEnum<[(...), (...), (...), (...), (...)]>,
"many",
>;
product_url: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
aesthetic_variants: {
back_image?: (...)
| (...);
display_name: string;
front_image?: (...) | (...);
images: (...)[];
manufacturer_sku?: (...) | (...);
primary_color_hex?: (...) | (...);
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: { annotation_code: ...; message: ... }[];
countries_of_origin?: (...)[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: (...)[];
integration:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: ...; url: ...; width: ... };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
},
{
aesthetic_variants: {
back_image?: (...)
| (...);
display_name: string;
front_image?: (...) | (...);
images: (...)[];
manufacturer_sku?: (...) | (...);
primary_color_hex?: (...) | (...);
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: { annotation_code: ...; message: ... }[];
countries_of_origin?: (...)[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: (...)[];
integration:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: ...; url: ...; width: ... };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
},
>,
ZodDiscriminatedUnion<
"main_category",
[
ZodObject<
{
main_category: ...;
physical_properties: ...;
software_features: ...;
} & Pick<(...), (...)>,
"strip",
ZodTypeAny,
{
can_program_offline_access_codes?: (...) | (...);
can_program_online_access_codes?: (...) | (...);
can_remotely_lock?: (...) | (...);
can_remotely_unlock?: (...) | (...);
main_category: "smartlock";
physical_properties: {
has_camera: ...;
has_physical_key: ...;
lock_type: ...;
};
software_features: {
can_program_access_codes: ...;
can_program_access_codes_offline: ...;
can_program_access_schedules: ...;
can_remotely_unlock: ...;
};
},
{
can_program_offline_access_codes?: (...)
| (...);
can_program_online_access_codes?: (...) | (...);
can_remotely_lock?: (...) | (...);
can_remotely_unlock?: (...) | (...);
main_category: "smartlock";
physical_properties: {
has_camera: ...;
has_physical_key: ...;
lock_type: ...;
};
software_features: {
can_program_access_codes: ...;
can_program_access_codes_offline: ...;
can_program_access_schedules: ...;
can_remotely_unlock: ...;
};
},
>,
ZodObject<
{
main_category: ZodLiteral<(...)>;
physical_properties: ZodObject<(...), (...), (...), (...), (...)>;
},
"strip",
ZodTypeAny,
{
main_category: "sensor";
physical_properties: {
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
};
},
{
main_category: "sensor";
physical_properties: {
has_humidity_sensor: ...;
has_noise_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
};
},
>,
ZodObject<
{
main_category: ...;
physical_properties: ...;
software_features: ...;
} & Pick<(...), (...)>,
"strip",
ZodTypeAny,
{
can_hvac_cool?: (...) | (...);
can_hvac_heat?: (...) | (...);
can_hvac_heat_cool?: (...) | (...);
can_turn_off_hvac?: (...) | (...);
main_category: "thermostat";
physical_properties: {
available_modes: ...;
has_humidity_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
is_heat_pump_compatible: ...;
supports_demand_response: ...;
supports_emergency_heating_mode: ...;
};
software_features: { can_program_climate_schedules: ... };
},
{
can_hvac_cool?: (...)
| (...);
can_hvac_heat?: (...) | (...);
can_hvac_heat_cool?: (...) | (...);
can_turn_off_hvac?: (...) | (...);
main_category: "thermostat";
physical_properties: {
available_modes: ...;
has_humidity_sensor: ...;
has_occupancy_detection: ...;
has_temperature_sensor: ...;
is_heat_pump_compatible: ...;
supports_demand_response: ...;
supports_emergency_heating_mode: ...;
};
software_features: { can_program_climate_schedules: ... };
},
>,
],
>,
>,
"many",
>;
},
"strip",
ZodTypeAny,
{
device_models: (
{
aesthetic_variants: {
back_image?: { height: ...; url: ...; width: ... };
display_name: string;
front_image?: { height: ...; url: ...; width: ... };
images: { height: ...; url: ...; width: ... }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
} & (
| {
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | "unknown"
| "deadbolt"
| "lever"
| "mortise"
| "lockbox"
| "cylinder"
| "padlock"
| "locker";
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
}
| {
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
}
| {
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: ((...) | (...) | (...) | (...))[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
}
| { main_category: "relay" }
| {
main_category: "intercom";
physical_properties: {
has_camera: boolean;
has_nfc_reader: boolean;
has_rfid_reader: boolean;
has_wiegand_interface: boolean;
};
software_features: {
can_program_access_codes: boolean;
can_remotely_unlock: boolean;
can_unlock_with_face_recognition: boolean;
supports_onvif: boolean;
};
}
| { main_category: "accessory" }
)
)[];
},
{
device_models: (
{
aesthetic_variants: {
back_image?: { height: ...; url: ...; width: ... };
display_name: string;
front_image?: { height: ...; url: ...; width: ... };
images: { height: ...; url: ...; width: ... }[];
manufacturer_sku?: string;
primary_color_hex?: string;
slug: string;
}[];
description: string;
device_model_id: string;
display_name: string;
hardware: { has_physical_key?: boolean };
is_device_supported: boolean;
main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
power_sources: (
| "battery"
| "hardwired"
| "mechanical_harvesting"
| "wireless"
| "ethernet"
)[];
product_url?: string;
} & (
| {
can_program_offline_access_codes?: true;
can_program_online_access_codes?: true;
can_remotely_lock?: true;
can_remotely_unlock?: true;
main_category: "smartlock";
physical_properties: {
has_camera: boolean;
has_physical_key: boolean;
lock_type: | "unknown"
| "deadbolt"
| "lever"
| "mortise"
| "lockbox"
| "cylinder"
| "padlock"
| "locker";
};
software_features: {
can_program_access_codes: boolean;
can_program_access_codes_offline: boolean;
can_program_access_schedules: boolean;
can_remotely_unlock: boolean;
};
}
| {
main_category: "sensor";
physical_properties: {
has_humidity_sensor: boolean;
has_noise_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
};
}
| {
can_hvac_cool?: true;
can_hvac_heat?: true;
can_hvac_heat_cool?: true;
can_turn_off_hvac?: true;
main_category: "thermostat";
physical_properties: {
available_modes: ((...) | (...) | (...) | (...))[];
has_humidity_sensor: boolean;
has_occupancy_detection: boolean;
has_temperature_sensor: boolean;
is_heat_pump_compatible: boolean;
supports_demand_response: boolean;
supports_emergency_heating_mode: boolean;
};
software_features: { can_program_climate_schedules: boolean };
}
| { main_category: "relay" }
| {
main_category: "intercom";
physical_properties: {
has_camera: boolean;
has_nfc_reader?: boolean;
has_rfid_reader?: boolean;
has_wiegand_interface?: boolean;
};
software_features: {
can_program_access_codes: boolean;
can_remotely_unlock: boolean;
can_unlock_with_face_recognition?: boolean;
supports_onvif?: boolean;
};
}
| { main_category: "accessory" }
)
)[];
},
>;
methods: readonly ["GET", "OPTIONS"];
queryParams: ZodObject<
{
exclude_if: ZodOptional<ZodArray<ZodString, "many">>;
include_if: ZodOptional<ZodArray<ZodString, "many">>;
integration_status: ZodOptional<
ZodEnum<["stable", "beta", "planned", "unsupported", "inquire"]>,
>;
integration_support_levels: ZodOptional<
ZodArray<
ZodEnum<["stable", "beta", "planned", "unsupported", "inquire"]>,
"many",
>,
>;
main_category: ZodOptional<
ZodEnum<
[
"smartlock",
"sensor",
"thermostat",
"relay",
"intercom",
"accessory",
],
>,
>;
manufacturer_id: ZodOptional<ZodString>;
manufacturer_ids: ZodOptional<ZodArray<ZodString, "many">>;
text_search: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
exclude_if?: string[];
include_if?: string[];
integration_status?: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_levels?: (
"beta"
| "stable"
| "planned"
| "unsupported"
| "inquire"
)[];
main_category?:
| "relay"
| "thermostat"
| "sensor"
| "smartlock"
| "intercom"
| "accessory";
manufacturer_id?: string;
manufacturer_ids?: string[];
text_search?: string;
},
{
exclude_if?: string[];
include_if?: string[];
integration_status?: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_levels?: (
"beta"
| "stable"
| "planned"
| "unsupported"
| "inquire"
)[];
main_category?:
| "relay"
| "thermostat"
| "sensor"
| "smartlock"
| "intercom"
| "accessory";
manufacturer_id?: string;
manufacturer_ids?: string[];
text_search?: string;
},
>;
}
Readonly/api/v1/manufacturers/get: {
auth: "publishable_key";
jsonResponse: ZodObject<
{
manufacturer: ZodObject<
{
annotations: ZodArray<
ZodObject<
{ annotation_code: ZodEnum<[(...)]>; message: ZodString },
"strip",
ZodTypeAny,
{ annotation_code: "subscription_required"; message: string },
{ annotation_code: "subscription_required"; message: string },
>,
"many",
>;
countries_of_origin: ZodOptional<ZodArray<ZodString, "many">>;
description: ZodOptional<ZodString>;
device_model_count: ZodNumber;
display_name: ZodString;
founding_year: ZodOptional<ZodString>;
headquarters: ZodOptional<ZodArray<ZodString, "many">>;
integration: ZodEnum<
["stable", "beta", "planned", "unsupported", "inquire"],
>;
integration_support_level: ZodEnum<
["stable", "beta", "planned", "unsupported", "inquire"],
>;
is_connect_webview_supported: ZodBoolean;
legal_name: ZodOptional<ZodString>;
logo: ZodOptional<
ZodObject<
{ height: ZodNumber; url: ZodString; width: ZodNumber },
"strip",
ZodTypeAny,
{ height: number; url: string; width: number },
{ height: number; url: string; width: number },
>,
>;
manufacturer_id: ZodString;
parent_organization: ZodOptional<ZodString>;
requires_seam_support_to_add_account: ZodBoolean;
seam_api_guide: ZodOptional<ZodString>;
us_customer_support_contact_url: ZodOptional<ZodString>;
us_customer_support_email: ZodOptional<ZodString>;
us_customer_support_tel: ZodOptional<ZodString>;
website: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
{
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
>;
},
"strip",
ZodTypeAny,
{
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
},
{
manufacturer: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
};
},
>;
methods: readonly ["GET", "OPTIONS"];
queryParams: ZodObject<
{ manufacturer_id: ZodString },
"strip",
ZodTypeAny,
{ manufacturer_id: string },
{ manufacturer_id: string },
>;
}
Readonly/api/v1/manufacturers/list: {
auth: "publishable_key";
jsonResponse: ZodObject<
{
manufacturers: ZodArray<
ZodObject<
{
annotations: ZodArray<
ZodObject<
{ annotation_code: ZodEnum<(...)>; message: ZodString },
"strip",
ZodTypeAny,
{ annotation_code: "subscription_required"; message: string },
{ annotation_code: "subscription_required"; message: string },
>,
"many",
>;
countries_of_origin: ZodOptional<ZodArray<ZodString, "many">>;
description: ZodOptional<ZodString>;
device_model_count: ZodNumber;
display_name: ZodString;
founding_year: ZodOptional<ZodString>;
headquarters: ZodOptional<ZodArray<ZodString, "many">>;
integration: ZodEnum<
["stable", "beta", "planned", "unsupported", "inquire"],
>;
integration_support_level: ZodEnum<
["stable", "beta", "planned", "unsupported", "inquire"],
>;
is_connect_webview_supported: ZodBoolean;
legal_name: ZodOptional<ZodString>;
logo: ZodOptional<
ZodObject<
{ height: ZodNumber; url: ZodString; width: ZodNumber },
"strip",
ZodTypeAny,
{ height: number; url: string; width: number },
{ height: number; url: string; width: number },
>,
>;
manufacturer_id: ZodString;
parent_organization: ZodOptional<ZodString>;
requires_seam_support_to_add_account: ZodBoolean;
seam_api_guide: ZodOptional<ZodString>;
us_customer_support_contact_url: ZodOptional<ZodString>;
us_customer_support_email: ZodOptional<ZodString>;
us_customer_support_tel: ZodOptional<ZodString>;
website: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
{
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
},
>,
"many",
>;
},
"strip",
ZodTypeAny,
{
manufacturers: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
}[];
},
{
manufacturers: {
annotations: {
annotation_code: "subscription_required";
message: string;
}[];
countries_of_origin?: string[];
description?: string;
device_model_count: number;
display_name: string;
founding_year?: string;
headquarters?: string[];
integration: "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_level:
| "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
is_connect_webview_supported: boolean;
legal_name?: string;
logo?: { height: number; url: string; width: number };
manufacturer_id: string;
parent_organization?: string;
requires_seam_support_to_add_account: boolean;
seam_api_guide?: string;
us_customer_support_contact_url?: string;
us_customer_support_email?: string;
us_customer_support_tel?: string;
website?: string;
}[];
},
>;
methods: readonly ["GET", "OPTIONS"];
queryParams: ZodObject<
{
integration_status: ZodOptional<
ZodEnum<["stable", "beta", "planned", "unsupported", "inquire"]>,
>;
integration_support_levels: ZodOptional<
ZodArray<
ZodEnum<["stable", "beta", "planned", "unsupported", "inquire"]>,
"many",
>,
>;
liqe_query: ZodOptional<ZodString>;
},
"strip",
ZodTypeAny,
{
integration_status?: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_levels?: (
"beta"
| "stable"
| "planned"
| "unsupported"
| "inquire"
)[];
liqe_query?: string;
},
{
integration_status?: | "beta"
| "stable"
| "planned"
| "unsupported"
| "inquire";
integration_support_levels?: (
"beta"
| "stable"
| "planned"
| "unsupported"
| "inquire"
)[];
liqe_query?: string;
},
>;
}