Interface Routes

commonParams: {}

formData: {}

jsonBody: {}

jsonResponse: {
    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;
            }[];
            display_name: string;
            integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
            integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
            is_connect_webview_supported: boolean;
            logo?: {
                height: number;
                url: string;
                width: number;
            };
            manufacturer_id: string;
            requires_seam_support_to_add_account: boolean;
        };
        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;
        };
    } | {
        main_category: "thermostat";
        physical_properties: {
            available_modes: ("heat" | "cool" | "fan" | "eco")[];
            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;
          }[];
          display_name: string;
          integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
          integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
          is_connect_webview_supported: boolean;
          logo?: {
              height: number;
              url: string;
              width: number;
          };
          manufacturer_id: string;
          requires_seam_support_to_add_account: boolean;
      };
      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;
      };
  } | {
      main_category: "thermostat";
      physical_properties: {
          available_modes: ("heat" | "cool" | "fan" | "eco")[];
          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";
  })

method: "GET" | "OPTIONS"

queryParams: {
    device_model_id: string;
}

• device_model_id: string

route: "/v1/device_models/get"

commonParams: {}

formData: {}

jsonBody: {}

jsonResponse: {
    device_models: ({
        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;
            }[];
            display_name: string;
            integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
            integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
            is_connect_webview_supported: boolean;
            logo?: {
                height: number;
                url: string;
                width: number;
            };
            manufacturer_id: string;
            requires_seam_support_to_add_account: boolean;
        };
        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;
        };
    } | {
        main_category: "thermostat";
        physical_properties: {
            available_modes: ("heat" | "cool" | "fan" | "eco")[];
            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: 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;
          }[];
          display_name: string;
          integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
          integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
          is_connect_webview_supported: boolean;
          logo?: {
              height: number;
              url: string;
              width: number;
          };
          manufacturer_id: string;
          requires_seam_support_to_add_account: boolean;
      };
      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;
      };
  } | {
      main_category: "thermostat";
      physical_properties: {
          available_modes: ("heat" | "cool" | "fan" | "eco")[];
          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";
  }))[]

method: "GET" | "OPTIONS"

queryParams: {
    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" | "smartlock" | "sensor" | "intercom" | "accessory";
    manufacturer_id?: string;
    manufacturer_ids?: string[];
    text_search?: string;
}

• Optional exclude_if?: string[]

• Optional include_if?: string[]

• Optional integration_status?: "beta" | "stable" | "planned" | "unsupported" | "inquire"

• Optional integration_support_levels?: ("beta" | "stable" | "planned" | "unsupported" | "inquire")[]

• Optional main_category?: "relay" | "thermostat" | "smartlock" | "sensor" | "intercom" | "accessory"

• Optional manufacturer_id?: string

• Optional manufacturer_ids?: string[]

• Optional text_search?: string

route: "/v1/device_models/list"

commonParams: {}

formData: {}

jsonBody: {}

jsonResponse: {
    manufacturer: {
        annotations: {
            annotation_code: "subscription_required";
            message: string;
        }[];
        device_model_count: number;
        display_name: string;
        integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
        integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
        is_connect_webview_supported: boolean;
        logo?: {
            height: number;
            url: string;
            width: number;
        };
        manufacturer_id: string;
        requires_seam_support_to_add_account: boolean;
    };
}

• manufacturer: {
      annotations: {
          annotation_code: "subscription_required";
          message: string;
      }[];
      device_model_count: number;
      display_name: string;
      integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
      integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
      is_connect_webview_supported: boolean;
      logo?: {
          height: number;
          url: string;
          width: number;
      };
      manufacturer_id: string;
      requires_seam_support_to_add_account: boolean;
  }

  • annotations: {
        annotation_code: "subscription_required";
        message: string;
    }[]

  • device_model_count: number

  • display_name: string

  • integration: "beta" | "stable" | "planned" | "unsupported" | "inquire"

  • integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire"

  • is_connect_webview_supported: boolean

  • Optional logo?: {
        height: number;
        url: string;
        width: number;
    }

    • height: number

    • url: string

    • width: number

  • manufacturer_id: string

  • requires_seam_support_to_add_account: boolean

method: "GET" | "OPTIONS"

queryParams: {
    manufacturer_id: string;
}

• manufacturer_id: string

route: "/v1/manufacturers/get"

commonParams: {}

formData: {}

jsonBody: {}

jsonResponse: {
    manufacturers: {
        annotations: {
            annotation_code: "subscription_required";
            message: string;
        }[];
        device_model_count: number;
        display_name: string;
        integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
        integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
        is_connect_webview_supported: boolean;
        logo?: {
            height: number;
            url: string;
            width: number;
        };
        manufacturer_id: string;
        requires_seam_support_to_add_account: boolean;
    }[];
}

• manufacturers: {
      annotations: {
          annotation_code: "subscription_required";
          message: string;
      }[];
      device_model_count: number;
      display_name: string;
      integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
      integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
      is_connect_webview_supported: boolean;
      logo?: {
          height: number;
          url: string;
          width: number;
      };
      manufacturer_id: string;
      requires_seam_support_to_add_account: boolean;
  }[]

method: "GET" | "OPTIONS"

queryParams: {
    integration_status?: "beta" | "stable" | "planned" | "unsupported" | "inquire";
    integration_support_levels?: ("beta" | "stable" | "planned" | "unsupported" | "inquire")[];
    liqe_query?: string;
}

• Optional integration_status?: "beta" | "stable" | "planned" | "unsupported" | "inquire"

• Optional integration_support_levels?: ("beta" | "stable" | "planned" | "unsupported" | "inquire")[]

• Optional liqe_query?: string

route: "/v1/manufacturers/list"