cli

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 1, 2025 License: MIT Imports: 11 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	UserData = &UserDataCli{
		CliUsingConfig: CliUsingConfig{
			container: settings.Container,
		},
		accounts:                services.Accounts,
		transactions:            services.Transactions,
		categories:              services.TransactionCategories,
		tags:                    services.TransactionTags,
		users:                   services.Users,
		twoFactorAuthorizations: services.TwoFactorAuthorizations,
		tokens:                  services.Tokens,
		forgetPasswords:         services.ForgetPasswords,
	}
)

Initialize a user data cli singleton instance

Functions

This section is empty.

Types

type CliUsingConfig added in v0.6.0

type CliUsingConfig struct {
	// contains filtered or unexported fields
}

CliUsingConfig represents a cli that need to use config

func (*CliUsingConfig) CurrentConfig added in v0.6.0

func (l *CliUsingConfig) CurrentConfig() *settings.Config

CurrentConfig returns the current config

type UserDataCli

type UserDataCli struct {
	CliUsingConfig
	// contains filtered or unexported fields
}

UserDataCli represents user data cli

func (*UserDataCli) AddNewUser

func (l *UserDataCli) AddNewUser(c *core.CliContext, username string, email string, nickname string, password string, defaultCurrency string) (*models.User, error)

AddNewUser adds a new user according to specified info

func (*UserDataCli) AddUserFeatureRestrictions added in v0.7.0

func (l *UserDataCli) AddUserFeatureRestrictions(c *core.CliContext, username string, featureRestriction core.UserFeatureRestrictions) error

AddUserFeatureRestrictions adds user feature restrictions according to the specified user name

func (*UserDataCli) CheckTransactionAndAccount

func (l *UserDataCli) CheckTransactionAndAccount(c *core.CliContext, username string) (bool, error)

CheckTransactionAndAccount checks whether all user transactions and all user accounts are correct

func (*UserDataCli) ClearUserTokens

func (l *UserDataCli) ClearUserTokens(c *core.CliContext, username string) error

ClearUserTokens clears all tokens of the specified user

func (*UserDataCli) CreateNewUserToken added in v0.7.0

func (l *UserDataCli) CreateNewUserToken(c *core.CliContext, username string) (*models.TokenRecord, string, error)

CreateNewUserToken returns a new token for the specified user

func (*UserDataCli) DeleteUser

func (l *UserDataCli) DeleteUser(c *core.CliContext, username string) error

DeleteUser deletes user according to the specified user name

func (*UserDataCli) DisableUser added in v0.4.0

func (l *UserDataCli) DisableUser(c *core.CliContext, username string) error

DisableUser sets user disabled according to the specified user name

func (*UserDataCli) DisableUserTwoFactorAuthorization

func (l *UserDataCli) DisableUserTwoFactorAuthorization(c *core.CliContext, username string) error

DisableUserTwoFactorAuthorization disables 2fa for the specified user

func (*UserDataCli) EnableUser added in v0.4.0

func (l *UserDataCli) EnableUser(c *core.CliContext, username string) error

EnableUser sets user enabled according to the specified user name

func (*UserDataCli) ExportTransaction

func (l *UserDataCli) ExportTransaction(c *core.CliContext, username string, fileType string) ([]byte, error)

ExportTransaction returns csv file content according user all transactions

func (*UserDataCli) FixTransactionTagIndexWithTransactionTime added in v0.5.0

func (l *UserDataCli) FixTransactionTagIndexWithTransactionTime(c *core.CliContext, username string) (bool, error)

FixTransactionTagIndexWithTransactionTime fixes user transaction tag index data with transaction time

func (*UserDataCli) GetUserByUsername

func (l *UserDataCli) GetUserByUsername(c *core.CliContext, username string) (*models.User, error)

GetUserByUsername returns user by user name

func (*UserDataCli) ImportTransaction added in v0.6.0

func (l *UserDataCli) ImportTransaction(c *core.CliContext, username string, fileType string, data []byte) error

func (*UserDataCli) ListUserTokens

func (l *UserDataCli) ListUserTokens(c *core.CliContext, username string) ([]*models.TokenRecord, error)

ListUserTokens returns all tokens of the specified user

func (*UserDataCli) ModifyUserPassword

func (l *UserDataCli) ModifyUserPassword(c *core.CliContext, username string, password string) error

ModifyUserPassword modifies user password

func (*UserDataCli) RemoveUserFeatureRestrictions added in v0.7.0

func (l *UserDataCli) RemoveUserFeatureRestrictions(c *core.CliContext, username string, featureRestriction core.UserFeatureRestrictions) error

RemoveUserFeatureRestrictions removes user feature restrictions according to the specified user name

func (*UserDataCli) ResendVerifyEmail added in v0.4.0

func (l *UserDataCli) ResendVerifyEmail(c *core.CliContext, username string) error

ResendVerifyEmail resends an email with account activation link

func (*UserDataCli) SendPasswordResetMail added in v0.4.0

func (l *UserDataCli) SendPasswordResetMail(c *core.CliContext, username string) error

SendPasswordResetMail sends an email with password reset link

func (*UserDataCli) SetUserEmailUnverified added in v0.4.0

func (l *UserDataCli) SetUserEmailUnverified(c *core.CliContext, username string) error

SetUserEmailUnverified sets user email address unverified

func (*UserDataCli) SetUserEmailVerified added in v0.4.0

func (l *UserDataCli) SetUserEmailVerified(c *core.CliContext, username string) error

SetUserEmailVerified sets user email address verified

func (*UserDataCli) SetUserFeatureRestrictions added in v0.7.0

func (l *UserDataCli) SetUserFeatureRestrictions(c *core.CliContext, username string, featureRestriction core.UserFeatureRestrictions) error

SetUserFeatureRestrictions sets user feature restrictions according to the specified user name

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL