Class SeamHttpClientSessions

constructor

• new SeamHttpClientSessions(apiKeyOrOptions?): SeamHttpClientSessions

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpClientSessions

client

Readonly defaults

create

• create(body?): Promise<{
      client_session_id: string;
      created_at: string;
      token: string;
      user_identifier_key: null | string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        connect_webview_ids?: string[];
        connected_account_ids?: string[];
        expires_at?: Date;
        user_identifier_key?: string;
        user_identity_ids?: string[];
    }

    • Optional connect_webview_ids?: string[]

    • Optional connected_account_ids?: string[]

    • Optional expires_at?: Date

    • Optional user_identifier_key?: string

    • Optional user_identity_ids?: string[]

  Returns Promise<{
      client_session_id: string;
      created_at: string;
      token: string;
      user_identifier_key: null | string;
      workspace_id: string;
  }>

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        client_session_id: string;
    }

    • client_session_id: string

  Returns Promise<void>

get

• get(body?): Promise<{
      client_session_id: string;
      connect_webview_ids: string[];
      connected_account_ids: string[];
      created_at: string;
      device_count: number;
      token: string;
      user_identifier_key: null | string;
      user_identity_ids: string[];
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        client_session_id?: string;
        user_identifier_key?: string;
    }

    • Optional client_session_id?: string

    • Optional user_identifier_key?: string

  Returns Promise<{
      client_session_id: string;
      connect_webview_ids: string[];
      connected_account_ids: string[];
      created_at: string;
      device_count: number;
      token: string;
      user_identifier_key: null | string;
      user_identity_ids: string[];
      workspace_id: string;
  }>

getOrCreate

• getOrCreate(body?): Promise<{
      client_session_id: string;
      created_at: string;
      token: string;
      user_identifier_key: null | string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        connect_webview_ids?: string[];
        connected_account_ids?: string[];
        expires_at?: Date;
        user_identifier_key?: string;
        user_identity_ids?: string[];
    }

    • Optional connect_webview_ids?: string[]

    • Optional connected_account_ids?: string[]

    • Optional expires_at?: Date

    • Optional user_identifier_key?: string

    • Optional user_identity_ids?: string[]

  Returns Promise<{
      client_session_id: string;
      created_at: string;
      token: string;
      user_identifier_key: null | string;
      workspace_id: string;
  }>

grantAccess

• grantAccess(body?): Promise<{
      client_session_id: string;
      connect_webview_ids: string[];
      connected_account_ids: string[];
      created_at: string;
      device_count: number;
      token: string;
      user_identifier_key: null | string;
      user_identity_ids: string[];
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        client_session_id?: string;
        connect_webview_ids?: string[];
        connected_account_ids?: string[];
        user_identifier_key?: string;
        user_identity_ids?: string[];
    }

    • Optional client_session_id?: string

    • Optional connect_webview_ids?: string[]

    • Optional connected_account_ids?: string[]

    • Optional user_identifier_key?: string

    • Optional user_identity_ids?: string[]

  Returns Promise<{
      client_session_id: string;
      connect_webview_ids: string[];
      connected_account_ids: string[];
      created_at: string;
      device_count: number;
      token: string;
      user_identifier_key: null | string;
      user_identity_ids: string[];
      workspace_id: string;
  }>

list

• list(body?): Promise<{
      client_session_id: string;
      connect_webview_ids: string[];
      connected_account_ids: string[];
      created_at: string;
      device_count: number;
      user_identifier_key: null | string;
      user_identity_ids: string[];
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: {
        client_session_id?: string;
        connect_webview_id?: string;
        user_identifier_key?: string;
        user_identity_id?: string;
        without_user_identifier_key?: boolean;
    }

    • Optional client_session_id?: string

    • Optional connect_webview_id?: string

    • Optional user_identifier_key?: string

    • Optional user_identity_id?: string

    • Optional without_user_identifier_key?: boolean

  Returns Promise<{
      client_session_id: string;
      connect_webview_ids: string[];
      connected_account_ids: string[];
      created_at: string;
      device_count: number;
      user_identifier_key: null | string;
      user_identity_ids: string[];
      workspace_id: string;
  }[]>

revoke

• revoke(body?): Promise<void>

• Parameters

  • Optional body: {
        client_session_id: string;
    }

    • client_session_id: string

  Returns Promise<void>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpClientSessions

• Parameters

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

  Returns SeamHttpClientSessions

Static fromClient

• fromClient(client, options?): SeamHttpClientSessions

• Parameters

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

  Returns SeamHttpClientSessions

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpClientSessions

• Parameters

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

  Returns SeamHttpClientSessions

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpClientSessions

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpClientSessions

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpClientSessions>