Class UserOperations

Operations for managing Baserow users.

Index

Constructors

Methods

changePassword getDashboard login logout redo refreshToken register resetPassword scheduleAccountDeletion sendPasswordResetEmail sendVerifyEmail undo updateAccount verifyEmail verifyToken

Constructors

constructor

new UserOperations(client: BaserowClient): UserOperations
Parameters
- client: BaserowClient
Returns UserOperations
- Defined in src/client/user-operations.ts:7

Methods

changePassword

changePassword(oldPassword: string, newPassword: string): Promise<void>
Changes the password of an authenticated user.
Parameters
- oldPassword: string
  Current password
- newPassword: string
  New password
Returns Promise<void>
Throws
If password change fails
- Defined in src/client/user-operations.ts:199

getDashboard

getDashboard(): Promise<
    {
        workspace_invitations: {
            created_on: string;
            email: string;
            email_exists: boolean;
            id: number;
            invited_by: string;
            message: string;
            workspace: string;
        }[];
    },
>
Lists all the relevant user information that could be shown on a dashboard. It will contain all the pending workspace invitations for that user.

Returns Promise<
    {
        workspace_invitations: {
            created_on: string;
            email: string;
            email_exists: boolean;
            id: number;
            invited_by: string;
            message: string;
            workspace: string;
        }[];
    },
>
Dashboard information including workspace invitations

Throws
If request fails
- Defined in src/client/user-operations.ts:214

login(
    email: string,
    password: string,
): Promise<
    {
        access_token: string;
        refresh_token: string;
        user: { first_name: string; language: string; username: string };
    },
>
Authenticates a user with email and password. Returns JWT tokens and user information that can be used for subsequent API calls.
Parameters
- email: string
  User's email
- password: string
  User's password
Returns Promise<
    {
        access_token: string;
        refresh_token: string;
        user: { first_name: string; language: string; username: string };
    },
>
Object containing user information, access_token and refresh_token

Throws
If authentication fails
- Defined in src/client/user-operations.ts:17

logout

logout(refreshToken: string): Promise<void>
Logs out a user by blacklisting their refresh token.
Parameters
- refreshToken: string
  The refresh token to blacklist
Returns Promise<void>
Throws
If the token blacklisting fails
- Defined in src/client/user-operations.ts:91

redo

redo(
    clientSessionId: string,
    scopes?: {
        application?: number;
        root?: boolean;
        table?: number;
        teamsInWorkspace?: number;
        view?: number;
        workspace?: number;
    },
): Promise<
    {
        actions: { action_scope: null
        | string; action_type: null | string }[];
        result_code: string;
    },
>
Redoes the latest redoable action performed by the user.
Parameters
- clientSessionId: string
  Client session ID header
- Optionalscopes: {
      application?: number;
      root?: boolean;
      table?: number;
      teamsInWorkspace?: number;
      view?: number;
      workspace?: number;
  }
  Optional scopes to filter actions
Returns Promise<
    {
        actions: { action_scope: null
        | string; action_type: null | string }[];
        result_code: string;
    },
>
Result of the redo operation

Throws
If redo fails
- Defined in src/client/user-operations.ts:372

refreshToken

refreshToken(
    refreshToken: string,
): Promise<
    {
        access_token: string;
        user: { first_name: string; language: string; username: string };
    },
>
Refreshes an expired JWT token using a refresh token.
Parameters
- refreshToken: string
  The refresh token obtained during login
Returns Promise<
    {
        access_token: string;
        user: { first_name: string; language: string; username: string };
    },
>
Object containing a new access_token and user information

Throws
If the refresh token is invalid or expired
- Defined in src/client/user-operations.ts:48

register

register(
    options: {
        authenticate?: boolean;
        email: string;
        language?: string;
        name: string;
        password: string;
        templateId?: number;
        workspaceInvitationToken?: string;
    },
): Promise<
    {
        access_token?: string;
        refresh_token?: string;
        user: { first_name: string; language: string; username: string };
    },
>
Creates a new user based on the provided values.
Parameters
- options: {
      authenticate?: boolean;
      email: string;
      language?: string;
      name: string;
      password: string;
      templateId?: number;
      workspaceInvitationToken?: string;
  }
  Object containing user registration fields:
  
  name: User's name
  
  email: User's email
  
  password: User's password
  
  language: Optional ISO 639 language code (default: "en")
  
  authenticate: Whether to generate authentication tokens (default: false)
  
  workspaceInvitationToken: Optional workspace invitation token
  
  templateId: Optional template ID to install after creating account
Returns Promise<
    {
        access_token?: string;
        refresh_token?: string;
        user: { first_name: string; language: string; username: string };
    },
>
Object containing user information and possibly tokens if authenticate is true

Throws
If user creation fails
- Defined in src/client/user-operations.ts:113

resetPassword

resetPassword(token: string, password: string): Promise<void>
Changes the password of a user if the reset token is valid.
Parameters
- token: string
  Password reset token
- password: string
  New password
Returns Promise<void>
Throws
If password reset fails
- Defined in src/client/user-operations.ts:249

scheduleAccountDeletion

scheduleAccountDeletion(): Promise<void>
Schedules the account deletion of the authenticated user.

Returns Promise<void>
Throws
If scheduling deletion fails
- Defined in src/client/user-operations.ts:277

sendPasswordResetEmail

sendPasswordResetEmail(email: string, baseUrl: string): Promise<void>
Sends an email containing the password reset link to the user's email address.
Parameters
- email: string
  User's email address
- baseUrl: string
  Base URL for the reset link
Returns Promise<void>
Throws
If sending email fails
- Defined in src/client/user-operations.ts:264

sendVerifyEmail

