Class SeamHttpLocks

constructor

• new SeamHttpLocks(apiKeyOrOptions?): SeamHttpLocks

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpLocks

client

Readonly defaults

get

• get(body?): Promise<{
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: ({ online: boolean; name: string; model: { display_name: string; manufacturer_display_name: string; offline_access_codes_supported?: boolean | undefined; online_access_codes_supported?: boolean | undefined; accessory_keypad_supported?: boolean | undefined; }; ... 10 more ...; supports_offline_access_codes?: boolean |...) & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: 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<{
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: ({ online: boolean; name: string; model: { display_name: string; manufacturer_display_name: string; offline_access_codes_supported?: boolean | undefined; online_access_codes_supported?: boolean | undefined; accessory_keypad_supported?: boolean | undefined; }; ... 10 more ...; supports_offline_access_codes?: boolean |...) & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }>

list

• list(body?): Promise<{
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: ({ online: boolean; name: string; model: { display_name: string; manufacturer_display_name: string; offline_access_codes_supported?: boolean | undefined; online_access_codes_supported?: boolean | undefined; accessory_keypad_supported?: boolean | undefined; }; ... 10 more ...; supports_offline_access_codes?: boolean |...) & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: 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;
        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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_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" | "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 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_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" | "keywe" | "philia" | "samsung" | "seam" | "two_n"

    • Optional user_identifier_key?: string

  Returns Promise<{
      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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "ios_phone" | "android_phone";
      errors: {
          error_code: string;
          message: string;
      }[];
      is_managed: true;
      location: null | {
          location_name?: string;
          timezone?: string;
      };
      properties: ({ online: boolean; name: string; model: { display_name: string; manufacturer_display_name: string; offline_access_codes_supported?: boolean | undefined; online_access_codes_supported?: boolean | undefined; accessory_keypad_supported?: boolean | undefined; }; ... 10 more ...; supports_offline_access_codes?: boolean |...) & {
          assa_abloy_credential_service_metadata?: {
              endpoints: {
                  endpoint_id: string;
                  is_active: boolean;
              }[];
              has_active_endpoint: boolean;
          };
      };
      warnings: {
          message: string;
          warning_code: string;
      }[];
      workspace_id: string;
  }[]>

lockDoor

• lockDoor(body?, options?): Promise<NonNullable<{
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }>>

• Parameters

  • Optional body: {
        device_id: string;
        sync?: boolean;
    }

    • device_id: string

    • Optional sync?: boolean

  • options: Pick<SeamHttpRequestOptions, "waitForActionAttempt"> = {}

  Returns Promise<NonNullable<{
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }>>

unlockDoor

• unlockDoor(body?, options?): Promise<NonNullable<{
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }>>

• Parameters

  • Optional body: {
        device_id: string;
        sync?: boolean;
    }

    • device_id: string

    • Optional sync?: boolean

  • options: Pick<SeamHttpRequestOptions, "waitForActionAttempt"> = {}

  Returns Promise<NonNullable<{
      action_attempt_id: string;
      action_type: string;
      error: null;
      result?: any;
      status: "success";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: null;
      result: null;
      status: "pending";
  } | {
      action_attempt_id: string;
      action_type: string;
      error: {
          message: string;
          type: string;
      };
      result: null;
      status: "error";
  }>>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpLocks

• Parameters

  • apiKey: string

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

  Returns SeamHttpLocks

Static fromClient

• fromClient(client, options?): SeamHttpLocks

• Parameters

  • client: AxiosInstance

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

  Returns SeamHttpLocks

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpLocks

• Parameters

  • clientSessionToken: string

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

  Returns SeamHttpLocks

Static fromConsoleSessionToken

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

• Parameters

  • consoleSessionToken: string

  • workspaceId: string

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

  Returns SeamHttpLocks

Static fromPersonalAccessToken

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

• Parameters

  • personalAccessToken: string

  • workspaceId: string

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

  Returns SeamHttpLocks

Static fromPublishableKey

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

• Parameters

  • publishableKey: string

  • userIdentifierKey: string

  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpLocks>