Class SeamHttpLocks

constructor

• new SeamHttpLocks(apiKeyOrOptions?: string | SeamHttpOptions): SeamHttpLocks

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpLocks

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

simulate

• get simulate(): SeamHttpLocksSimulate

  Returns SeamHttpLocksSimulate

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

get

• get(
      parameters?: { device_id?: string; name?: string },
      options?: LocksGetOptions,
  ): LocksGetRequest

  Parameters

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

    • Optionaldevice_id?: string

      ID of the lock that you want to get.

    • Optionalname?: string

      Name of the lock that you want to get.
  • options: LocksGetOptions = {}

  Returns LocksGetRequest

list

• list(
      parameters?: {
          connect_webview_id?: string;
          connected_account_id?: string;
          connected_account_ids?: string[];
          created_before?: Date;
          custom_metadata_has?: { [x: string]: string | boolean };
          customer_key?: string;
          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"
              | "ultraloq_lock";
          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"
              | "ultraloq_lock"
          )[];
          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"
              | "can_unlock_with_code"
              | "can_run_thermostat_programs"
              | "can_program_thermostat_programs_as_weekday_weekend"
              | "can_program_thermostat_programs_as_different_each_day"
              | "can_program_thermostat_programs_as_same_each_day"
              | "can_simulate_hub_connection"
              | "can_simulate_hub_disconnection"
              | "can_simulate_paid_subscription"
          )[];
          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"
              | "can_unlock_with_code"
              | "can_run_thermostat_programs"
              | "can_program_thermostat_programs_as_weekday_weekend"
              | "can_program_thermostat_programs_as_different_each_day"
              | "can_program_thermostat_programs_as_same_each_day"
              | "can_simulate_hub_connection"
              | "can_simulate_hub_disconnection"
              | "can_simulate_paid_subscription"
          )[];
          limit?: number;
          manufacturer?: | "akuvox"
          | "august"
          | "avigilon_alta"
          | "brivo"
          | "butterflymx"
          | "schlage"
          | "smartthings"
          | "yale"
          | "genie"
          | "doorking"
          | "salto"
          | "lockly"
          | "ttlock"
          | "linear"
          | "nuki"
          | "igloo"
          | "kwikset"
          | "controlbyweb"
          | "igloohome"
          | "hubitat"
          | "four_suites"
          | "dormakaba_oracode"
          | "wyze"
          | "tedee"
          | "akiles"
          | "kwikset2"
          | "ultraloq"
          | "seam"
          | "two_n";
          page_cursor?: null
          | string;
          search?: string;
          space_id?: string;
          unstable_location_id?: null | string;
          user_identifier_key?: string;
      },
      options?: LocksListOptions,
  ): LocksListRequest

  Parameters

  • Optionalparameters: {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: Date;
        custom_metadata_has?: { [x: string]: string | boolean };
        customer_key?: string;
        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"
            | "ultraloq_lock";
        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"
            | "ultraloq_lock"
        )[];
        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"
            | "can_unlock_with_code"
            | "can_run_thermostat_programs"
            | "can_program_thermostat_programs_as_weekday_weekend"
            | "can_program_thermostat_programs_as_different_each_day"
            | "can_program_thermostat_programs_as_same_each_day"
            | "can_simulate_hub_connection"
            | "can_simulate_hub_disconnection"
            | "can_simulate_paid_subscription"
        )[];
        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"
            | "can_unlock_with_code"
            | "can_run_thermostat_programs"
            | "can_program_thermostat_programs_as_weekday_weekend"
            | "can_program_thermostat_programs_as_different_each_day"
            | "can_program_thermostat_programs_as_same_each_day"
            | "can_simulate_hub_connection"
            | "can_simulate_hub_disconnection"
            | "can_simulate_paid_subscription"
        )[];
        limit?: number;
        manufacturer?: | "akuvox"
        | "august"
        | "avigilon_alta"
        | "brivo"
        | "butterflymx"
        | "schlage"
        | "smartthings"
        | "yale"
        | "genie"
        | "doorking"
        | "salto"
        | "lockly"
        | "ttlock"
        | "linear"
        | "nuki"
        | "igloo"
        | "kwikset"
        | "controlbyweb"
        | "igloohome"
        | "hubitat"
        | "four_suites"
        | "dormakaba_oracode"
        | "wyze"
        | "tedee"
        | "akiles"
        | "kwikset2"
        | "ultraloq"
        | "seam"
        | "two_n";
        page_cursor?: null
        | string;
        search?: string;
        space_id?: string;
        unstable_location_id?: null | string;
        user_identifier_key?: string;
    }

    • Optionalconnect_webview_id?: string

      ID of the Connect Webview for which you want to list devices.

    • Optionalconnected_account_id?: string

      ID of the connected account for which you want to list devices.

    • Optionalconnected_account_ids?: string[]

      Array of IDs of the connected accounts for which you want to list devices.

    • Optionalcreated_before?: Date

      Timestamp by which to limit returned devices. Returns devices created before this timestamp.

    • Optionalcustom_metadata_has?: { [x: string]: string | boolean }

      Set of key:value custom metadata pairs for which you want to list devices.

    • Optionalcustomer_key?: string

      Customer key for which you want to list devices.

    • Optionaldevice_ids?: string[]

      Array of device IDs for which you want to list 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"
          | "ultraloq_lock"

      Device type of the locks that you want to list.

    • 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"
          | "ultraloq_lock"
      )[]

      Device types of the locks that you want to list.

    • 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"
          | "can_unlock_with_code"
          | "can_run_thermostat_programs"
          | "can_program_thermostat_programs_as_weekday_weekend"
          | "can_program_thermostat_programs_as_different_each_day"
          | "can_program_thermostat_programs_as_same_each_day"
          | "can_simulate_hub_connection"
          | "can_simulate_hub_disconnection"
          | "can_simulate_paid_subscription"
      )[]

    • 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"
          | "can_unlock_with_code"
          | "can_run_thermostat_programs"
          | "can_program_thermostat_programs_as_weekday_weekend"
          | "can_program_thermostat_programs_as_different_each_day"
          | "can_program_thermostat_programs_as_same_each_day"
          | "can_simulate_hub_connection"
          | "can_simulate_hub_disconnection"
          | "can_simulate_paid_subscription"
      )[]

    • Optionallimit?: number

      Numerical limit on the number of devices to return.

    • Optionalmanufacturer?:
          | "akuvox"
          | "august"
          | "avigilon_alta"
          | "brivo"
          | "butterflymx"
          | "schlage"
          | "smartthings"
          | "yale"
          | "genie"
          | "doorking"
          | "salto"
          | "lockly"
          | "ttlock"
          | "linear"
          | "nuki"
          | "igloo"
          | "kwikset"
          | "controlbyweb"
          | "igloohome"
          | "hubitat"
          | "four_suites"
          | "dormakaba_oracode"
          | "wyze"
          | "tedee"
          | "akiles"
          | "kwikset2"
          | "ultraloq"
          | "seam"
          | "two_n"

      Manufacturer of the locks that you want to list.

    • Optionalpage_cursor?: null | string

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalsearch?: string

      String for which to search. Filters returned devices to include all records that satisfy a partial match using device_id, display_name, custom_metadata or location.location_name.

    • Optionalspace_id?: string

      ID of the space for which you want to list devices.

    • Optionalunstable_location_id?: null | string

      Deprecated

      Use space_id.

    • Optionaluser_identifier_key?: string

      Your own internal user ID for the user for which you want to list devices.
  • options: LocksListOptions = {}

  Returns LocksListRequest

lockDoor

• lockDoor(
      parameters?: { device_id: string; sync?: boolean },
      options?: LocksLockDoorOptions,
  ): LocksLockDoorRequest

  Parameters

  • Optionalparameters: { device_id: string; sync?: boolean }

    • device_id: string

      ID of the lock that you want to lock.

    • Optionalsync?: boolean
  • options: LocksLockDoorOptions = {}

  Returns LocksLockDoorRequest

unlockDoor

• unlockDoor(
      parameters?: { device_id: string; sync?: boolean },
      options?: LocksUnlockDoorOptions,
  ): LocksUnlockDoorRequest

  Parameters

  • Optionalparameters: { device_id: string; sync?: boolean }

    • device_id: string

      ID of the lock that you want to unlock.

    • Optionalsync?: boolean
  • options: LocksUnlockDoorOptions = {}

  Returns LocksUnlockDoorRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpLocks

  Parameters

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

  Returns SeamHttpLocks

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpLocks

  Parameters

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

  Returns SeamHttpLocks

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpLocks

  Parameters

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

  Returns SeamHttpLocks

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpLocks

  Parameters

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

  Returns SeamHttpLocks

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpLocks

  Parameters

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

  Returns SeamHttpLocks

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpLocks>