Class SeamHttpConnectWebviews

Hierarchy

  • SeamHttpConnectWebviews

Constructors

Properties

client: AxiosInstance
defaults: Required<SeamHttpRequestOptions>

Methods

  • Parameters

    • Optional body: {
          accepted_providers?: ("linear" | "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" | "yale_access" | "hid_cm")[];
          automatically_manage_new_devices?: boolean;
          custom_metadata?: Record<string, null | string | number | boolean>;
          custom_redirect_failure_url?: string;
          custom_redirect_url?: string;
          device_selection_mode?: "none" | "multiple" | "single";
          provider_category?: "stable" | "consumer_smartlocks" | "internal_beta";
          wait_for_device_creation?: boolean;
      }
      • Optional accepted_providers?: ("linear" | "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" | "yale_access" | "hid_cm")[]
      • Optional automatically_manage_new_devices?: boolean
      • Optional custom_metadata?: Record<string, null | string | number | 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" | "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 | number | 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<void>

  • 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 | number | 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: {
          user_identifier_key?: string;
      }
      • 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 | number | 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 params: {
          auth_token: string;
          connect_webview_id: string;
      }
      • auth_token: string
      • connect_webview_id: string

    Returns Promise<void>

Generated using TypeDoc