user

type Authenticator interface {
	// Authenticate validates a password of an existing User.
	Authenticate(ref, password string) (u *User, err error)
}

type EmailService interface {
	// RequestEmailChange starts a process of changing an email by
	// returning a token that must be used in ChangeEmail to authorize
	// email change.
	RequestEmailChange(ref, email string, validationDeadline time.Time) (token string, err error)
	// ChangeEmail changes an email of an existing User only if
	// provided token is valid.
	ChangeEmail(ref, token string) (*User, error)
	// EmailChangeToken retrieves a token to change an email if it exists.
	EmailChangeToken(ref, email string) (token string, err error)
}

type Error struct {
	// Message is a text that describes an error.
	Message string `json:"message"`
	// Code is a number that identifies error.
	// It allows error identification when serialization is involved.
	Code int `json:"code"`
}

type ManagementService interface {
	// User retrieves a User instance.
	User(ref string) (*User, error)
	// UserByID retrieves a User instance only by it's ID.
	UserByID(id string) (*User, error)
	// UserByID retrieves a User instance only by it's Email.
	UserByEmail(email string) (*User, error)
	// UserByID retrieves a User instance only by it's Username.
	UserByUsername(username string) (*User, error)
	// Create user creates a new user interface.
	CreateUser(o *Options) (*User, error)
	// UpdateUser changes data of an existing User.
	UpdateUser(ref string, o *Options) (*User, error)
	// SetPassword changes a password of an existing User.
	SetPassword(ref string, password string) error
	// DeleteUser deletes an existing User.
	DeleteUser(ref string) (*User, error)

	// UsersByID retrieves a paginated list of User instances ordered by
	// ID values.
	UsersByID(startID string, limit int) (*UsersPage, error)
	// UsersByEmail retrieves a paginated list of User instances ordered by
	// Email values.
	UsersByEmail(startEmail string, limit int) (*UsersPage, error)
	// UsersByUsername retrieves a paginated list of User instances ordered by
	// Username values.
	UsersByUsername(startUsername string, limit int) (*UsersPage, error)
}

type Options struct {
	Email                 *string `json:"email,omitempty"`
	Username              *string `json:"username,omitempty"`
	Name                  *string `json:"name,omitempty"`
	Admin                 *bool   `json:"admin,omitempty"`
	NotificationsDisabled *bool   `json:"notifications-disabled,omitempty"`
	EmailUnvalidated      *bool   `json:"email-unvalidated,omitempty"`
	Disabled              *bool   `json:"disabled,omitempty"`
}

type PasswordResetService interface {
	// RequestPasswordReset starts a process of reseting a password by
	// providing a token that must be used in ResetPassword to authorize
	// password reset.
	RequestPasswordReset(ref string) (token string, err error)
	// ResetPassword changes a password of an existing User only if
	// provided token is valid.
	ResetPassword(token, password string) error
}

type RegisterService interface {
	// RegisterUser is a method for adding new users.
	RegisterUser(o *Options, password string, emailValidationDeadline time.Time) (u *User, emailValidationToken string, err error)
}

type Service interface {
	ManagementService
	RegisterService
	PasswordResetService
	EmailService
	Authenticator
}

type User struct {
	ID                    string `json:"id"`
	Email                 string `json:"email"`
	Username              string `json:"username,omitempty"`
	Name                  string `json:"name,omitempty"`
	Admin                 bool   `json:"admin,omitempty"`
	NotificationsDisabled bool   `json:"notifications-disabled,omitempty"`
	EmailUnvalidated      bool   `json:"email-unvalidated,omitempty"`
	Disabled              bool   `json:"disabled,omitempty"`
}

type UsersPage struct {
	Users []User `json:"users"`
	// Previous is an reference that
	// can be used to retrieve previous page.
	Previous string `json:"previous"`
	// Previous is an reference that
	// can be used to retrieve next page.
	Next string `json:"next"`
	// Count is a number of User instances in this UserPage.
	Count int `json:"count"`
}