Class SeamHttpConnectWebviews

constructor

• new SeamHttpConnectWebviews(apiKeyOrOptions?): SeamHttpConnectWebviews

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpConnectWebviews

client

Readonlydefaults

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      connect_webview: {
          accepted_capabilities: (
              | "lock"
              | "thermostat"
              | "noise_sensor"
              | "access_control")[];
          accepted_devices: string[];
          accepted_providers: string[];
          any_device_allowed: boolean;
          any_provider_allowed: boolean;
          authorized_at: null | string;
          automatically_manage_new_devices: boolean;
          connect_webview_id: string;
          connected_account_id: null | string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          custom_redirect_failure_url: null | string;
          custom_redirect_url: null | string;
          device_selection_mode: "none" | "multiple" | "single";
          login_successful: boolean;
          selected_provider: null | string;
          status: "failed" | "pending" | "authorized";
          url: string;
          wait_for_device_creation: boolean;
          workspace_id: string;
      };
  }>, "connect_webview">, "connect_webview">

• Parameters

  • Optionalbody: {
        accepted_capabilities?: (
            | "lock"
            | "thermostat"
            | "noise_sensor"
            | "access_control")[];
        accepted_providers?: (
            | "linear"
            | "assa_abloy_credential_service"
            | "assa_abloy_vostio"
            | "assa_abloy_vostio_credential_service"
            | "doorking"
            | "dormakaba_community"
            | "legic_connect"
            | "akuvox"
            | "august"
            | "avigilon_alta"
            | "brivo"
            | "butterflymx"
            | "schlage"
            | "smartthings"
            | "yale"
            | "genie"
            | "salto"
            | "salto_ks"
            | "lockly"
            | "ttlock"
            | "noiseaware"
            | "nuki"
            | "seam_relay_admin"
            | "igloo"
            | "kwikset"
            | "minut"
            | "my_2n"
            | "controlbyweb"
            | "nest"
            | "igloohome"
            | "ecobee"
            | "hubitat"
            | "four_suites"
            | "dormakaba_oracode"
            | "pti"
            | "wyze"
            | "seam_passport"
            | "visionline"
            | "seam_bridge"
            | "tedee"
            | "honeywell_resideo"
            | "latch"
            | "akiles"
            | "tado"
            | "salto_space"
            | "sensi"
            | "kwikset2"
            | "yale_access"
            | "hid_cm"
            | "google_nest")[];
        automatically_manage_new_devices?: boolean;
        custom_metadata?: Record<string, null | string | boolean>;
        custom_redirect_failure_url?: string;
        custom_redirect_url?: string;
        customer_id?: string;
        device_selection_mode?: "none" | "multiple" | "single";
        provider_category?:
            | "stable"
            | "consumer_smartlocks"
            | "thermostats"
            | "noise_sensors"
            | "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?: (
          | "linear"
          | "assa_abloy_credential_service"
          | "assa_abloy_vostio"
          | "assa_abloy_vostio_credential_service"
          | "doorking"
          | "dormakaba_community"
          | "legic_connect"
          | "akuvox"
          | "august"
          | "avigilon_alta"
          | "brivo"
          | "butterflymx"
          | "schlage"
          | "smartthings"
          | "yale"
          | "genie"
          | "salto"
          | "salto_ks"
          | "lockly"
          | "ttlock"
          | "noiseaware"
          | "nuki"
          | "seam_relay_admin"
          | "igloo"
          | "kwikset"
          | "minut"
          | "my_2n"
          | "controlbyweb"
          | "nest"
          | "igloohome"
          | "ecobee"
          | "hubitat"
          | "four_suites"
          | "dormakaba_oracode"
          | "pti"
          | "wyze"
          | "seam_passport"
          | "visionline"
          | "seam_bridge"
          | "tedee"
          | "honeywell_resideo"
          | "latch"
          | "akiles"
          | "tado"
          | "salto_space"
          | "sensi"
          | "kwikset2"
          | "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?: Record<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_id?: string

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

    • Optionalprovider_category?:
          | "stable"
          | "consumer_smartlocks"
          | "thermostats"
          | "noise_sensors"
          | "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.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      connect_webview: {
          accepted_capabilities: (
              | "lock"
              | "thermostat"
              | "noise_sensor"
              | "access_control")[];
          accepted_devices: string[];
          accepted_providers: string[];
          any_device_allowed: boolean;
          any_provider_allowed: boolean;
          authorized_at: null | string;
          automatically_manage_new_devices: boolean;
          connect_webview_id: string;
          connected_account_id: null | string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          custom_redirect_failure_url: null | string;
          custom_redirect_url: null | string;
          device_selection_mode: "none" | "multiple" | "single";
          login_successful: boolean;
          selected_provider: null | string;
          status: "failed" | "pending" | "authorized";
          url: string;
          wait_for_device_creation: boolean;
          workspace_id: string;
      };
  }>, "connect_webview">, "connect_webview">

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

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

