Class SeamHttpDevices

constructor

• new SeamHttpDevices(apiKeyOrOptions?): SeamHttpDevices

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpDevices

client

Readonly defaults

unmanaged

• get unmanaged(): SeamHttpDevicesUnmanaged

• Returns SeamHttpDevicesUnmanaged

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        device_id: string;
    }

    • device_id: string

  Returns Promise<void>

get

• get(body?): Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      custom_metadata?: Record<string, null | string | boolean>;
      device_id: string;
      device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          has_direct_power?: boolean;
          image_alt_text?: string;
          image_url?: string;
          manufacturer?: string;
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          serial_number?: string;
          supports_accessory_keypad?: boolean;
          supports_offline_access_codes?: boolean;
      } & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      } & {
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          brivo_metadata?: {
              device_name: string;
          };
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          honeywell_metadata?: {
              device_name: string;
              honeywell_device_id: string;
          };
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: null | number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "doorking" | "bridge";
          };
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          tedee_metadata?: {
              bridge_id: number;
              bridge_name: string;
              device_id: number;
              device_model: string;
              device_name: string;
              serial_number: string;
          };
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...);
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        device_id?: string;
        name?: string;
    }

    • Optional device_id?: string

    • Optional name?: string

  Returns Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      custom_metadata?: Record<string, null | string | boolean>;
      device_id: string;
      device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          has_direct_power?: boolean;
          image_alt_text?: string;
          image_url?: string;
          manufacturer?: string;
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          serial_number?: string;
          supports_accessory_keypad?: boolean;
          supports_offline_access_codes?: boolean;
      } & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      } & {
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          brivo_metadata?: {
              device_name: string;
          };
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          honeywell_metadata?: {
              device_name: string;
              honeywell_device_id: string;
          };
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: null | number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "doorking" | "bridge";
          };
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          tedee_metadata?: {
              bridge_id: number;
              bridge_name: string;
              device_id: number;
              device_model: string;
              device_name: string;
              serial_number: string;
          };
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...);
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }>

list

