user

Documentation

Index

• type UserAPI
  • func New(ctx context.Context, logger *zap.Logger, storage storageTY.Plugin) *UserAPI
  • func (u *UserAPI) Delete(IDs []string) (int64, error)
  • func (u *UserAPI) Get(filters []storageTY.Filter) (userTY.User, error)
  • func (u *UserAPI) GetByEmail(email string) (userTY.User, error)
  • func (u *UserAPI) GetByID(ID string) (userTY.User, error)
  • func (u *UserAPI) GetByUsername(username string) (userTY.User, error)
  • func (u *UserAPI) GetEntityInterface() interface{}
  • func (u *UserAPI) Import(data interface{}) error
  • func (u *UserAPI) List(filters []storageTY.Filter, pagination *storageTY.Pagination) (*storageTY.Result, error)
  • func (u *UserAPI) Save(user *userTY.User) error
  • func (u *UserAPI) UpdateProfile(userData *userTY.UserProfileUpdate) error

Types

type UserAPI

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

func New

func New(ctx context.Context, logger *zap.Logger, storage storageTY.Plugin) *UserAPI

func (*UserAPI) Delete

func (u *UserAPI) Delete(IDs []string) (int64, error)

Delete items

func (*UserAPI) Get

func (u *UserAPI) Get(filters []storageTY.Filter) (userTY.User, error)

Get returns a item

func (*UserAPI) GetByEmail

func (u *UserAPI) GetByEmail(email string) (userTY.User, error)

GetByEmail returns a item

func (*UserAPI) GetByID

func (u *UserAPI) GetByID(ID string) (userTY.User, error)

GetByID returns a item

func (*UserAPI) GetByUsername

func (u *UserAPI) GetByUsername(username string) (userTY.User, error)

GetByUsername returns a item

func (*UserAPI) GetEntityInterface

func (u *UserAPI) GetEntityInterface() interface{}

func (*UserAPI) Import

func (u *UserAPI) Import(data interface{}) error

func (*UserAPI) List

func (u *UserAPI) List(filters []storageTY.Filter, pagination *storageTY.Pagination) (*storageTY.Result, error)

List by filter and pagination

func (*UserAPI) Save

func (u *UserAPI) Save(user *userTY.User) error

Save config into disk

func (*UserAPI) UpdateProfile

func (u *UserAPI) UpdateProfile(userData *userTY.UserProfileUpdate) error

UpdateProfile updates the user profile