• Parameters

  • Optionalbody: {
        connect_webview_id: string;
    }

    • connect_webview_id: string

      ID of the Connect Webview that you want to delete.

  Returns SeamHttpRequest<void, undefined>

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      connect_webview: {
          accepted_capabilities: (
              | "lock"
              | "thermostat"
              | "noise_sensor"
              | "access_control")[];
          accepted_devices: string[];
          accepted_providers: string[];
          any_device_allowed: boolean;
          any_provider_allowed: boolean;
          authorized_at: null | string;
          automatically_manage_new_devices: boolean;
          connect_webview_id: string;
          connected_account_id: null | string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          custom_redirect_failure_url: null | string;
          custom_redirect_url: null | string;
          device_selection_mode: "none" | "multiple" | "single";
          login_successful: boolean;
          selected_provider: null | string;
          status: "failed" | "pending" | "authorized";
          url: string;
          wait_for_device_creation: boolean;
          workspace_id: string;
      };
  }>, "connect_webview">, "connect_webview">

• Parameters

  • Optionalbody: {
        connect_webview_id: string;
    }

    • connect_webview_id: string

      ID of the Connect Webview that you want to get.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      connect_webview: {
          accepted_capabilities: (
              | "lock"
              | "thermostat"
              | "noise_sensor"
              | "access_control")[];
          accepted_devices: string[];
          accepted_providers: string[];
          any_device_allowed: boolean;
          any_provider_allowed: boolean;
          authorized_at: null | string;
          automatically_manage_new_devices: boolean;
          connect_webview_id: string;
          connected_account_id: null | string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          custom_redirect_failure_url: null | string;
          custom_redirect_url: null | string;
          device_selection_mode: "none" | "multiple" | "single";
          login_successful: boolean;
          selected_provider: null | string;
          status: "failed" | "pending" | "authorized";
          url: string;
          wait_for_device_creation: boolean;
          workspace_id: string;
      };
  }>, "connect_webview">, "connect_webview">

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      connect_webviews: {
          accepted_capabilities: (
              | "lock"
              | "thermostat"
              | "noise_sensor"
              | "access_control")[];
          accepted_devices: string[];
          accepted_providers: string[];
          any_device_allowed: boolean;
          any_provider_allowed: boolean;
          authorized_at: null | string;
          automatically_manage_new_devices: boolean;
          connect_webview_id: string;
          connected_account_id: null | string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          custom_redirect_failure_url: null | string;
          custom_redirect_url: null | string;
          device_selection_mode: "none" | "multiple" | "single";
          login_successful: boolean;
          selected_provider: null | string;
          status: "failed" | "pending" | "authorized";
          url: string;
          wait_for_device_creation: boolean;
          workspace_id: string;
      }[];
  }>, "connect_webviews">, "connect_webviews">

• Parameters

  • Optionalbody: {
        custom_metadata_has?: Record<string, string | boolean>;
        customer_ids?: string[];
        limit?: number;
        user_identifier_key?: string;
    }

    • Optionalcustom_metadata_has?: Record<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_ids?: string[]

    • Optionallimit?: number

      Maximum number of records to return per page.

    • Optionaluser_identifier_key?: string

      Your user ID for the user by which you want to filter Connect Webviews.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      connect_webviews: {
          accepted_capabilities: (
              | "lock"
              | "thermostat"
              | "noise_sensor"
              | "access_control")[];
          accepted_devices: string[];
          accepted_providers: string[];
          any_device_allowed: boolean;
          any_provider_allowed: boolean;
          authorized_at: null | string;
          automatically_manage_new_devices: boolean;
          connect_webview_id: string;
          connected_account_id: null | string;
          created_at: string;
          custom_metadata: Record<string, string | boolean>;
          custom_redirect_failure_url: null | string;
          custom_redirect_url: null | string;
          device_selection_mode: "none" | "multiple" | "single";
          login_successful: boolean;
          selected_provider: null | string;
          status: "failed" | "pending" | "authorized";
          url: string;
          wait_for_device_creation: boolean;
          workspace_id: string;
      }[];
  }>, "connect_webviews">, "connect_webviews">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpConnectWebviews

• Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromClient

• fromClient(client, options?): SeamHttpConnectWebviews

• Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpConnectWebviews

• Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpConnectWebviews>