Class SeamHttpDevicesUnmanaged

constructor

• new SeamHttpDevicesUnmanaged(apiKeyOrOptions?): SeamHttpDevicesUnmanaged

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpDevicesUnmanaged

client

Readonly defaults

get

• get(body?): Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      device_id: string;
      device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: false;
      properties: {
          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;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }>

• Parameters

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

    • Optional device_id?: string

    • Optional name?: string

  Returns Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      device_id: string;
      device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: false;
      properties: {
          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;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }>

list

• list(body?): Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      device_id: string;
      device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: false;
      properties: {
          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;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

• Parameters

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

    • Optional connect_webview_id?: string

    • Optional connected_account_id?: string

      List all devices owned by this connected account

    • Optional connected_account_ids?: string[]

    • Optional created_before?: Date

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

    • Optional device_ids?: string[]

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

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

    • Optional limit?: number

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

    • Optional user_identifier_key?: string

  Returns Promise<{
      can_program_online_access_codes?: boolean;
      can_remotely_unlock?: boolean;
      capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
      connected_account_id: string;
      created_at: string;
      device_id: string;
      device_type: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: false;
      properties: {
          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;
              display_name: string;
              manufacturer_display_name: string;
              offline_access_codes_supported?: boolean;
              online_access_codes_supported?: boolean;
          };
          name: string;
          offline_access_codes_enabled?: boolean;
          online: boolean;
          online_access_codes_enabled?: boolean;
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

update

• update(body?): Promise<void>

• Parameters

  • Optional body: {
        device_id: string;
        is_managed: true;
    }

    • device_id: string

    • is_managed: true

  Returns Promise<void>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpDevicesUnmanaged

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

Static fromClient

• fromClient(client, options?): SeamHttpDevicesUnmanaged

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpDevicesUnmanaged

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpDevicesUnmanaged

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpDevicesUnmanaged>