subscriber

type BalanceResult struct {
	Applied bool  `json:"-"`
	Balance int64 `json:"balance"`
}

type Entitlement struct {
	// RequestID is unique per grant, e.g. "order:42"; empty means the
	// write is not retryable and is not recorded.
	RequestID string
	UserID    uint
	Plan      PlanSnapshot
	// Period extends the expiry from now, or with RenewSamePlan from the
	// current expiry of the same, unexpired plan. ExpiresAt sets it
	// exactly. With neither, the expiry is unchanged.
	Period                 *Period
	ExpiresAt              *int64
	RenewSamePlan          bool
	ResetTraffic           bool
	KeepSubscriptionGroups bool
}

type EntitlementResult struct {
	// Applied is false when the request id was applied before; ExpiresAt
	// then describes that first application.
	Applied   bool   `json:"-"`
	ExpiresAt *int64 `json:"expires_at,omitempty"`
}

type GrantResult struct {
	// Applied is false when the request id was applied before; Created
	// then describes that first application.
	Applied bool `json:"-"`
	Created bool `json:"created"`
}

type GroupGrant struct {
	// RequestID is unique per grant; empty means the write is not
	// retryable and is not recorded.
	RequestID string
	UserID    uint
	GroupID   uint
	// ExpiresAt, TransferBytes and NextRenewPrice are set when non-nil and
	// left unchanged otherwise, as given.
	ExpiresAt      *int64
	TransferBytes  *int64
	NextRenewPrice *int64
}

type MembershipResult struct {
	Applied bool `json:"-"`
	// Removed counts the memberships deleted.
	Removed int64 `json:"removed"`
}

type Period struct {
	Months int
	Days   int
}

type PlanSnapshot struct {
	PlanID  uint
	GroupID uint
	// SubscriptionGroupIDs replace the subscriber's subscription groups,
	// unless the entitlement keeps them.
	SubscriptionGroupIDs []uint
	TransferBytes        int64
	// SpeedLimit and DeviceLimit are left unchanged when nil.
	SpeedLimit  *int64
	DeviceLimit *int
}

type ResetResult struct {
	Applied bool  `json:"-"`
	Reset   int64 `json:"reset"`
}

type TrafficEntry struct {
	UserID   uint
	Upload   int64
	Download int64
}

type TrafficResult struct {
	Applied bool `json:"-"`
	// Exhausted lists subscribers who crossed their transfer limit.
	Exhausted []uint `json:"exhausted,omitempty"`
}