schema

Documentation

Index

• type APIKey
• type CachedSite
• type CheckStatEmail
• type CreateSiteEmail
• type EmailVerificationCode
• type FeedbackEmail
• type Goal
• type IntroEmail
• type Invitation
• type Model
• type MonthlyReport
• type SentMonthlyReport
• type SentRenewalNotification
• type SentWeeklyReport
• type SharedLink
• type Site
• type SiteMembership
• type SpikeNotification
• type Subscription
• type User
• type WeeklyReport

Types

type APIKey

type APIKey struct {
	Model
	UserID                uint64 `gorm:"not null"`
	Name                  string `gorm:"not null"`
	Scopes                string `gorm:"not null;default:stats:read:*"`
	HourlyAPIRequestLimit uint   `gorm:"not null;default:1000"`
	KeyPrefix             string
	KeyHash               string
	UsedAt                time.Time
}

type CachedSite

type CachedSite struct {
	ID                          uint64
	Domain                      string
	StatsStartDate              time.Time
	IngestRateLimitScaleSeconds uint64
	IngestRateLimitThreshold    sql.NullInt64
	UserID                      uint64
}

type CheckStatEmail

type CheckStatEmail struct {
	Model
	UserID uint64
}

type CreateSiteEmail

type CreateSiteEmail struct {
	Model
	UserID uint64
}

type EmailVerificationCode

type EmailVerificationCode struct {
	Model
	Code   uint64
	UserID sql.NullInt64
}

type FeedbackEmail

type FeedbackEmail struct {
	Model
	UserID uint64
}

type Goal

type Goal struct {
	Model
	Domain    string `gorm:"index"`
	EventName string
	PagePath  string
}

type IntroEmail

type IntroEmail struct {
	Model
	UserID uint64
}

type Invitation

type Invitation struct {
	Model
	Email  string `gorm:"not null;uniqueIndex"`
	SiteID uint64 `gorm:"uniqueIndex"`
	UserID uint64 `gorm:"uniqueIndex"`
	Role   string `gorm:"not null;check:role in ('owner', 'admin', 'viewer')"`
}

type Model

type Model struct {
	ID        uint64    `gorm:"primarykey;autoIncrement:true" json:"id"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`
}

type MonthlyReport

type MonthlyReport struct {
	Model
	SiteID uint64
	Email  string
}

type SentMonthlyReport

type SentMonthlyReport struct {
	Model
	SiteID uint64
	Year   int
	Week   int
}

type SentRenewalNotification

type SentRenewalNotification struct {
	Model
	UserID uint64
}

type SentWeeklyReport

type SentWeeklyReport struct {
	Model
	SiteID uint64
	Year   int
	Week   int
}

type SharedLink

type SharedLink struct {
	Model
	Name         string `gorm:"uniqueIndex;not null"`
	Slug         string `gorm:"uniqueIndex"`
	SiteID       uint64
	PasswordHash string
}

type Site

type Site struct {
	Model
	Domain          string    `gorm:"uniqueIndex" json:"domain"`
	Timezone        string    `gorm:"default:UTC" json:"timezone"`
	Public          bool      `gorm:"not null;default:false" json:"public"`
	StatsStartDate  time.Time `json:"statsStartDate"`
	IngestRateLimit sql.NullFloat64

	Users              []*User              `gorm:"many2many:site_memberships;" json:"-"`
	SentWeeklyReports  []*SentWeeklyReport  `json:"sentWeeklyReports,omitempty"`
	SentMonthlyReports []*SentMonthlyReport `json:"sentMonthlyReports,omitempty"`

	WeeklyReport      *WeeklyReport      `json:"weeklyReport,omitempty"`
	MonthlyReports    *MonthlyReport     `json:"monthlyReports,omitempty"`
	SpikeNotification *SpikeNotification `gorm:"constraint:OnDelete:CASCADE;" json:"spikeNotification,omitempty"`

	Invitations     []*Invitation     `gorm:"constraint:OnDelete:CASCADE;" json:"invitations,omitempty"`
	SiteMemberships []*SiteMembership `json:"siteMemberships,omitempty"`
	SharedLinks     []*SharedLink     `json:"sharedLinks,omitempty"`
}

type SiteMembership

type SiteMembership struct {
	Model
	UserID uint64 `gorm:"primaryKey"`
	User   *User
	SiteID uint64 `gorm:"primaryKey"`
	Site   *Site
	Role   string `gorm:"not null;default:'owner';check:role in ('owner', 'admin', 'viewer')"`
}

type SpikeNotification

type SpikeNotification struct {
	Model
	SiteID     uint64 `gorm:"uniqueIndex"`
	Threshold  uint
	LastSent   time.Time
	Recipients string
}

type Subscription

type Subscription struct {
	Model
	UserID         int
	PlanID         uint64    `gorm:"not null"`
	UpdateURL      string    `gorm:"not null"`
	CancelURL      string    `gorm:"not null"`
	Status         string    `gorm:"not null;check:status in ('active', 'past_due', 'deleted', 'paused')"`
	NextBillAmount string    `gorm:"not null"`
	NextBillDate   time.Time `gorm:"not null"`
	LastBillDate   time.Time
}

type User

type User struct {
	Model
	Name         string
	Email        string `gorm:"uniqueIndex"`
	PasswordHash string
	Sites        []*Site `gorm:"many2many:site_memberships;"`

	EmailVerificationCodes  []*EmailVerificationCode `gorm:"constraint:OnDelete:CASCADE;"`
	IntroEmails             []*IntroEmail            `gorm:"constraint:OnDelete:CASCADE;"`
	FeedbackEmails          []*FeedbackEmail         `gorm:"constraint:OnDelete:CASCADE;"`
	CreateSiteEmails        []*CreateSiteEmail       `gorm:"constraint:OnDelete:CASCADE;"`
	CheckStatEmail          []*CheckStatEmail        `gorm:"constraint:OnDelete:CASCADE;"`
	SentRenewalNotification []*SentRenewalNotification
	APIKeys                 []*APIKey
	Subscription            *Subscription
	LastSeen                time.Time
	EmailVerified           bool `gorm:"not null;default:false"`
	Invitations             []*Invitation
}

type WeeklyReport

type WeeklyReport struct {
	Model
	SiteID     uint64
	Recipients string
}