snapshot

Documentation

Index

• Constants
• type BalanceOperationType
• type EntitlementBalanceSnapshotEvent
  • func (e EntitlementBalanceSnapshotEvent) Spec() *spec.EventTypeSpec
  • func (e EntitlementBalanceSnapshotEvent) Validate() error
• type EntitlementValue

Constants

const (
	EventSnapshot spec.EventName = "snapshot"
)

Types

type BalanceOperationType

type BalanceOperationType string

const (
	BalanceOperationUpdate BalanceOperationType = "update"
	BalanceOperationDelete BalanceOperationType = "delete"
)

type EntitlementBalanceSnapshotEvent

type EntitlementBalanceSnapshotEvent struct {
	Entitlement entitlement.Entitlement `json:"entitlement"`
	Namespace   models.NamespaceID      `json:"namespace"`
	Subject     models.SubjectKeyAndID  `json:"subject"`
	Feature     productcatalog.Feature  `json:"feature"`
	// Operation is delete if the entitlement gets deleted, in that case the balance object is empty
	Operation BalanceOperationType `json:"operation"`

	// CalculatedAt specifies when the balance calculation was performed. It can be used to verify
	// in edge-worker if the store already contains the required item.
	CalculatedAt *time.Time `json:"calculatedAt,omitempty"`

	Balance            *EntitlementValue  `json:"balance,omitempty"`
	CurrentUsagePeriod *recurrence.Period `json:"currentUsagePeriod,omitempty"`
}

func (EntitlementBalanceSnapshotEvent) Spec

func (e EntitlementBalanceSnapshotEvent) Spec() *spec.EventTypeSpec

func (EntitlementBalanceSnapshotEvent) Validate

func (e EntitlementBalanceSnapshotEvent) Validate() error

type EntitlementValue

type EntitlementValue struct {
	// Balance Only available for metered entitlements. Metered entitlements are built around a balance calculation where feature usage is deducted from the issued grants. Balance represents the remaining balance of the entitlement, it's value never turns negative.
	Balance *float64 `json:"balance,omitempty"`

	// Config Only available for static entitlements. The JSON parsable config of the entitlement.
	Config *string `json:"config,omitempty"`

	// HasAccess Whether the subject has access to the feature. Shared across all entitlement types.
	HasAccess *bool `json:"hasAccess,omitempty"`

	// Overage Only available for metered entitlements. Overage represents the usage that wasn't covered by grants, e.g. if the subject had a total feature usage of 100 in the period but they were only granted 80, there would be 20 overage.
	Overage *float64 `json:"overage,omitempty"`

	// Usage Only available for metered entitlements. Returns the total feature usage in the current period.
	Usage *float64 `json:"usage,omitempty"`
}