Class SeamHttpConnectWebviews

constructor

• new SeamHttpConnectWebviews(apiKeyOrOptions?): SeamHttpConnectWebviews

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpConnectWebviews

client

Readonly defaults

create

• create(body?): Promise<{
      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?: string;
      created_at: string;
      custom_metadata: Record<string, null | 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;
  }>

• Parameters

  • Optional body: {
        accepted_providers?: ("linear" | "assa_abloy_credential_service" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "doorking" | "salto" | "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" | "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;
        device_selection_mode?: "none" | "multiple" | "single";
        provider_category?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" | "internal_beta";
        wait_for_device_creation?: boolean;
    }

    • Optional accepted_providers?: ("linear" | "assa_abloy_credential_service" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "doorking" | "salto" | "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" | "yale_access" | "hid_cm" | "google_nest")[]

    • Optional automatically_manage_new_devices?: boolean

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

    • Optional custom_redirect_failure_url?: string

    • Optional custom_redirect_url?: string

    • Optional device_selection_mode?: "none" | "multiple" | "single"

    • Optional provider_category?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" | "internal_beta"

    • Optional wait_for_device_creation?: boolean

  Returns Promise<{
      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?: string;
      created_at: string;
      custom_metadata: Record<string, null | 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;
  }>

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        connect_webview_id: string;
    }

    • connect_webview_id: string

  Returns Promise<void>

get

• get(body?): Promise<{
      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?: string;
      created_at: string;
      custom_metadata: Record<string, null | 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;
  }>

• Parameters

  • Optional body: {
        connect_webview_id: string;
    }

    • connect_webview_id: string

  Returns Promise<{
      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?: string;
      created_at: string;
      custom_metadata: Record<string, null | 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;
  }>

list

• list(body?): Promise<{
      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?: string;
      created_at: string;
      custom_metadata: Record<string, null | 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;
  }[]>

• Parameters

  • Optional body: {
        custom_metadata_has?: Record<string, null | string | boolean>;
        user_identifier_key?: string;
    }

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

      Returns devices where the webview's custom_metadata contains all of the provided key/value pairs.

    • Optional user_identifier_key?: string

  Returns Promise<{
      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?: string;
      created_at: string;
      custom_metadata: Record<string, null | 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;
  }[]>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

view

• view(params?): Promise<void>

• Parameters

  • Optional params: {
        auth_token: string;
        connect_webview_id: string;
    }

    • auth_token: string

    • connect_webview_id: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpConnectWebviews

• Parameters

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

  Returns SeamHttpConnectWebviews

Static fromClient

• fromClient(client, options?): SeamHttpConnectWebviews

• Parameters

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

  Returns SeamHttpConnectWebviews

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpConnectWebviews

• Parameters

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

  Returns SeamHttpConnectWebviews

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpConnectWebviews

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpConnectWebviews

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpConnectWebviews>