Class SeamHttpDevicesUnmanaged

constructor

• new SeamHttpDevicesUnmanaged(apiKeyOrOptions?): SeamHttpDevicesUnmanaged

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpDevicesUnmanaged

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;
          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"
              | "tado_thermostat"
              | "ios_phone"
              | "android_phone";
          errors: ({
              error_code: string;
              is_device_error: true;
              message: string;
          } | {
              error_code: string;
              is_connected_account_error: true;
              message: string;
          })[];
          is_managed: false;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          properties: {
              accessory_keypad?: {
                  battery?: {
                      level: number;
                  };
                  is_connected: boolean;
              };
              battery?: {
                  level: number;
                  status:
                      | "low"
                      | "full"
                      | "critical"
                      | "good";
              };
              battery_level?: number;
              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;
              offline_access_codes_enabled?: boolean;
              online: boolean;
              online_access_codes_enabled?: boolean;
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      };
  }>, "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;
          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"
              | "tado_thermostat"
              | "ios_phone"
              | "android_phone";
          errors: ({
              error_code: string;
              is_device_error: true;
              message: string;
          } | {
              error_code: string;
              is_connected_account_error: true;
              message: string;
          })[];
          is_managed: false;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          properties: {
              accessory_keypad?: {
                  battery?: {
                      level: number;
                  };
                  is_connected: boolean;
              };
              battery?: {
                  level: number;
                  status:
                      | "low"
                      | "full"
                      | "critical"
                      | "good";
              };
              battery_level?: number;
              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;
              offline_access_codes_enabled?: boolean;
              online: boolean;
              online_access_codes_enabled?: boolean;
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      };
  }>, "device">, "device">

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      devices: {
          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;
          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"
              | "tado_thermostat"
              | "ios_phone"
              | "android_phone";
          errors: ({
              error_code: string;
              is_device_error: true;
              message: string;
          } | {
              error_code: string;
              is_connected_account_error: true;
              message: string;
          })[];
          is_managed: false;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          properties: {
              accessory_keypad?: {
                  battery?: {
                      level: ...;
                  };
                  is_connected: boolean;
              };
              battery?: {
                  level: number;
                  status:
                      | "low"
                      | "full"
                      | "critical"
                      | "good";
              };
              battery_level?: number;
              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;
              offline_access_codes_enabled?: boolean;
              online: boolean;
              online_access_codes_enabled?: boolean;
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
  }>, "devices">, "devices">

• Parameters

  • Optionalbody: {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: Date;
        custom_metadata_has?: Record<string, 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"
            | "akiles_lock"
            | "noiseaware_activity_zone"
            | "minut_sensor"
            | "ecobee_thermostat"
            | "nest_thermostat"
            | "honeywell_resideo_thermostat"
            | "tado_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"
            | "akiles_lock"
            | "noiseaware_activity_zone"
            | "minut_sensor"
            | "ecobee_thermostat"
            | "nest_thermostat"
            | "honeywell_resideo_thermostat"
            | "tado_thermostat"
            | "ios_phone"
            | "android_phone")[];
        exclude_if?: (
            | "can_remotely_unlock"
            | "can_remotely_lock"
            | "can_program_offline_access_codes"
            | "can_program_online_access_codes"
            | "can_hvac_heat"
            | "can_hvac_cool"
            | "can_hvac_heat_cool"
            | "can_turn_off_hvac"
            | "can_simulate_removal"
            | "can_simulate_connection"
            | "can_simulate_disconnection")[];
        include_if?: (
            | "can_remotely_unlock"
            | "can_remotely_lock"
            | "can_program_offline_access_codes"
            | "can_program_online_access_codes"
            | "can_hvac_heat"
            | "can_hvac_cool"
            | "can_hvac_heat_cool"
            | "can_turn_off_hvac"
            | "can_simulate_removal"
            | "can_simulate_connection"
            | "can_simulate_disconnection")[];
        limit?: number;
        manufacturer?:
            | "linear"
            | "unknown"
            | "doorking"
            | "akuvox"
            | "august"
            | "avigilon_alta"
            | "brivo"
            | "butterflymx"
            | "schlage"
            | "smartthings"
            | "yale"
            | "genie"
            | "salto"
            | "lockly"
            | "ttlock"
            | "nuki"
            | "igloo"
            | "kwikset"
            | "minut"
            | "controlbyweb"
            | "nest"
            | "igloohome"
            | "ecobee"
            | "hubitat"
            | "four_suites"
            | "dormakaba_oracode"
            | "wyze"
            | "tedee"
            | "honeywell_resideo"
            | "akiles"
            | "tado"
            | "seam"
            | "keywe"
            | "philia"
            | "samsung"
            | "two_n";
        user_identifier_key?: string;
    }

    • Optionalconnect_webview_id?: string

      ID of the Connect Webview by which to filter devices.

    • Optionalconnected_account_id?: string

      ID of the connected account by which to filter.

    • Optionalconnected_account_ids?: string[]

      Array of IDs of the connected accounts by which to filter devices.

    • Optionalcreated_before?: Date

      Date threshold for devices to return. If specified, returns only devices created before the specified date.

    • Optionalcustom_metadata_has?: Record<string, string | boolean>

      Set of key:value custom metadata pairs by which you want to filter devices.

    • Optionaldevice_ids?: string[]

      Array of device IDs by which to filter devices.

    • Optionaldevice_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"
          | "tado_thermostat"
          | "ios_phone"
          | "android_phone"

      Device type by which to filter devices.

    • Optionaldevice_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"
          | "akiles_lock"
          | "noiseaware_activity_zone"
          | "minut_sensor"
          | "ecobee_thermostat"
          | "nest_thermostat"
          | "honeywell_resideo_thermostat"
          | "tado_thermostat"
          | "ios_phone"
          | "android_phone")[]

      Array of device types by which to filter devices.

    • Optionalexclude_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection")[]

    • Optionalinclude_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection")[]

    • Optionallimit?: number

      Numerical limit on the number of devices to return.

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

      Manufacturer by which to filter devices.

    • Optionaluser_identifier_key?: string

      Your own internal user ID for the user by which to filter devices.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      devices: {
          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;
          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"
              | "tado_thermostat"
              | "ios_phone"
              | "android_phone";
          errors: ({
              error_code: string;
              is_device_error: true;
              message: string;
          } | {
              error_code: string;
              is_connected_account_error: true;
              message: string;
          })[];
          is_managed: false;
          location: null | {
              location_name?: string;
              timezone?: string;
          };
          properties: {
              accessory_keypad?: {
                  battery?: {
                      level: ...;
                  };
                  is_connected: boolean;
              };
              battery?: {
                  level: number;
                  status:
                      | "low"
                      | "full"
                      | "critical"
                      | "good";
              };
              battery_level?: number;
              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;
              offline_access_codes_enabled?: boolean;
              online: boolean;
              online_access_codes_enabled?: boolean;
          };
          warnings: {
              message: string;
              warning_code: string;
          }[];
          workspace_id: string;
      }[];
  }>, "devices">, "devices">

update

• update(body?): SeamHttpRequest<void, undefined>

• Parameters

  • Optionalbody: {
        device_id: string;
        is_managed: true;
    }

    • device_id: string

    • is_managed: true

  Returns SeamHttpRequest<void, undefined>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpDevicesUnmanaged

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

StaticfromClient

• fromClient(client, options?): SeamHttpDevicesUnmanaged

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpDevicesUnmanaged

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpDevicesUnmanaged>