Class SeamHttpConnectWebviews

constructor

• new SeamHttpConnectWebviews(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpConnectWebviews

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpConnectWebviews

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(
      parameters?: {
          accepted_capabilities?: (
              "lock"
              | "thermostat"
              | "noise_sensor"
              | "access_control"
          )[];
          accepted_providers?: (
              | "hotek"
              | "dormakaba_community"
              | "legic_connect"
              | "akuvox"
              | "august"
              | "avigilon_alta"
              | "brivo"
              | "butterflymx"
              | "schlage"
              | "smartthings"
              | "yale"
              | "genie"
              | "doorking"
              | "salto"
              | "salto_ks"
              | "lockly"
              | "ttlock"
              | "linear"
              | "noiseaware"
              | "nuki"
              | "seam_relay_admin"
              | "igloo"
              | "kwikset"
              | "minut"
              | "my_2n"
              | "controlbyweb"
              | "nest"
              | "igloohome"
              | "ecobee"
              | "hubitat"
              | "four_suites"
              | "dormakaba_oracode"
              | "pti"
              | "wyze"
              | "seam_passport"
              | "visionline"
              | "assa_abloy_credential_service"
              | "tedee"
              | "honeywell_resideo"
              | "latch"
              | "akiles"
              | "assa_abloy_vostio"
              | "assa_abloy_vostio_credential_service"
              | "tado"
              | "salto_space"
              | "sensi"
              | "kwikset2"
              | "keynest"
              | "dormakaba_ambiance"
              | "ultraloq"
              | "yale_access"
              | "hid_cm"
              | "google_nest"
          )[];
          automatically_manage_new_devices?: boolean;
          custom_metadata?: { [x: string]: null
          | string
          | boolean };
          custom_redirect_failure_url?: string;
          custom_redirect_url?: string;
          customer_key?: string;
          device_selection_mode?: "none" | "single" | "multiple";
          excluded_providers?: string[];
          provider_category?:
              | "noise_sensors"
              | "thermostats"
              | "stable"
              | "consumer_smartlocks"
              | "access_control_systems"
              | "internal_beta";
          wait_for_device_creation?: boolean;
      },
      options?: ConnectWebviewsCreateOptions,
  ): ConnectWebviewsCreateRequest

  Parameters

  • Optionalparameters: {
        accepted_capabilities?: (
            "lock"
            | "thermostat"
            | "noise_sensor"
            | "access_control"
        )[];
        accepted_providers?: (
            | "hotek"
            | "dormakaba_community"
            | "legic_connect"
            | "akuvox"
            | "august"
            | "avigilon_alta"
            | "brivo"
            | "butterflymx"
            | "schlage"
            | "smartthings"
            | "yale"
            | "genie"
            | "doorking"
            | "salto"
            | "salto_ks"
            | "lockly"
            | "ttlock"
            | "linear"
            | "noiseaware"
            | "nuki"
            | "seam_relay_admin"
            | "igloo"
            | "kwikset"
            | "minut"
            | "my_2n"
            | "controlbyweb"
            | "nest"
            | "igloohome"
            | "ecobee"
            | "hubitat"
            | "four_suites"
            | "dormakaba_oracode"
            | "pti"
            | "wyze"
            | "seam_passport"
            | "visionline"
            | "assa_abloy_credential_service"
            | "tedee"
            | "honeywell_resideo"
            | "latch"
            | "akiles"
            | "assa_abloy_vostio"
            | "assa_abloy_vostio_credential_service"
            | "tado"
            | "salto_space"
            | "sensi"
            | "kwikset2"
            | "keynest"
            | "dormakaba_ambiance"
            | "ultraloq"
            | "yale_access"
            | "hid_cm"
            | "google_nest"
        )[];
        automatically_manage_new_devices?: boolean;
        custom_metadata?: { [x: string]: null
        | string
        | boolean };
        custom_redirect_failure_url?: string;
        custom_redirect_url?: string;
        customer_key?: string;
        device_selection_mode?: "none" | "single" | "multiple";
        excluded_providers?: string[];
        provider_category?:
            | "noise_sensors"
            | "thermostats"
            | "stable"
            | "consumer_smartlocks"
            | "access_control_systems"
            | "internal_beta";
        wait_for_device_creation?: boolean;
    }

    • Optionalaccepted_capabilities?: ("lock" | "thermostat" | "noise_sensor" | "access_control")[]

      List of accepted device capabilities that restrict the types of devices that can be connected through the Connect Webview. If not provided, defaults will be determined based on the accepted providers.

    • Optionalaccepted_providers?: (
          | "hotek"
          | "dormakaba_community"
          | "legic_connect"
          | "akuvox"
          | "august"
          | "avigilon_alta"
          | "brivo"
          | "butterflymx"
          | "schlage"
          | "smartthings"
          | "yale"
          | "genie"
          | "doorking"
          | "salto"
          | "salto_ks"
          | "lockly"
          | "ttlock"
          | "linear"
          | "noiseaware"
          | "nuki"
          | "seam_relay_admin"
          | "igloo"
          | "kwikset"
          | "minut"
          | "my_2n"
          | "controlbyweb"
          | "nest"
          | "igloohome"
          | "ecobee"
          | "hubitat"
          | "four_suites"
          | "dormakaba_oracode"
          | "pti"
          | "wyze"
          | "seam_passport"
          | "visionline"
          | "assa_abloy_credential_service"
          | "tedee"
          | "honeywell_resideo"
          | "latch"
          | "akiles"
          | "assa_abloy_vostio"
          | "assa_abloy_vostio_credential_service"
          | "tado"
          | "salto_space"
          | "sensi"
          | "kwikset2"
          | "keynest"
          | "dormakaba_ambiance"
          | "ultraloq"
          | "yale_access"
          | "hid_cm"
          | "google_nest"
      )[]

      Accepted device provider keys as an alternative to provider_category. Use this parameter to specify accepted providers explicitly. See Customize the Brands to Display in Your Connect Webviews. To list all provider keys, use /devices/list_device_providers with no filters.

    • Optionalautomatically_manage_new_devices?: boolean

      Indicates whether newly-added devices should appear as managed devices. See also: Customize the Behavior Settings of Your Connect Webviews.

    • Optionalcustom_metadata?: { [x: string]: null | string | boolean }

      Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. Adding custom metadata to a Connect Webview enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any connected accounts that were connected using the Connect Webview, making it easy to find and filter these resources in your workspace. You can also filter Connect Webviews by custom metadata.

    • Optionalcustom_redirect_failure_url?: string

      Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the custom_redirect_url.

    • Optionalcustom_redirect_url?: string

      URL that you want to redirect the user to after the provider login is complete.

    • Optionalcustomer_key?: string

      Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error.

    • Optionaldevice_selection_mode?: "none" | "single" | "multiple"

    • Optionalexcluded_providers?: string[]

      List of provider keys to exclude from the Connect Webview. These providers will not be shown when the user tries to connect an account.

    • Optionalprovider_category?:
          | "noise_sensors"
          | "thermostats"
          | "stable"
          | "consumer_smartlocks"
          | "access_control_systems"
          | "internal_beta"

      Specifies the category of providers that you want to include. To list all providers within a category, use /devices/list_device_providers with the desired provider_category filter.

    • Optionalwait_for_device_creation?: boolean

      Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: Customize the Behavior Settings of Your Connect Webviews.
  • options: ConnectWebviewsCreateOptions = {}

  Returns ConnectWebviewsCreateRequest

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>

delete

• delete(
      parameters?: { connect_webview_id: string },
      options?: ConnectWebviewsDeleteOptions,
  ): ConnectWebviewsDeleteRequest

  Parameters

  • Optionalparameters: { connect_webview_id: string }

    • connect_webview_id: string

      ID of the Connect Webview that you want to delete.
  • options: ConnectWebviewsDeleteOptions = {}

  Returns ConnectWebviewsDeleteRequest

get

• get(
      parameters?: { connect_webview_id: string },
      options?: ConnectWebviewsGetOptions,
  ): ConnectWebviewsGetRequest

  Parameters

  • Optionalparameters: { connect_webview_id: string }

    • connect_webview_id: string

      ID of the Connect Webview that you want to get.
  • options: ConnectWebviewsGetOptions = {}

  Returns ConnectWebviewsGetRequest

list

• list(
      parameters?: {
          custom_metadata_has?: { [x: string]: string | boolean };
          customer_key?: string;
          limit?: number;
          page_cursor?: null | string;
          user_identifier_key?: string;
      },
      options?: ConnectWebviewsListOptions,
  ): ConnectWebviewsListRequest

  Parameters

  • Optionalparameters: {
        custom_metadata_has?: { [x: string]: string | boolean };
        customer_key?: string;
        limit?: number;
        page_cursor?: null | string;
        user_identifier_key?: string;
    }

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

      Custom metadata pairs by which you want to filter Connect Webviews. Returns Connect Webviews with custom_metadata that contains all of the provided key:value pairs.

    • Optionalcustomer_key?: string

      Customer key for which you want to list connect webviews.

    • Optionallimit?: number

      Maximum number of records to return per page.

    • Optionalpage_cursor?: null | string

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

    • Optionaluser_identifier_key?: string

      Your user ID for the user by which you want to filter Connect Webviews.
  • options: ConnectWebviewsListOptions = {}

  Returns ConnectWebviewsListRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromClient

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpConnectWebviews>