Class SeamHttpSeamBridgeV1BridgeClientSessions

constructor

• new SeamHttpSeamBridgeV1BridgeClientSessions(apiKeyOrOptions?): SeamHttpSeamBridgeV1BridgeClientSessions

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamBridgeV1BridgeClientSessions

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      bridge_client_session: {
          bridge_client_machine_identifier_key: string;
          bridge_client_name: string;
          bridge_client_session_id: string;
          bridge_client_session_token: string;
          bridge_client_time_zone: string;
          created_at: string;
          errors: ({
              can_tailscale_proxy_reach_bridge: null | boolean;
              can_tailscale_proxy_reach_tailscale_network: null | boolean;
              created_at: string;
              error_code: "bridge_lan_unreachable";
              is_bridge_socks_server_healthy: null | boolean;
              is_tailscale_proxy_reachable: null | boolean;
              is_tailscale_proxy_socks_server_healthy: null | boolean;
              message: string;
          } | {
              created_at: string;
              error_code: "no_communication_from_bridge";
              message: string;
          })[];
          pairing_code: string;
          pairing_code_expires_at: string;
          tailscale_auth_key: null | string;
          tailscale_hostname: string;
          telemetry_token: null | string;
          telemetry_token_expires_at: null | string;
          telemetry_url: null | string;
      };
  }>, "bridge_client_session">, "bridge_client_session">

• Parameters

  • Optionalbody: {
        bridge_client_machine_identifier_key: string;
        bridge_client_name: string;
        bridge_client_time_zone: string;
    }

    • bridge_client_machine_identifier_key: string

      Identifier key of the client machine for the Seam Bridge client that you want to create.

    • bridge_client_name: string

      Name of the Seam Bridge client that you want to create.

    • bridge_client_time_zone: string

      Time zone for the Seam Bridge client that you want to create.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      bridge_client_session: {
          bridge_client_machine_identifier_key: string;
          bridge_client_name: string;
          bridge_client_session_id: string;
          bridge_client_session_token: string;
          bridge_client_time_zone: string;
          created_at: string;
          errors: ({
              can_tailscale_proxy_reach_bridge: null | boolean;
              can_tailscale_proxy_reach_tailscale_network: null | boolean;
              created_at: string;
              error_code: "bridge_lan_unreachable";
              is_bridge_socks_server_healthy: null | boolean;
              is_tailscale_proxy_reachable: null | boolean;
              is_tailscale_proxy_socks_server_healthy: null | boolean;
              message: string;
          } | {
              created_at: string;
              error_code: "no_communication_from_bridge";
              message: string;
          })[];
          pairing_code: string;
          pairing_code_expires_at: string;
          tailscale_auth_key: null | string;
          tailscale_hostname: string;
          telemetry_token: null | string;
          telemetry_token_expires_at: null | string;
          telemetry_url: null | string;
      };
  }>, "bridge_client_session">, "bridge_client_session">

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>

get

• get(params?): SeamHttpRequest<SetNonNullable<Required<{
      bridge_client_session: {
          bridge_client_machine_identifier_key: string;
          bridge_client_name: string;
          bridge_client_session_id: string;
          bridge_client_session_token: string;
          bridge_client_time_zone: string;
          created_at: string;
          errors: ({
              can_tailscale_proxy_reach_bridge: null | boolean;
              can_tailscale_proxy_reach_tailscale_network: null | boolean;
              created_at: string;
              error_code: "bridge_lan_unreachable";
              is_bridge_socks_server_healthy: null | boolean;
              is_tailscale_proxy_reachable: null | boolean;
              is_tailscale_proxy_socks_server_healthy: null | boolean;
              message: string;
          } | {
              created_at: string;
              error_code: "no_communication_from_bridge";
              message: string;
          })[];
          pairing_code: string;
          pairing_code_expires_at: string;
          tailscale_auth_key: null | string;
          tailscale_hostname: string;
          telemetry_token: null | string;
          telemetry_token_expires_at: null | string;
          telemetry_url: null | string;
      };
  }>, "bridge_client_session">, "bridge_client_session">

• Parameters

  • Optionalparams: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      bridge_client_session: {
          bridge_client_machine_identifier_key: string;
          bridge_client_name: string;
          bridge_client_session_id: string;
          bridge_client_session_token: string;
          bridge_client_time_zone: string;
          created_at: string;
          errors: ({
              can_tailscale_proxy_reach_bridge: null | boolean;
              can_tailscale_proxy_reach_tailscale_network: null | boolean;
              created_at: string;
              error_code: "bridge_lan_unreachable";
              is_bridge_socks_server_healthy: null | boolean;
              is_tailscale_proxy_reachable: null | boolean;
              is_tailscale_proxy_socks_server_healthy: null | boolean;
              message: string;
          } | {
              created_at: string;
              error_code: "no_communication_from_bridge";
              message: string;
          })[];
          pairing_code: string;
          pairing_code_expires_at: string;
          tailscale_auth_key: null | string;
          tailscale_hostname: string;
          telemetry_token: null | string;
          telemetry_token_expires_at: null | string;
          telemetry_url: null | string;
      };
  }>, "bridge_client_session">, "bridge_client_session">

refreshTelemetryToken

• refreshTelemetryToken(body?): SeamHttpRequest<SetNonNullable<Required<{
      bridge_client_session: {
          bridge_client_machine_identifier_key: string;
          bridge_client_name: string;
          bridge_client_session_id: string;
          bridge_client_session_token: string;
          bridge_client_time_zone: string;
          created_at: string;
          errors: ({
              can_tailscale_proxy_reach_bridge: null | boolean;
              can_tailscale_proxy_reach_tailscale_network: null | boolean;
              created_at: string;
              error_code: "bridge_lan_unreachable";
              is_bridge_socks_server_healthy: null | boolean;
              is_tailscale_proxy_reachable: null | boolean;
              is_tailscale_proxy_socks_server_healthy: null | boolean;
              message: string;
          } | {
              created_at: string;
              error_code: "no_communication_from_bridge";
              message: string;
          })[];
          pairing_code: string;
          pairing_code_expires_at: string;
          tailscale_auth_key: null | string;
          tailscale_hostname: string;
          telemetry_token: null | string;
          telemetry_token_expires_at: null | string;
          telemetry_url: null | string;
      };
  }>, "bridge_client_session">, "bridge_client_session">

• Parameters

  • Optionalbody: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      bridge_client_session: {
          bridge_client_machine_identifier_key: string;
          bridge_client_name: string;
          bridge_client_session_id: string;
          bridge_client_session_token: string;
          bridge_client_time_zone: string;
          created_at: string;
          errors: ({
              can_tailscale_proxy_reach_bridge: null | boolean;
              can_tailscale_proxy_reach_tailscale_network: null | boolean;
              created_at: string;
              error_code: "bridge_lan_unreachable";
              is_bridge_socks_server_healthy: null | boolean;
              is_tailscale_proxy_reachable: null | boolean;
              is_tailscale_proxy_socks_server_healthy: null | boolean;
              message: string;
          } | {
              created_at: string;
              error_code: "no_communication_from_bridge";
              message: string;
          })[];
          pairing_code: string;
          pairing_code_expires_at: string;
          tailscale_auth_key: null | string;
          tailscale_hostname: string;
          telemetry_token: null | string;
          telemetry_token_expires_at: null | string;
          telemetry_url: null | string;
      };
  }>, "bridge_client_session">, "bridge_client_session">

regeneratePairingCode

• regeneratePairingCode(body?): SeamHttpRequest<SetNonNullable<Required<{
      bridge_client_session: {
          bridge_client_machine_identifier_key: string;
          bridge_client_name: string;
          bridge_client_session_id: string;
          bridge_client_session_token: string;
          bridge_client_time_zone: string;
          created_at: string;
          errors: ({
              can_tailscale_proxy_reach_bridge: null | boolean;
              can_tailscale_proxy_reach_tailscale_network: null | boolean;
              created_at: string;
              error_code: "bridge_lan_unreachable";
              is_bridge_socks_server_healthy: null | boolean;
              is_tailscale_proxy_reachable: null | boolean;
              is_tailscale_proxy_socks_server_healthy: null | boolean;
              message: string;
          } | {
              created_at: string;
              error_code: "no_communication_from_bridge";
              message: string;
          })[];
          pairing_code: string;
          pairing_code_expires_at: string;
          tailscale_auth_key: null | string;
          tailscale_hostname: string;
          telemetry_token: null | string;
          telemetry_token_expires_at: null | string;
          telemetry_url: null | string;
      };
  }>, "bridge_client_session">, "bridge_client_session">

• Parameters

  • Optionalbody: {}

  Returns SeamHttpRequest<SetNonNullable<Required<{
      bridge_client_session: {
          bridge_client_machine_identifier_key: string;
          bridge_client_name: string;
          bridge_client_session_id: string;
          bridge_client_session_token: string;
          bridge_client_time_zone: string;
          created_at: string;
          errors: ({
              can_tailscale_proxy_reach_bridge: null | boolean;
              can_tailscale_proxy_reach_tailscale_network: null | boolean;
              created_at: string;
              error_code: "bridge_lan_unreachable";
              is_bridge_socks_server_healthy: null | boolean;
              is_tailscale_proxy_reachable: null | boolean;
              is_tailscale_proxy_socks_server_healthy: null | boolean;
              message: string;
          } | {
              created_at: string;
              error_code: "no_communication_from_bridge";
              message: string;
          })[];
          pairing_code: string;
          pairing_code_expires_at: string;
          tailscale_auth_key: null | string;
          tailscale_hostname: string;
          telemetry_token: null | string;
          telemetry_token_expires_at: null | string;
          telemetry_url: null | string;
      };
  }>, "bridge_client_session">, "bridge_client_session">

reportStatus

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

• Parameters

  • Optionalbody: {
        is_tailscale_connected: null | boolean;
        tailscale_ip_v4: null | string;
    }

    • is_tailscale_connected: null | boolean

      Indicates whether Tailscale is connected.

    • tailscale_ip_v4: null | string

      Tailscale IPv4 address.

  Returns SeamHttpRequest<void, undefined>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSeamBridgeV1BridgeClientSessions

• Parameters

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

  Returns SeamHttpSeamBridgeV1BridgeClientSessions

StaticfromClient

• fromClient(client, options?): SeamHttpSeamBridgeV1BridgeClientSessions

• Parameters

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

  Returns SeamHttpSeamBridgeV1BridgeClientSessions

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamBridgeV1BridgeClientSessions

• Parameters

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

  Returns SeamHttpSeamBridgeV1BridgeClientSessions

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpSeamBridgeV1BridgeClientSessions

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpSeamBridgeV1BridgeClientSessions

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpSeamBridgeV1BridgeClientSessions>