sendVerifyEmail(): Promise<void>
Sends an email to the user with an email verification link.

Returns Promise<void>
Throws
If sending verification email fails
- Defined in src/client/user-operations.ts:290

undo

undo(
    clientSessionId: string,
    scopes?: {
        application?: number;
        root?: boolean;
        table?: number;
        teamsInWorkspace?: number;
        view?: number;
        workspace?: number;
    },
): Promise<
    {
        actions: { action_scope: null
        | string; action_type: null | string }[];
        result_code: string;
    },
>
Undoes the latest undoable action performed by the user.
Parameters
- clientSessionId: string
  Client session ID header
- Optionalscopes: {
      application?: number;
      root?: boolean;
      table?: number;
      teamsInWorkspace?: number;
      view?: number;
      workspace?: number;
  }
  Optional scopes to filter actions
Returns Promise<
    {
        actions: { action_scope: null
        | string; action_type: null | string }[];
        result_code: string;
    },
>
Result of the undo operation

Throws
If undo fails
- Defined in src/client/user-operations.ts:337

updateAccount

updateAccount(
    options: {
        completedGuidedTours?: string[];
        completedOnboarding?: boolean;
        emailNotificationFrequency?: "instant" | "daily" | "weekly" | "never";
        firstName?: string;
        language?: string;
    },
): Promise<
    {
        completed_guided_tours: string[];
        completed_onboarding: boolean;
        email_notification_frequency: string;
        first_name: string;
        language: string;
    },
>
Updates the account information of the authenticated user.
Parameters
- options: {
      completedGuidedTours?: string[];
      completedOnboarding?: boolean;
      emailNotificationFrequency?: "instant" | "daily" | "weekly" | "never";
      firstName?: string;
      language?: string;
  }
  Account fields to update
Returns Promise<
    {
        completed_guided_tours: string[];
        completed_onboarding: boolean;
        email_notification_frequency: string;
        first_name: string;
        language: string;
    },
>
Updated account information

Throws
If update fails
- Defined in src/client/user-operations.ts:160

verifyEmail

verifyEmail(
    token: string,
): Promise<
    {
        access_token?: string;
        refresh_token?: string;
        user?: { first_name: string; language: string; username: string };
    },
>
Verifies a user's email address with a verification token.
Parameters
- token: string
  Email verification token
Returns Promise<
    {
        access_token?: string;
        refresh_token?: string;
        user?: { first_name: string; language: string; username: string };
    },
>
User information and tokens if unauthenticated

Throws
If email verification fails
- Defined in src/client/user-operations.ts:305

verifyToken

verifyToken(
token: string,
): Promise<
{ user: { first_name: string; language: string; username: string } },
>
Verifies if a JWT token is valid and returns user information.
Parameters
- token: string
  The JWT token to verify
Returns Promise<{ user: { first_name: string; language: string; username: string } }>
User information if token is valid

Throws
If the token is invalid
- Defined in src/client/user-operations.ts:77

Class UserOperations

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UserOperations

Methods

changePassword

Parameters

Returns Promise<void>

Throws

getDashboard

Returns Promise< { workspace_invitations: { created_on: string; email: string; email_exists: boolean; id: number; invited_by: string; message: string; workspace: string; }[]; },>

Throws

login

Parameters

Returns Promise< { access_token: string; refresh_token: string; user: { first_name: string; language: string; username: string }; },>

Throws

logout

Parameters

Returns Promise<void>

Throws

redo

Parameters

Returns Promise< { actions: { action_scope: null | string; action_type: null | string }[]; result_code: string; },>

Throws

refreshToken

Parameters

Returns Promise< { access_token: string; user: { first_name: string; language: string; username: string }; },>

Throws

register

Parameters

Returns Promise< { access_token?: string; refresh_token?: string; user: { first_name: string; language: string; username: string }; },>

Throws

resetPassword

Parameters

Returns Promise<void>

Throws

scheduleAccountDeletion

Returns Promise<void>

Throws

sendPasswordResetEmail

Parameters

Returns Promise<void>

Throws

sendVerifyEmail

Returns Promise<void>

Throws

undo

Parameters

Returns Promise< { actions: { action_scope: null | string; action_type: null | string }[]; result_code: string; },>

Throws

updateAccount

Parameters

Returns Promise< { completed_guided_tours: string[]; completed_onboarding: boolean; email_notification_frequency: string; first_name: string; language: string; },>

Throws

verifyEmail

Parameters

Returns Promise< { access_token?: string; refresh_token?: string; user?: { first_name: string; language: string; username: string }; },>

Throws

verifyToken

Parameters

Returns Promise<{ user: { first_name: string; language: string; username: string } }>

Throws

Settings

On This Page

Returns Promise<
{
workspace_invitations: {
created_on: string;
email: string;
email_exists: boolean;
id: number;
invited_by: string;
message: string;
workspace: string;
}[];
},
>

Returns Promise<
{
access_token: string;
refresh_token: string;
user: { first_name: string; language: string; username: string };
},
>

Returns Promise<
{
actions: { action_scope: null
| string; action_type: null | string }[];
result_code: string;
},
>

Returns Promise<
{
access_token: string;
user: { first_name: string; language: string; username: string };
},
>

Returns Promise<
{
access_token?: string;
refresh_token?: string;
user: { first_name: string; language: string; username: string };
},
>

Returns Promise<
{
actions: { action_scope: null
| string; action_type: null | string }[];
result_code: string;
},
>

Returns Promise<
{
completed_guided_tours: string[];
completed_onboarding: boolean;
email_notification_frequency: string;
first_name: string;
language: string;
},
>

Returns Promise<
{
access_token?: string;
refresh_token?: string;
user?: { first_name: string; language: string; username: string };
},
>