signupgate

type AddOptions struct {
	// Note is free-text context for operators.
	Note string
	// InvitedBy labels the operator creating the invite.
	InvitedBy string
	// InvitedByPrincipal is the person creating the invite through the API.
	InvitedByPrincipal *uuid.UUID
	// ExpiresAt ends the invite; nil means it does not expire.
	ExpiresAt *time.Time
}

type Allowance struct {
	PrincipalID uuid.UUID
	Email       string
	// Granted is the allowance an operator set; nil means the default.
	Granted *int
	// Effective is Granted, or the deployment's default when it is nil.
	Effective int
	// Held is how many of the member's codes count against it.
	Held      int
	Note      string
	SetBy     *uuid.UUID
	UpdatedAt time.Time
}

type Code struct {
	ID                 uuid.UUID
	Kind               CodeKind
	Hint               string // last four characters
	Label              string
	Note               string
	CreatedByPrincipal *uuid.UUID
	CreatedByLabel     string
	MaxUses            int
	UseCount           int
	CreatedAt          time.Time
	ExpiresAt          *time.Time
	RevokedAt          *time.Time
}

type CodeFilter struct {
	// Kind keeps codes of one kind.
	Kind CodeKind
	// Label keeps codes with this label.
	Label string
	// CreatedBy keeps codes created by this principal.
	CreatedBy *uuid.UUID
	// ActiveOnly keeps codes that can still be used.
	ActiveOnly bool
}

type CodeKind string

type CodeOptions struct {
	// Kind is CodeOperator or CodeMember.
	Kind CodeKind
	// Label names the cohort, such as "launch-week".
	Label string
	// Note is free-text context for operators.
	Note string
	// CreatedByPrincipal is the person creating the code through the API.
	CreatedByPrincipal *uuid.UUID
	// CreatedByLabel labels an operator creating the code from the command
	// line.
	CreatedByLabel string
	// MaxUses is how many accounts the code may create; at least 1.
	MaxUses int
	// ExpiresAt ends the code; nil means it does not expire.
	ExpiresAt *time.Time
}

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

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

type GateOption func(*Gate)

type Invite struct {
	Email     string
	Note      string
	InvitedBy string
	// InvitedByPrincipal is the person who created the invite through the
	// API; nil for invites created from the command line.
	InvitedByPrincipal *uuid.UUID
	CreatedAt          time.Time
	ExpiresAt          *time.Time
	RedeemedAt         *time.Time
	RedeemedBy         *uuid.UUID
}

type MemberOptions struct {
	// DefaultAllowance is how many invite codes a member may hold when an
	// operator has not set their allowance. The default is 0: members invite
	// nobody until an operator allows it.
	DefaultAllowance int
	// CodeTTL is how long a member's invite code works. Zero means
	// DefaultMemberCodeTTL.
	CodeTTL time.Duration
}

type MemberSummary struct {
	Allowance int
	Held      int
	Remaining int
	// Codes are the member's codes, newest first, whatever their status.
	Codes []Code
	// CodeTTL is how long a new member code works.
	CodeTTL time.Duration
}

type Redemption struct {
	ID          uuid.UUID
	CodeID      uuid.UUID
	PrincipalID uuid.UUID
	Email       string
	CreatedAt   time.Time
	// The code's kind, label, hint and creator, for attribution.
	CodeKind           CodeKind
	CodeLabel          string
	CodeHint           string
	CodeCreatedBy      *uuid.UUID
	CodeCreatedByLabel string
}

type RedemptionFilter struct {
	// CodeID keeps accounts created with this code.
	CodeID *uuid.UUID
	// CreatedBy keeps accounts created with codes this principal created.
	CreatedBy *uuid.UUID
	// Label keeps accounts created with codes carrying this label.
	Label string
}

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

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

type WaitlistEntry struct {
	Email          string
	ConsentVersion string
	ConsentText    string
	// CreatedAt is when the address first joined; UpdatedAt when it was
	// last submitted.
	CreatedAt time.Time
	UpdatedAt time.Time
	// InvitedAt is when an operator invited the address from the waitlist;
	// nil until then.
	InvitedAt *time.Time
}