Class SeamHttpConnectWebviews

constructor

• new SeamHttpConnectWebviews(apiKeyOrOptions?): SeamHttpConnectWebviews

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpConnectWebviews

client

Readonlydefaults

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      connect_webview: {
          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_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"
            | "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;
    }

    • 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"
          | "yale_access"
          | "hid_cm"
          | "google_nest")[]

    • Optionalautomatically_manage_new_devices?: boolean

    • Optionalcustom_metadata?: Record<string, null | string | boolean>

    • Optionalcustom_redirect_failure_url?: string

    • Optionalcustom_redirect_url?: string

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

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

    • Optionalwait_for_device_creation?: boolean

  Returns SeamHttpRequest<SetNonNullable<Required<{
      connect_webview: {
          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

  Returns SeamHttpRequest<void, undefined>

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      connect_webview: {
          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

  Returns SeamHttpRequest<SetNonNullable<Required<{
      connect_webview: {
          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_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>;
        limit?: number;
        user_identifier_key?: string;
    }

    • Optionalcustom_metadata_has?: Record<string, string | boolean>

      Returns webviews whose custom_metadata contains all of the provided key/value pairs.

    • Optionallimit?: number

    • Optionaluser_identifier_key?: string

      Returns webviews that can be accessed by the provided user_identifier_key.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      connect_webviews: {
          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>