Class SeamHttpLocks

constructor

• new SeamHttpLocks(apiKeyOrOptions?): SeamHttpLocks

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpLocks

client

Readonlydefaults

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      device: {
          can_hvac_cool?: boolean;
          can_hvac_heat?: boolean;
          can_hvac_heat_cool?: boolean;
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_connection?: boolean;
          can_simulate_disconnection?: boolean;
          can_simulate_removal?: boolean;
          can_turn_off_hvac?: boolean;
          capabilities_supported: (
              | "access_code"
              | "phone"
              | "lock"
              | "noise_detection"
              | "thermostat"
              | "battery")[];
          connected_account_id: string;
          created_at: string;
          custom_metadata: Record<string, 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"
              | "akiles_lock"
              | "noiseaware_activity_zone"
              | "minut_sensor"
              | "ecobee_thermostat"
              | "nest_thermostat"
              | "honeywell_resideo_thermostat"
              | "ios_phone"
              | "android_phone"
              | "visionline_encoder"
              | "assa_abloy_vostio_encoder";
          display_name: string;
          errors: ({
              error_code: string;
              is_device_error: true;
              message: string;
          } | {
              error_code: string;
              is_connected_account_error: true;
              message: string;
          })[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              accessory_keypad?: {
                  battery?: {
                      level: ...;
                  };
                  is_connected: boolean;
              };
              appearance: {
                  name: string;
              };
              battery?: {
                  level: number;
                  status:
                      | "low"
                      | "full"
                      | "critical"
                      | "good";
              };
              battery_level?: number;
              currently_triggering_noise_threshold_ids?: string[];
              has_direct_power?: boolean;
              image_alt_text?: string;
              image_url?: string;
              manufacturer?: string;
              model: {
                  accessory_keypad_supported?: boolean;
                  can_connect_accessory_keypad?: boolean;
                  display_name: string;
                  has_built_in_keypad?: boolean;
                  manufacturer_display_name: string;
                  offline_access_codes_supported?: boolean;
                  online_access_codes_supported?: boolean;
              };
              name: string;
              noise_level_decibels?: number;
              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: ...;
                      is_active: ...;
                  }[];
                  has_active_endpoint: boolean;
              };
          } & {
              akiles_metadata?: {
                  _member_group_id?: string;
                  gadget_id: string;
                  gadget_name: string;
                  product_name: string;
              };
              assa_abloy_vostio_metadata?: {
                  encoder_name: string;
              };
              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;
                  entry_relays_total_count: number;
                  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?: string | number;
                  door_id?: number;
                  door_is_wireless: boolean;
                  door_name: string;
                  iana_timezone?: string;
                  predefined_time_slots?: (...)[];
                  site_id: null | 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_resideo_metadata?: {
                  device_name: string;
                  honeywell_resideo_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;
                  keypad_id?: 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: ...;
                          value: ...;
                      };
                      humidity: {
                          time: ...;
                          value: ...;
                      };
                      pressure: {
                          time: ...;
                          value: ...;
                      };
                      sound: {
                          time: ...;
                          value: ...;
                      };
                      temperature: {
                          time: ...;
                          value: ...;
                      };
                  };
              };
              nest_metadata?: {
                  custom_name: string;
                  device_name: string;
                  display_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_2_paired?: boolean;
                  keypad_battery_critical?: boolean;
                  keypad_paired?: boolean;
              };
              salto_ks_metadata?: {
                  battery_level: string;
                  customer_reference: string;
                  lock_id: string;
                  lock_type: string;
                  locked_state: string;
                  model?: string;
              };
              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?: "bridge" | "doorking";
              };
              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;
                  keypad_id?: number;
                  serial_number: string;
              };
              ttlock_metadata?: {
                  feature_value: string;
                  features: {
                      incomplete_keyboard_passcode: boolean;
                      lock_command: boolean;
                      passcode: boolean;
                      passcode_management: boolean;
                      unlock_via_gateway: boolean;
                  };
                  has_gateway?: boolean;
                  lock_alias: string;
                  lock_id: number;
                  wireless_keypads?: (...)[];
              };
              two_n_metadata?: {
                  device_id: number;
                  device_name: string;
              };
              visionline_metadata?: {
                  encoder_id: string;
              };
              wyze_metadata?: {
                  device_id: string;
                  device_info_model: string;
                  device_name: string;
                  keypad_uuid?: string;
                  locker_status_hardlock?: number;
                  product_model: string;
                  product_name: string;
                  product_type: string;
              };
          } & {
              _experimental_supported_code_from_access_codes_lengths?: number[];
              code_constraints?: ({
                  constraint_type: ...;
              } | {
                  constraint_type: ...;
                  max_length?: ...;
                  min_length?: ...;
              })[];
              door_open?: boolean;
              has_native_entry_events?: boolean;
              keypad_battery?: {
                  level: number;
              };
              locked?: boolean;
              max_active_codes_supported?: number;
              supported_code_lengths?: number[];
              supports_backup_access_code_pool?: boolean;
          } & {
              active_thermostat_schedule?: null | {
                  climate_preset_key: string;
                  created_at: string;
                  device_id: string;
                  ends_at: string;
                  errors?: any;
                  max_override_period_minutes: number;
                  name?: string;
                  starts_at: string;
                  thermostat_schedule_id: string;
              };
              available_climate_presets?: {
                  can_delete: boolean;
                  can_edit: boolean;
                  climate_preset_key: string;
                  cooling_set_point_celsius?: (...) | (...);
                  cooling_set_point_fahrenheit?: (...) | (...);
                  display_name: string;
                  fan_mode_setting?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  heating_set_point_celsius?: (...) | (...);
                  heating_set_point_fahrenheit?: (...) | (...);
                  hvac_mode_setting?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  manual_override_allowed: boolean;
                  name?: (...) | (...) | (...);
              }[];
              available_fan_mode_settings?: ("auto" | "on" | "circulate")[];
              available_hvac_mode_settings?: (
                  | "off"
                  | "heat"
                  | "cool"
                  | "heat_cool")[];
              current_climate_setting?: {
                  can_delete?: boolean;
                  can_edit?: boolean;
                  climate_preset_key?: string;
                  cooling_set_point_celsius?: number;
                  cooling_set_point_fahrenheit?: number;
                  display_name?: string;
                  fan_mode_setting?: "auto" | "on" | "circulate";
                  heating_set_point_celsius?: number;
                  heating_set_point_fahrenheit?: number;
                  hvac_mode_setting?:
                      | "off"
                      | "heat"
                      | "cool"
                      | "heat_cool";
                  manual_override_allowed?: boolean;
                  name?: null | string;
              };
              default_climate_setting?: {
                  can_delete?: boolean;
                  can_edit?: boolean;
                  climate_preset_key?: string;
                  cooling_set_point_celsius?: number;
                  cooling_set_point_fahrenheit?: number;
                  display_name?: string;
                  fan_mode_setting?: "auto" | "on" | "circulate";
                  heating_set_point_celsius?: number;
                  heating_set_point_fahrenheit?: number;
                  hvac_mode_setting?:
                      | "off"
                      | "heat"
                      | "cool"
                      | "heat_cool";
                  manual_override_allowed?: boolean;
                  name?: null | string;
              };
              fallback_climate_preset_key?: null | string;
              fan_mode_setting?: "auto" | "on" | "circulate";
              is_cooling?: boolean;
              is_fan_running?: boolean;
              is_heating?: boolean;
              is_temporary_manual_override_active?: boolean;
              max_cooling_set_point_celsius?: number;
              max_cooling_set_point_fahrenheit?: number;
              max_heating_set_point_celsius?: number;
              max_heating_set_point_fahrenheit?: number;
              min_cooling_set_point_celsius?: number;
              min_cooling_set_point_fahrenheit?: number;
              min_heating_cooling_delta_celsius?: number;
              min_heating_cooling_delta_fahrenheit?: number;
              min_heating_set_point_celsius?: number;
              min_heating_set_point_fahrenheit?: number;
              relative_humidity?: number;
              temperature_celsius?: number;
              temperature_fahrenheit?: number;
              temperature_threshold?: {
                  lower_limit_celsius: null | number;
                  lower_limit_fahrenheit: null | number;
                  upper_limit_celsius: null | number;
                  upper_limit_fahrenheit: null | number;
              };
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      };
      lock: {
          can_hvac_cool?: boolean;
          can_hvac_heat?: boolean;
          can_hvac_heat_cool?: boolean;
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_connection?: boolean;
          can_simulate_disconnection?: boolean;
          can_simulate_removal?: boolean;
          can_turn_off_hvac?: boolean;
          capabilities_supported: (
              | "access_code"
              | "phone"
              | "lock"
              | "noise_detection"
              | "thermostat"
              | "battery")[];
          connected_account_id: string;
          created_at: string;
          custom_metadata: Record<string, 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"
              | "akiles_lock"
              | "noiseaware_activity_zone"
              | "minut_sensor"
              | "ecobee_thermostat"
              | "nest_thermostat"
              | "honeywell_resideo_thermostat"
              | "ios_phone"
              | "android_phone"
              | "visionline_encoder"
              | "assa_abloy_vostio_encoder";
          display_name: string;
          errors: ({
              error_code: string;
              is_device_error: true;
              message: string;
          } | {
              error_code: string;
              is_connected_account_error: true;
              message: string;
          })[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              accessory_keypad?: {
                  battery?: {
                      level: ...;
                  };
                  is_connected: boolean;
              };
              appearance: {
                  name: string;
              };
              battery?: {
                  level: number;
                  status:
                      | "low"
                      | "full"
                      | "critical"
                      | "good";
              };
              battery_level?: number;
              currently_triggering_noise_threshold_ids?: string[];
              has_direct_power?: boolean;
              image_alt_text?: string;
              image_url?: string;
              manufacturer?: string;
              model: {
                  accessory_keypad_supported?: boolean;
                  can_connect_accessory_keypad?: boolean;
                  display_name: string;
                  has_built_in_keypad?: boolean;
                  manufacturer_display_name: string;
                  offline_access_codes_supported?: boolean;
                  online_access_codes_supported?: boolean;
              };
              name: string;
              noise_level_decibels?: number;
              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: ...;
                      is_active: ...;
                  }[];
                  has_active_endpoint: boolean;
              };
          } & {
              akiles_metadata?: {
                  _member_group_id?: string;
                  gadget_id: string;
                  gadget_name: string;
                  product_name: string;
              };
              assa_abloy_vostio_metadata?: {
                  encoder_name: string;
              };
              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;
                  entry_relays_total_count: number;
                  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?: string | number;
                  door_id?: number;
                  door_is_wireless: boolean;
                  door_name: string;
                  iana_timezone?: string;
                  predefined_time_slots?: (...)[];
                  site_id: null | 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_resideo_metadata?: {
                  device_name: string;
                  honeywell_resideo_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;
                  keypad_id?: 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: ...;
                          value: ...;
                      };
                      humidity: {
                          time: ...;
                          value: ...;
                      };
                      pressure: {
                          time: ...;
                          value: ...;
                      };
                      sound: {
                          time: ...;
                          value: ...;
                      };
                      temperature: {
                          time: ...;
                          value: ...;
                      };
                  };
              };
              nest_metadata?: {
                  custom_name: string;
                  device_name: string;
                  display_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_2_paired?: boolean;
                  keypad_battery_critical?: boolean;
                  keypad_paired?: boolean;
              };
              salto_ks_metadata?: {
                  battery_level: string;
                  customer_reference: string;
                  lock_id: string;
                  lock_type: string;
                  locked_state: string;
                  model?: string;
              };
              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?: "bridge" | "doorking";
              };
              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;
                  keypad_id?: number;
                  serial_number: string;
              };
              ttlock_metadata?: {
                  feature_value: string;
                  features: {
                      incomplete_keyboard_passcode: boolean;
                      lock_command: boolean;
                      passcode: boolean;
                      passcode_management: boolean;
                      unlock_via_gateway: boolean;
                  };
                  has_gateway?: boolean;
                  lock_alias: string;
                  lock_id: number;
                  wireless_keypads?: (...)[];
              };
              two_n_metadata?: {
                  device_id: number;
                  device_name: string;
              };
              visionline_metadata?: {
                  encoder_id: string;
              };
              wyze_metadata?: {
                  device_id: string;
                  device_info_model: string;
                  device_name: string;
                  keypad_uuid?: string;
                  locker_status_hardlock?: number;
                  product_model: string;
                  product_name: string;
                  product_type: string;
              };
          } & {
              _experimental_supported_code_from_access_codes_lengths?: number[];
              code_constraints?: ({
                  constraint_type: ...;
              } | {
                  constraint_type: ...;
                  max_length?: ...;
                  min_length?: ...;
              })[];
              door_open?: boolean;
              has_native_entry_events?: boolean;
              keypad_battery?: {
                  level: number;
              };
              locked?: boolean;
              max_active_codes_supported?: number;
              supported_code_lengths?: number[];
              supports_backup_access_code_pool?: boolean;
          } & {
              active_thermostat_schedule?: null | {
                  climate_preset_key: string;
                  created_at: string;
                  device_id: string;
                  ends_at: string;
                  errors?: any;
                  max_override_period_minutes: number;
                  name?: string;
                  starts_at: string;
                  thermostat_schedule_id: string;
              };
              available_climate_presets?: {
                  can_delete: boolean;
                  can_edit: boolean;
                  climate_preset_key: string;
                  cooling_set_point_celsius?: (...) | (...);
                  cooling_set_point_fahrenheit?: (...) | (...);
                  display_name: string;
                  fan_mode_setting?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  heating_set_point_celsius?: (...) | (...);
                  heating_set_point_fahrenheit?: (...) | (...);
                  hvac_mode_setting?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  manual_override_allowed: boolean;
                  name?: (...) | (...) | (...);
              }[];
              available_fan_mode_settings?: ("auto" | "on" | "circulate")[];
              available_hvac_mode_settings?: (
                  | "off"
                  | "heat"
                  | "cool"
                  | "heat_cool")[];
              current_climate_setting?: {
                  can_delete?: boolean;
                  can_edit?: boolean;
                  climate_preset_key?: string;
                  cooling_set_point_celsius?: number;
                  cooling_set_point_fahrenheit?: number;
                  display_name?: string;
                  fan_mode_setting?: "auto" | "on" | "circulate";
                  heating_set_point_celsius?: number;
                  heating_set_point_fahrenheit?: number;
                  hvac_mode_setting?:
                      | "off"
                      | "heat"
                      | "cool"
                      | "heat_cool";
                  manual_override_allowed?: boolean;
                  name?: null | string;
              };
              default_climate_setting?: {
                  can_delete?: boolean;
                  can_edit?: boolean;
                  climate_preset_key?: string;
                  cooling_set_point_celsius?: number;
                  cooling_set_point_fahrenheit?: number;
                  display_name?: string;
                  fan_mode_setting?: "auto" | "on" | "circulate";
                  heating_set_point_celsius?: number;
                  heating_set_point_fahrenheit?: number;
                  hvac_mode_setting?:
                      | "off"
                      | "heat"
                      | "cool"
                      | "heat_cool";
                  manual_override_allowed?: boolean;
                  name?: null | string;
              };
              fallback_climate_preset_key?: null | string;
              fan_mode_setting?: "auto" | "on" | "circulate";
              is_cooling?: boolean;
              is_fan_running?: boolean;
              is_heating?: boolean;
              is_temporary_manual_override_active?: boolean;
              max_cooling_set_point_celsius?: number;
              max_cooling_set_point_fahrenheit?: number;
              max_heating_set_point_celsius?: number;
              max_heating_set_point_fahrenheit?: number;
              min_cooling_set_point_celsius?: number;
              min_cooling_set_point_fahrenheit?: number;
              min_heating_cooling_delta_celsius?: number;
              min_heating_cooling_delta_fahrenheit?: number;
              min_heating_set_point_celsius?: number;
              min_heating_set_point_fahrenheit?: number;
              relative_humidity?: number;
              temperature_celsius?: number;
              temperature_fahrenheit?: number;
              temperature_threshold?: {
                  lower_limit_celsius: null | number;
                  lower_limit_fahrenheit: null | number;
                  upper_limit_celsius: null | number;
                  upper_limit_fahrenheit: null | number;
              };
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      };
  }>, "lock" | "device">, "device">

• Parameters

  • Optionalbody: {
        device_id?: string;
        name?: string;
    }

    • Optionaldevice_id?: string

    • Optionalname?: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      device: {
          can_hvac_cool?: boolean;
          can_hvac_heat?: boolean;
          can_hvac_heat_cool?: boolean;
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_connection?: boolean;
          can_simulate_disconnection?: boolean;
          can_simulate_removal?: boolean;
          can_turn_off_hvac?: boolean;
          capabilities_supported: (
              | "access_code"
              | "phone"
              | "lock"
              | "noise_detection"
              | "thermostat"
              | "battery")[];
          connected_account_id: string;
          created_at: string;
          custom_metadata: Record<string, 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"
              | "akiles_lock"
              | "noiseaware_activity_zone"
              | "minut_sensor"
              | "ecobee_thermostat"
              | "nest_thermostat"
              | "honeywell_resideo_thermostat"
              | "ios_phone"
              | "android_phone"
              | "visionline_encoder"
              | "assa_abloy_vostio_encoder";
          display_name: string;
          errors: ({
              error_code: string;
              is_device_error: true;
              message: string;
          } | {
              error_code: string;
              is_connected_account_error: true;
              message: string;
          })[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              accessory_keypad?: {
                  battery?: {
                      level: ...;
                  };
                  is_connected: boolean;
              };
              appearance: {
                  name: string;
              };
              battery?: {
                  level: number;
                  status:
                      | "low"
                      | "full"
                      | "critical"
                      | "good";
              };
              battery_level?: number;
              currently_triggering_noise_threshold_ids?: string[];
              has_direct_power?: boolean;
              image_alt_text?: string;
              image_url?: string;
              manufacturer?: string;
              model: {
                  accessory_keypad_supported?: boolean;
                  can_connect_accessory_keypad?: boolean;
                  display_name: string;
                  has_built_in_keypad?: boolean;
                  manufacturer_display_name: string;
                  offline_access_codes_supported?: boolean;
                  online_access_codes_supported?: boolean;
              };
              name: string;
              noise_level_decibels?: number;
              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: ...;
                      is_active: ...;
                  }[];
                  has_active_endpoint: boolean;
              };
          } & {
              akiles_metadata?: {
                  _member_group_id?: string;
                  gadget_id: string;
                  gadget_name: string;
                  product_name: string;
              };
              assa_abloy_vostio_metadata?: {
                  encoder_name: string;
              };
              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;
                  entry_relays_total_count: number;
                  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?: string | number;
                  door_id?: number;
                  door_is_wireless: boolean;
                  door_name: string;
                  iana_timezone?: string;
                  predefined_time_slots?: (...)[];
                  site_id: null | 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_resideo_metadata?: {
                  device_name: string;
                  honeywell_resideo_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;
                  keypad_id?: 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: ...;
                          value: ...;
                      };
                      humidity: {
                          time: ...;
                          value: ...;
                      };
                      pressure: {
                          time: ...;
                          value: ...;
                      };
                      sound: {
                          time: ...;
                          value: ...;
                      };
                      temperature: {
                          time: ...;
                          value: ...;
                      };
                  };
              };
              nest_metadata?: {
                  custom_name: string;
                  device_name: string;
                  display_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_2_paired?: boolean;
                  keypad_battery_critical?: boolean;
                  keypad_paired?: boolean;
              };
              salto_ks_metadata?: {
                  battery_level: string;
                  customer_reference: string;
                  lock_id: string;
                  lock_type: string;
                  locked_state: string;
                  model?: string;
              };
              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?: "bridge" | "doorking";
              };
              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;
                  keypad_id?: number;
                  serial_number: string;
              };
              ttlock_metadata?: {
                  feature_value: string;
                  features: {
                      incomplete_keyboard_passcode: boolean;
                      lock_command: boolean;
                      passcode: boolean;
                      passcode_management: boolean;
                      unlock_via_gateway: boolean;
                  };
                  has_gateway?: boolean;
                  lock_alias: string;
                  lock_id: number;
                  wireless_keypads?: (...)[];
              };
              two_n_metadata?: {
                  device_id: number;
                  device_name: string;
              };
              visionline_metadata?: {
                  encoder_id: string;
              };
              wyze_metadata?: {
                  device_id: string;
                  device_info_model: string;
                  device_name: string;
                  keypad_uuid?: string;
                  locker_status_hardlock?: number;
                  product_model: string;
                  product_name: string;
                  product_type: string;
              };
          } & {
              _experimental_supported_code_from_access_codes_lengths?: number[];
              code_constraints?: ({
                  constraint_type: ...;
              } | {
                  constraint_type: ...;
                  max_length?: ...;
                  min_length?: ...;
              })[];
              door_open?: boolean;
              has_native_entry_events?: boolean;
              keypad_battery?: {
                  level: number;
              };
              locked?: boolean;
              max_active_codes_supported?: number;
              supported_code_lengths?: number[];
              supports_backup_access_code_pool?: boolean;
          } & {
              active_thermostat_schedule?: null | {
                  climate_preset_key: string;
                  created_at: string;
                  device_id: string;
                  ends_at: string;
                  errors?: any;
                  max_override_period_minutes: number;
                  name?: string;
                  starts_at: string;
                  thermostat_schedule_id: string;
              };
              available_climate_presets?: {
                  can_delete: boolean;
                  can_edit: boolean;
                  climate_preset_key: string;
                  cooling_set_point_celsius?: (...) | (...);
                  cooling_set_point_fahrenheit?: (...) | (...);
                  display_name: string;
                  fan_mode_setting?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  heating_set_point_celsius?: (...) | (...);
                  heating_set_point_fahrenheit?: (...) | (...);
                  hvac_mode_setting?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  manual_override_allowed: boolean;
                  name?: (...) | (...) | (...);
              }[];
              available_fan_mode_settings?: ("auto" | "on" | "circulate")[];
              available_hvac_mode_settings?: (
                  | "off"
                  | "heat"
                  | "cool"
                  | "heat_cool")[];
              current_climate_setting?: {
                  can_delete?: boolean;
                  can_edit?: boolean;
                  climate_preset_key?: string;
                  cooling_set_point_celsius?: number;
                  cooling_set_point_fahrenheit?: number;
                  display_name?: string;
                  fan_mode_setting?: "auto" | "on" | "circulate";
                  heating_set_point_celsius?: number;
                  heating_set_point_fahrenheit?: number;
                  hvac_mode_setting?:
                      | "off"
                      | "heat"
                      | "cool"
                      | "heat_cool";
                  manual_override_allowed?: boolean;
                  name?: null | string;
              };
              default_climate_setting?: {
                  can_delete?: boolean;
                  can_edit?: boolean;
                  climate_preset_key?: string;
                  cooling_set_point_celsius?: number;
                  cooling_set_point_fahrenheit?: number;
                  display_name?: string;
                  fan_mode_setting?: "auto" | "on" | "circulate";
                  heating_set_point_celsius?: number;
                  heating_set_point_fahrenheit?: number;
                  hvac_mode_setting?:
                      | "off"
                      | "heat"
                      | "cool"
                      | "heat_cool";
                  manual_override_allowed?: boolean;
                  name?: null | string;
              };
              fallback_climate_preset_key?: null | string;
              fan_mode_setting?: "auto" | "on" | "circulate";
              is_cooling?: boolean;
              is_fan_running?: boolean;
              is_heating?: boolean;
              is_temporary_manual_override_active?: boolean;
              max_cooling_set_point_celsius?: number;
              max_cooling_set_point_fahrenheit?: number;
              max_heating_set_point_celsius?: number;
              max_heating_set_point_fahrenheit?: number;
              min_cooling_set_point_celsius?: number;
              min_cooling_set_point_fahrenheit?: number;
              min_heating_cooling_delta_celsius?: number;
              min_heating_cooling_delta_fahrenheit?: number;
              min_heating_set_point_celsius?: number;
              min_heating_set_point_fahrenheit?: number;
              relative_humidity?: number;
              temperature_celsius?: number;
              temperature_fahrenheit?: number;
              temperature_threshold?: {
                  lower_limit_celsius: null | number;
                  lower_limit_fahrenheit: null | number;
                  upper_limit_celsius: null | number;
                  upper_limit_fahrenheit: null | number;
              };
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      };
      lock: {
          can_hvac_cool?: boolean;
          can_hvac_heat?: boolean;
          can_hvac_heat_cool?: boolean;
          can_program_offline_access_codes?: boolean;
          can_program_online_access_codes?: boolean;
          can_remotely_lock?: boolean;
          can_remotely_unlock?: boolean;
          can_simulate_connection?: boolean;
          can_simulate_disconnection?: boolean;
          can_simulate_removal?: boolean;
          can_turn_off_hvac?: boolean;
          capabilities_supported: (
              | "access_code"
              | "phone"
              | "lock"
              | "noise_detection"
              | "thermostat"
              | "battery")[];
          connected_account_id: string;
          created_at: string;
          custom_metadata: Record<string, 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"
              | "akiles_lock"
              | "noiseaware_activity_zone"
              | "minut_sensor"
              | "ecobee_thermostat"
              | "nest_thermostat"
              | "honeywell_resideo_thermostat"
              | "ios_phone"
              | "android_phone"
              | "visionline_encoder"
              | "assa_abloy_vostio_encoder";
          display_name: string;
          errors: ({
              error_code: string;
              is_device_error: true;
              message: string;
          } | {
              error_code: string;
              is_connected_account_error: true;
              message: string;
          })[];
          is_managed: true;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          nickname?: string;
          properties: {
              accessory_keypad?: {
                  battery?: {
                      level: ...;
                  };
                  is_connected: boolean;
              };
              appearance: {
                  name: string;
              };
              battery?: {
                  level: number;
                  status:
                      | "low"
                      | "full"
                      | "critical"
                      | "good";
              };
              battery_level?: number;
              currently_triggering_noise_threshold_ids?: string[];
              has_direct_power?: boolean;
              image_alt_text?: string;
              image_url?: string;
              manufacturer?: string;
              model: {
                  accessory_keypad_supported?: boolean;
                  can_connect_accessory_keypad?: boolean;
                  display_name: string;
                  has_built_in_keypad?: boolean;
                  manufacturer_display_name: string;
                  offline_access_codes_supported?: boolean;
                  online_access_codes_supported?: boolean;
              };
              name: string;
              noise_level_decibels?: number;
              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: ...;
                      is_active: ...;
                  }[];
                  has_active_endpoint: boolean;
              };
          } & {
              akiles_metadata?: {
                  _member_group_id?: string;
                  gadget_id: string;
                  gadget_name: string;
                  product_name: string;
              };
              assa_abloy_vostio_metadata?: {
                  encoder_name: string;
              };
              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;
                  entry_relays_total_count: number;
                  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?: string | number;
                  door_id?: number;
                  door_is_wireless: boolean;
                  door_name: string;
                  iana_timezone?: string;
                  predefined_time_slots?: (...)[];
                  site_id: null | 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_resideo_metadata?: {
                  device_name: string;
                  honeywell_resideo_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;
                  keypad_id?: 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: ...;
                          value: ...;
                      };
                      humidity: {
                          time: ...;
                          value: ...;
                      };
                      pressure: {
                          time: ...;
                          value: ...;
                      };
                      sound: {
                          time: ...;
                          value: ...;
                      };
                      temperature: {
                          time: ...;
                          value: ...;
                      };
                  };
              };
              nest_metadata?: {
                  custom_name: string;
                  device_name: string;
                  display_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_2_paired?: boolean;
                  keypad_battery_critical?: boolean;
                  keypad_paired?: boolean;
              };
              salto_ks_metadata?: {
                  battery_level: string;
                  customer_reference: string;
                  lock_id: string;
                  lock_type: string;
                  locked_state: string;
                  model?: string;
              };
              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?: "bridge" | "doorking";
              };
              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;
                  keypad_id?: number;
                  serial_number: string;
              };
              ttlock_metadata?: {
                  feature_value: string;
                  features: {
                      incomplete_keyboard_passcode: boolean;
                      lock_command: boolean;
                      passcode: boolean;
                      passcode_management: boolean;
                      unlock_via_gateway: boolean;
                  };
                  has_gateway?: boolean;
                  lock_alias: string;
                  lock_id: number;
                  wireless_keypads?: (...)[];
              };
              two_n_metadata?: {
                  device_id: number;
                  device_name: string;
              };
              visionline_metadata?: {
                  encoder_id: string;
              };
              wyze_metadata?: {
                  device_id: string;
                  device_info_model: string;
                  device_name: string;
                  keypad_uuid?: string;
                  locker_status_hardlock?: number;
                  product_model: string;
                  product_name: string;
                  product_type: string;
              };
          } & {
              _experimental_supported_code_from_access_codes_lengths?: number[];
              code_constraints?: ({
                  constraint_type: ...;
              } | {
                  constraint_type: ...;
                  max_length?: ...;
                  min_length?: ...;
              })[];
              door_open?: boolean;
              has_native_entry_events?: boolean;
              keypad_battery?: {
                  level: number;
              };
              locked?: boolean;
              max_active_codes_supported?: number;
              supported_code_lengths?: number[];
              supports_backup_access_code_pool?: boolean;
          } & {
              active_thermostat_schedule?: null | {
                  climate_preset_key: string;
                  created_at: string;
                  device_id: string;
                  ends_at: string;
                  errors?: any;
                  max_override_period_minutes: number;
                  name?: string;
                  starts_at: string;
                  thermostat_schedule_id: string;
              };
              available_climate_presets?: {
                  can_delete: boolean;
                  can_edit: boolean;
                  climate_preset_key: string;
                  cooling_set_point_celsius?: (...) | (...);
                  cooling_set_point_fahrenheit?: (...) | (...);
                  display_name: string;
                  fan_mode_setting?:
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  heating_set_point_celsius?: (...) | (...);
                  heating_set_point_fahrenheit?: (...) | (...);
                  hvac_mode_setting?:
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                  manual_override_allowed: boolean;
                  name?: (...) | (...) | (...);
              }[];
              available_fan_mode_settings?: ("auto" | "on" | "circulate")[];
              available_hvac_mode_settings?: (
                  | "off"
                  | "heat"
                  | "cool"
                  | "heat_cool")[];
              current_climate_setting?: {
                  can_delete?: boolean;
                  can_edit?: boolean;
                  climate_preset_key?: string;
                  cooling_set_point_celsius?: number;
                  cooling_set_point_fahrenheit?: number;
                  display_name?: string;
                  fan_mode_setting?: "auto" | "on" | "circulate";
                  heating_set_point_celsius?: number;
                  heating_set_point_fahrenheit?: number;
                  hvac_mode_setting?:
                      | "off"
                      | "heat"
                      | "cool"
                      | "heat_cool";
                  manual_override_allowed?: boolean;
                  name?: null | string;
              };
              default_climate_setting?: {
                  can_delete?: boolean;
                  can_edit?: boolean;
                  climate_preset_key?: string;
                  cooling_set_point_celsius?: number;
                  cooling_set_point_fahrenheit?: number;
                  display_name?: string;
                  fan_mode_setting?: "auto" | "on" | "circulate";
                  heating_set_point_celsius?: number;
                  heating_set_point_fahrenheit?: number;
                  hvac_mode_setting?:
                      | "off"
                      | "heat"
                      | "cool"
                      | "heat_cool";
                  manual_override_allowed?: boolean;
                  name?: null | string;
              };
              fallback_climate_preset_key?: null | string;
              fan_mode_setting?: "auto" | "on" | "circulate";
              is_cooling?: boolean;
              is_fan_running?: boolean;
              is_heating?: boolean;
              is_temporary_manual_override_active?: boolean;
              max_cooling_set_point_celsius?: number;
              max_cooling_set_point_fahrenheit?: number;
              max_heating_set_point_celsius?: number;
              max_heating_set_point_fahrenheit?: number;
              min_cooling_set_point_celsius?: number;
              min_cooling_set_point_fahrenheit?: number;
              min_heating_cooling_delta_celsius?: number;
              min_heating_cooling_delta_fahrenheit?: number;
              min_heating_set_point_celsius?: number;
              min_heating_set_point_fahrenheit?: number;
              relative_humidity?: number;
              temperature_celsius?: number;
              temperature_fahrenheit?: number;
              temperature_threshold?: {
                  lower_limit_celsius: null | number;
                  lower_limit_fahrenheit: null | number;
                  upper_limit_celsius: null | number;
                  upper_limit_fahrenheit: null | number;
              };
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      };
  }>, "lock" | "device">, "device">