• list(body?): Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      custom_metadata?: Record<string, null | string | boolean>;
      device_id: string;
      device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          has_direct_power?: boolean;
          image_alt_text?: string;
          image_url?: string;
          manufacturer?: string;
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          serial_number?: string;
          supports_accessory_keypad?: boolean;
          supports_offline_access_codes?: boolean;
      } & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      } & {
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          brivo_metadata?: {
              device_name: string;
          };
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          honeywell_metadata?: {
              device_name: string;
              honeywell_device_id: string;
          };
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: null | number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "doorking" | "bridge";
          };
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          tedee_metadata?: {
              bridge_id: number;
              bridge_name: string;
              device_id: number;
              device_model: string;
              device_name: string;
              serial_number: string;
          };
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...);
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: Date;
        custom_metadata_has?: Record<string, null | string | boolean>;
        device_ids?: string[];
        device_type?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
        device_types?: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone")[];
        limit?: number;
        manufacturer?: "linear" | "unknown" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "doorking" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
        user_identifier_key?: string;
    }

    • Optional connect_webview_id?: string

    • Optional connected_account_id?: string

      List all devices owned by this connected account

    • Optional connected_account_ids?: string[]

    • Optional created_before?: Date

    • Optional custom_metadata_has?: Record<string, null | string | boolean>

    • Optional device_ids?: string[]

    • Optional device_type?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone"

    • Optional device_types?: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone")[]

    • Optional limit?: number

    • Optional manufacturer?: "linear" | "unknown" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "doorking" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell" | "keywe" | "philia" | "samsung" | "seam" | "two_n"

    • Optional user_identifier_key?: string

  Returns Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      custom_metadata?: Record<string, null | string | boolean>;
      device_id: string;
      device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: {
          battery?: {
              level: number;
              status: "low" | "full" | "critical" | "good";
          };
          battery_level?: number;
          has_direct_power?: boolean;
          image_alt_text?: string;
          image_url?: string;
          manufacturer?: string;
          model: {
              accessory_keypad_supported?: boolean;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
          serial_number?: string;
          supports_accessory_keypad?: boolean;
          supports_offline_access_codes?: boolean;
      } & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      } & {
          august_metadata?: {
              has_keypad: boolean;
              house_id?: string;
              house_name: string;
              keypad_battery_level?: string;
              lock_id: string;
              lock_name: string;
              model?: string;
          };
          avigilon_alta_metadata?: {
              entry_name: string;
              org_name: string;
              site_id: number;
              site_name: string;
              zone_id: number;
              zone_name: string;
          };
          brivo_metadata?: {
              device_name: string;
          };
          controlbyweb_metadata?: {
              device_id: string;
              device_name: string;
              relay_name: null | string;
          };
          dormakaba_oracode_metadata?: {
              device_id?: number;
              door_id: number;
              door_name: string;
              iana_timezone?: string;
              predefined_time_slots?: {
                  check_in_time: string;
                  check_out_time: string;
                  dormakaba_oracode_user_level_id: string;
                  ext_dormakaba_oracode_user_level_prefix: number;
                  is_24_hour: boolean;
                  is_biweekly_mode: boolean;
                  is_master: boolean;
                  is_one_shot: boolean;
                  name: string;
                  prefix: number;
              }[];
              site_id: number;
              site_name: string;
          };
          ecobee_metadata?: {
              device_name: string;
              ecobee_device_id: string;
          };
          four_suites_metadata?: {
              device_id: number;
              device_name: string;
              reclose_delay_in_seconds: number;
          };
          genie_metadata?: {
              device_name: string;
              door_name: string;
          };
          honeywell_metadata?: {
              device_name: string;
              honeywell_device_id: string;
          };
          hubitat_metadata?: {
              device_id: string;
              device_label: string;
              device_name: string;
          };
          igloo_metadata?: {
              bridge_id: string;
              device_id: string;
              model?: string;
          };
          igloohome_metadata?: {
              bridge_id?: string;
              bridge_name?: string;
              device_id: string;
              device_name: string;
          };
          kwikset_metadata?: {
              device_id: string;
              device_name: string;
              model_number: string;
          };
          lockly_metadata?: {
              device_id: string;
              device_name: string;
              model?: string;
          };
          minut_metadata?: {
              device_id: string;
              device_name: string;
              latest_sensor_values: {
                  accelerometer_z: {
                      time: string;
                      value: number;
                  };
                  humidity: {
                      time: string;
                      value: number;
                  };
                  pressure: {
                      time: string;
                      value: number;
                  };
                  sound: {
                      time: string;
                      value: number;
                  };
                  temperature: {
                      time: string;
                      value: number;
                  };
              };
          };
          nest_metadata?: {
              custom_name: string;
              device_name: string;
              nest_device_id: string;
          };
          noiseaware_metadata?: {
              device_id: string;
              device_model: "indoor" | "outdoor";
              device_name: string;
              noise_level_decibel: number;
              noise_level_nrs: number;
          };
          nuki_metadata?: {
              device_id: string;
              device_name: string;
              keypad_battery_critical?: boolean;
          };
          salto_metadata?: {
              battery_level: string;
              customer_reference: string;
              lock_id: string;
              lock_type: string;
              locked_state: string;
              model?: string;
          };
          schlage_metadata?: {
              access_code_length: null | number;
              device_id: string;
              device_name: string;
              model?: string;
          };
          seam_bridge_metadata?: {
              device_num: number;
              name: string;
              unlock_method?: "doorking" | "bridge";
          };
          smartthings_metadata?: {
              device_id: string;
              device_name: string;
              location_id?: string;
              model?: string;
          };
          tedee_metadata?: {
              bridge_id: number;
              bridge_name: string;
              device_id: number;
              device_model: string;
              device_name: string;
              serial_number: string;
          };
          ttlock_metadata?: {
              lock_alias: string;
              lock_id: number;
          };
          two_n_metadata?: {
              device_id: number;
              device_name: string;
          };
          wyze_metadata?: {
              device_id: string;
              device_info_model: string;
              device_name: string;
              product_model: string;
              product_name: string;
              product_type: string;
          };
      } & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...);
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

listDeviceProviders

• listDeviceProviders(body?): Promise<{
      device_provider_name: string;
      display_name: string;
      image_url: string;
      provider_categories: ("stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems")[];
  }[]>

• Parameters

  • Optional body: {
        provider_category?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems";
    }

    • Optional provider_category?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems"

  Returns Promise<{
      device_provider_name: string;
      display_name: string;
      image_url: string;
      provider_categories: ("stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems")[];
  }[]>

update

• update(body?): Promise<void>

• Parameters

  • Optional body: {
        custom_metadata?: Record<string, null | string | boolean>;
        device_id: string;
        is_managed?: boolean;
        name?: null | string;
        properties?: {
            name?: null | string;
        };
    }

    • Optional custom_metadata?: Record<string, null | string | boolean>

    • device_id: string

    • Optional is_managed?: boolean

    • Optional name?: null | string

    • Optional properties?: {
          name?: null | string;
      }

      • Optional name?: null | string

  Returns Promise<void>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpDevices

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpDevices

Static fromClient

• fromClient(client, options?): SeamHttpDevices

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpDevices

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpDevices

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpDevices

Static fromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpDevices

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpDevices

Static fromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpDevices

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpDevices

Static fromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpDevices>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpDevices>