domain

Documentation

Index

• type AuthCredentials
• type Bill
• type Contact
• type House
• type Identifier
• type LoginResponse
• type OTP
• type Residence
• type User
• type UserPIN

Types

type AuthCredentials

type AuthCredentials struct {
	RefreshToken string    `json:"refreshToken"`
	IDToken      string    `json:"idToken"`
	ExpiresIn    time.Time `json:"expiresIn"`
}

type Bill

type Bill struct {
	ID      string  `gorm:"column:id"`
	Active  bool    `gorm:"column:active"`
	Type    string  `gorm:"column:type"`
	Amount  float64 `gorm:"column:amount"`
	Penalty float64 `gorm:"column:penalty"`
	UserID  string  `gorm:"column:user_id"`
}

ADDITIONAL BILLS

type Contact

type Contact struct {
	ID           string        `json:"id"`
	Active       bool          `json:"active"`
	ContactType  string        `json:"contact_type"`
	ContactValue string        `json:"contact_value"`
	Flavour      enums.Flavour `json:"flavour"`
	UserID       string        `json:"user_id"`
}

type House

type House struct {
	ID          string  `json:"id"`
	Active      bool    `json:"active"`
	Number      string  `json:"number"`
	Category    string  `json:"category"`
	Class       string  `json:"class"` // applicable where houses maybe charged differently due to size
	RentValue   float64 `json:"rentValue"`
	State       string  `json:"state"`
	ResidenceID string  `json:"residence_id"`
}

House details

type Identifier

type Identifier struct {
	ID              string               `json:"id"`
	Active          bool                 `json:"active"`
	IdentifierType  enums.IdentifierType `json:"identifierType"`
	IdentifierValue string               `json:"identifierValue"`
	UserID          string               `json:"userID"`
}

type LoginResponse

type LoginResponse struct {
	ID                string       `json:"id"`
	Username          string       `json:"username"`
	FirstName         string       `json:"first_name"`
	LastName          string       `json:"last_name"`
	UserContact       Contact      `json:"contact"`
	ManagedResidences []*Residence `json:"managed_residences"`
	AuthToken         string       `json:"auth_token"`
	RefreshToken      string       `json:"refresh_token"`
	CurrentResidence  Residence    `json:"current_residence"`
}

type OTP

type OTP struct {
	ID          string        `gorm:"column:id"`
	IsValid     bool          `gorm:"column:is_valid"`
	ValidUntil  time.Time     `gorm:"column:valid_until"`
	PhoneNumber string        `gorm:"column:phone_number"`
	OTP         string        `gorm:"column:otp"`
	Flavour     enums.Flavour `gorm:"column:flavour"`
	Medium      string        `gorm:"column:medium"`
	UserID      string        `gorm:"column:user_id"`
}

type Residence

type Residence struct {
	ID                 string `gorm:"column:id"`
	Active             bool   `gorm:"column:active"`
	Name               string `gorm:"column:name"`
	RegistrationNumber string `gorm:"column:registration_number"`
	Location           string `gorm:"column:location"`
	LivingRoomsCount   int    `gorm:"column:living_rooms_count"`
	Owner              string `gorm:"column:owner"`
}

type User

type User struct {
	ID               string          `json:"id"`
	FirstName        string          `json:"firstName"`
	MiddleName       string          `json:"middleName"`
	LastName         string          `json:"lastName"`
	Active           bool            `json:"active"`
	Flavour          enums.Flavour   `json:"flavour"`
	UserName         string          `json:"username"`
	UserType         string          `json:"userType"`
	UserIdentifier   Identifier      `json:"userIdentifier"`
	UserContact      Contact         `json:"userContact"`
	DeviceToken      string          `json:"deviceToken"`
	Residence        string          `json:"residence"`
	CurrentResidence string          `json:"currentResidence"`
	CurrentHouse     string          `json:"currentHouse"`
	AuthCredentials  AuthCredentials `json:"authCredentials"`
}

type UserPIN

type UserPIN struct {
	ID        string        `json:"id"`
	Active    bool          `json:"active"`
	Flavour   enums.Flavour `json:"flavour"`
	ValidFrom time.Time     `json:"valid_from"`
	ValidTo   time.Time     `json:"valid_to"`
	HashedPIN string        `json:"hashed_pin"`
	Salt      string        `json:"salt"`
	UserID    string        `json:"user_id"`
}