Class SeamHttpClientSessions

constructor

• new SeamHttpClientSessions(apiKeyOrOptions?): SeamHttpClientSessions

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpClientSessions

client

Readonlydefaults

create

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

• Parameters

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

    • Optionalconnect_webview_ids?: string[]

    • Optionalconnected_account_ids?: string[]

    • Optionalexpires_at?: Date

    • Optionaluser_identifier_key?: string

    • Optionaluser_identity_ids?: string[]

  Returns SeamHttpRequest<SetNonNullable<Required<{
      client_session: {
          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;
      };
  }>, "client_session">, "client_session">

delete

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

• Parameters

  • Optionalbody: {
        client_session_id: string;
    }

    • client_session_id: string

  Returns SeamHttpRequest<void, undefined>

get

• get(body?): SeamHttpRequest<SetNonNullable<Required<{
      client_session: {
          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;
      };
  }>, "client_session">, "client_session">

• Parameters

  • Optionalbody: {
        client_session_id?: string;
        user_identifier_key?: string;
    }

    • Optionalclient_session_id?: string

    • Optionaluser_identifier_key?: string

  Returns SeamHttpRequest<SetNonNullable<Required<{
      client_session: {
          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;
      };
  }>, "client_session">, "client_session">

getOrCreate

• getOrCreate(body?): SeamHttpRequest<SetNonNullable<Required<{
      client_session: {
          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;
      };
  }>, "client_session">, "client_session">

• Parameters

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

    • Optionalconnect_webview_ids?: string[]

    • Optionalconnected_account_ids?: string[]

    • Optionalexpires_at?: Date

    • Optionaluser_identifier_key?: string

    • Optionaluser_identity_ids?: string[]

  Returns SeamHttpRequest<SetNonNullable<Required<{
      client_session: {
          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;
      };
  }>, "client_session">, "client_session">

grantAccess

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

• Parameters

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

    • Optionalclient_session_id?: string

    • Optionalconnect_webview_ids?: string[]

    • Optionalconnected_account_ids?: string[]

    • Optionaluser_identifier_key?: string

    • Optionaluser_identity_ids?: string[]

  Returns SeamHttpRequest<void, undefined>

list

• list(body?): SeamHttpRequest<SetNonNullable<Required<{
      client_sessions: {
          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;
      }[];
  }>, "client_sessions">, "client_sessions">

• Parameters

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

    • Optionalclient_session_id?: string

    • Optionalconnect_webview_id?: string

    • Optionaluser_identifier_key?: string

    • Optionaluser_identity_id?: string

    • Optionalwithout_user_identifier_key?: boolean

  Returns SeamHttpRequest<SetNonNullable<Required<{
      client_sessions: {
          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;
      }[];
  }>, "client_sessions">, "client_sessions">

revoke

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

• Parameters

  • Optionalbody: {
        client_session_id: string;
    }

    • client_session_id: string

  Returns SeamHttpRequest<void, undefined>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpClientSessions

• Parameters

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

  Returns SeamHttpClientSessions

StaticfromClient

• fromClient(client, options?): SeamHttpClientSessions

• Parameters

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

  Returns SeamHttpClientSessions

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpClientSessions

• Parameters

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

  Returns SeamHttpClientSessions

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpClientSessions

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpClientSessions

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpClientSessions>