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;
        is_device_supported: boolean;
        main_category: "relay" | "thermostat" | "smartlock" | "sensor" | "intercom" | "accessory";
        main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
        manufacturer: {
            display_name: string;
            integration: "beta" | "stable" | "unsupported" | "planned" | "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;
    };
}

• 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;
      is_device_supported: boolean;
      main_category: "relay" | "thermostat" | "smartlock" | "sensor" | "intercom" | "accessory";
      main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
      manufacturer: {
          display_name: string;
          integration: "beta" | "stable" | "unsupported" | "planned" | "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;
  }

  • 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

  • is_device_supported: boolean

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

  • main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee"

  • manufacturer: {
        display_name: string;
        integration: "beta" | "stable" | "unsupported" | "planned" | "inquire";
        is_connect_webview_supported: boolean;
        logo?: {
            height: number;
            url: string;
            width: number;
        };
        manufacturer_id: string;
        requires_seam_support_to_add_account: boolean;
    }

    • display_name: string

    • integration: "beta" | "stable" | "unsupported" | "planned" | "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

  • power_sources: ("battery" | "hardwired" | "mechanical_harvesting" | "wireless" | "ethernet")[]

  • Optional product_url?: string

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;
        is_device_supported: boolean;
        main_category: "relay" | "thermostat" | "smartlock" | "sensor" | "intercom" | "accessory";
        main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
        manufacturer: {
            display_name: string;
            integration: "beta" | "stable" | "unsupported" | "planned" | "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;
    }[];
}

• 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;
      is_device_supported: boolean;
      main_category: "relay" | "thermostat" | "smartlock" | "sensor" | "intercom" | "accessory";
      main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
      manufacturer: {
          display_name: string;
          integration: "beta" | "stable" | "unsupported" | "planned" | "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;
  }[]

method: "GET" | "OPTIONS"

queryParams: {
    exclude_if?: string[];
    include_if?: string[];
    integration_status?: "beta" | "stable" | "unsupported" | "planned" | "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" | "unsupported" | "planned" | "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: {
        device_model_count: number;
        display_name: string;
        integration: "beta" | "stable" | "unsupported" | "planned" | "inquire";
        is_connect_webview_supported: boolean;
        logo?: {
            height: number;
            url: string;
            width: number;
        };
        manufacturer_id: string;
        requires_seam_support_to_add_account: boolean;
    };
}

• manufacturer: {
      device_model_count: number;
      display_name: string;
      integration: "beta" | "stable" | "unsupported" | "planned" | "inquire";
      is_connect_webview_supported: boolean;
      logo?: {
          height: number;
          url: string;
          width: number;
      };
      manufacturer_id: string;
      requires_seam_support_to_add_account: boolean;
  }

  • device_model_count: number

  • display_name: string

  • integration: "beta" | "stable" | "unsupported" | "planned" | "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: {
        device_model_count: number;
        display_name: string;
        integration: "beta" | "stable" | "unsupported" | "planned" | "inquire";
        is_connect_webview_supported: boolean;
        logo?: {
            height: number;
            url: string;
            width: number;
        };
        manufacturer_id: string;
        requires_seam_support_to_add_account: boolean;
    }[];
}

• manufacturers: {
      device_model_count: number;
      display_name: string;
      integration: "beta" | "stable" | "unsupported" | "planned" | "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" | "unsupported" | "planned" | "inquire";
    liqe_query?: string;
}

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

• Optional liqe_query?: string

route: "/v1/manufacturers/list"