subscriptionaddon

package

v1.0.0-beta.220 Latest Latest Go to latest Published: Aug 17, 2025 License: Apache-2.0 Imports: 17 Imported by: 0

README ¶

Subscription Addon

This package contains the subscription addon related functionality.

Entity Relationship Diagram

erDiagram
    Subscription ||--|| SubscriptionAddon : "has (1:1)"
    SubscriptionAddon ||--o{ SubscriptionAddonQuantity : "has (1:N)"
    SubscriptionAddon ||--o{ SubscriptionAddonRateCard : "has (1:N) calculated from Addon"
    Addon ||--|| SubscriptionAddon : "has (1:1)"

    Subscription {
        string id PK
    }

    Addon {
        string id PK
    }

    SubscriptionAddon {
        string id PK
        string subscription_id FK
        string addon_id FK
    }

    SubscriptionAddonQuantity {
        string id PK
        string subscription_addon_id FK
    }

    SubscriptionAddonRateCard {

    }

Quirks

Feature resolution: When an addon creates a new SubscriptionItem (not a split of an existing one but a new item), the featureKey => feature resolution will happen at sync time. This means, that potentially, in a subscription, items with the same featureKey reference can point to different feature instances.

Documentation ¶

Index ¶

Constants
type ChangeQuantityEvent
- func NewChangeQuantityEvent(ctx context.Context, customer customer.Customer, ...) ChangeQuantityEvent
- func (s ChangeQuantityEvent) EventMetadata() metadata.EventMetadata
- func (s ChangeQuantityEvent) EventName() string
- func (s ChangeQuantityEvent) Validate() error
type CreateSubscriptionAddonInput
- func (i CreateSubscriptionAddonInput) Validate() error
type CreateSubscriptionAddonQuantityInput
- func (i CreateSubscriptionAddonQuantityInput) Validate() error
type CreateSubscriptionAddonQuantityRepositoryInput
type CreateSubscriptionAddonRepositoryInput
type CreatedEvent
- func NewCreatedEvent(ctx context.Context, customer customer.Customer, ...) CreatedEvent
- func (s CreatedEvent) EventMetadata() metadata.EventMetadata
- func (s CreatedEvent) EventName() string
- func (s CreatedEvent) Validate() error
type ListSubscriptionAddonRepositoryInput
type ListSubscriptionAddonsInput
- func (i ListSubscriptionAddonsInput) Validate() error
type Service
type SubscriptionAddon
- func (a SubscriptionAddon) GetInstanceAt(t time.Time) (SubscriptionAddonInstance, bool)
- func (a SubscriptionAddon) GetInstances() []SubscriptionAddonInstance
type SubscriptionAddonInstance
type SubscriptionAddonQuantity
- func (q SubscriptionAddonQuantity) AsTimed() timeutil.Timed[SubscriptionAddonQuantity]
type SubscriptionAddonQuantityRepository
type SubscriptionAddonRateCard
- func (a SubscriptionAddonRateCard) Apply(target productcatalog.RateCard, annotations models.Annotations) error
- func (a SubscriptionAddonRateCard) Restore(target productcatalog.RateCard, annotations models.Annotations, ...) error
type SubscriptionAddonRepository

Constants ¶

View Source

const (
	EventSubsystem metadata.EventSubsystem = "subscriptionaddon"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ChangeQuantityEvent ¶

type ChangeQuantityEvent event

func NewChangeQuantityEvent ¶

func NewChangeQuantityEvent(ctx context.Context, customer customer.Customer, subscriptionAddon SubscriptionAddon) ChangeQuantityEvent

NewChangeQuantityEvent creates a new deleted event

func (ChangeQuantityEvent) EventMetadata ¶

func (s ChangeQuantityEvent) EventMetadata() metadata.EventMetadata

func (ChangeQuantityEvent) EventName ¶

func (s ChangeQuantityEvent) EventName() string

func (ChangeQuantityEvent) Validate ¶

func (s ChangeQuantityEvent) Validate() error

type CreateSubscriptionAddonInput ¶

type CreateSubscriptionAddonInput struct {
	models.MetadataModel

	AddonID        string `json:"addonID"`
	SubscriptionID string `json:"subscriptionID"`

	InitialQuantity CreateSubscriptionAddonQuantityInput `json:"initialQuantity"`
}

func (CreateSubscriptionAddonInput) Validate ¶

func (i CreateSubscriptionAddonInput) Validate() error

type CreateSubscriptionAddonQuantityInput ¶

type CreateSubscriptionAddonQuantityInput struct {
	ActiveFrom time.Time `json:"activeFrom"`
	Quantity   int       `json:"quantity"`
}

func (CreateSubscriptionAddonQuantityInput) Validate ¶

func (i CreateSubscriptionAddonQuantityInput) Validate() error

type CreateSubscriptionAddonQuantityRepositoryInput ¶

type CreateSubscriptionAddonQuantityRepositoryInput struct {
	ActiveFrom time.Time `json:"activeFrom"`
	Quantity   int       `json:"quantity"`
}

SubscriptionAddonQuantity

type CreateSubscriptionAddonRepositoryInput ¶

type CreateSubscriptionAddonRepositoryInput struct {
	models.MetadataModel

	Name        string  `json:"name"`
	Description *string `json:"description,omitempty"`

	AddonID        string `json:"addonID"`
	SubscriptionID string `json:"subscriptionID"`
}

SubscriptionAddon

type CreatedEvent ¶

type CreatedEvent event

func NewCreatedEvent ¶

func NewCreatedEvent(ctx context.Context, customer customer.Customer, subscriptionAddon SubscriptionAddon) CreatedEvent

NewCreatedEvent creates a new created event

func (CreatedEvent) EventMetadata ¶

func (s CreatedEvent) EventMetadata() metadata.EventMetadata

func (CreatedEvent) EventName ¶

func (s CreatedEvent) EventName() string

func (CreatedEvent) Validate ¶

func (s CreatedEvent) Validate() error

type ListSubscriptionAddonRepositoryInput ¶

type ListSubscriptionAddonRepositoryInput struct {
	SubscriptionID string `json:"subscriptionID"`

	pagination.Page
}

type ListSubscriptionAddonsInput ¶

type ListSubscriptionAddonsInput struct {
	SubscriptionID string `json:"subscriptionID"`

	pagination.Page
}

func (ListSubscriptionAddonsInput) Validate ¶

func (i ListSubscriptionAddonsInput) Validate() error

type Service ¶

type Service interface {
	Create(ctx context.Context, namespace string, input CreateSubscriptionAddonInput) (*SubscriptionAddon, error)
	Get(ctx context.Context, id models.NamespacedID) (*SubscriptionAddon, error)
	List(ctx context.Context, namespace string, input ListSubscriptionAddonsInput) (pagination.PagedResponse[SubscriptionAddon], error)

	ChangeQuantity(ctx context.Context, id models.NamespacedID, input CreateSubscriptionAddonQuantityInput) (*SubscriptionAddon, error)
}

type SubscriptionAddon ¶

type SubscriptionAddon struct {
	models.NamespacedID
	models.ManagedModel
	models.MetadataModel

	Name        string  `json:"name"`
	Description *string `json:"description,omitempty"`

	// Maybe break up to AddonID + AddonMeta?
	Addon          addon.Addon `json:"addon"`
	SubscriptionID string      `json:"subscriptionID"`

	// RateCards is populated from the Addon's RateCards
	RateCards  []SubscriptionAddonRateCard                  `json:"rateCards"`
	Quantities timeutil.Timeline[SubscriptionAddonQuantity] `json:"quantities"`
}

func (SubscriptionAddon) GetInstanceAt ¶

func (a SubscriptionAddon) GetInstanceAt(t time.Time) (SubscriptionAddonInstance, bool)

func (SubscriptionAddon) GetInstances ¶

func (a SubscriptionAddon) GetInstances() []SubscriptionAddonInstance

type SubscriptionAddonInstance ¶

type SubscriptionAddonInstance struct {
	models.NamespacedID
	models.ManagedModel
	models.MetadataModel
	models.CadencedModel

	Name        string  `json:"name"`
	Description *string `json:"description,omitempty"`

	// AddonID        string `json:"addonID"`
	Addon          addon.Addon `json:"addon"`
	SubscriptionID string      `json:"subscriptionID"`

	RateCards []SubscriptionAddonRateCard `json:"rateCards"`
	Quantity  int                         `json:"quantity"`
}

SubscriptionAddonInstance is a "virtual" instance of a SubscriptionAddon: It merges the quantity information with the Addon information itself and represents the "effective" value of the addon for a given period.

type SubscriptionAddonQuantity ¶

type SubscriptionAddonQuantity struct {
	models.NamespacedID
	models.ManagedModel

	ActiveFrom time.Time `json:"activeFrom"`
	Quantity   int       `json:"quantity"`
}

func (SubscriptionAddonQuantity) AsTimed ¶

func (q SubscriptionAddonQuantity) AsTimed() timeutil.Timed[SubscriptionAddonQuantity]

type SubscriptionAddonQuantityRepository ¶

type SubscriptionAddonQuantityRepository interface {
	Create(ctx context.Context, subscriptionAddonID models.NamespacedID, input CreateSubscriptionAddonQuantityRepositoryInput) (*SubscriptionAddonQuantity, error)
}

type SubscriptionAddonRateCard ¶

type SubscriptionAddonRateCard struct {
	AddonRateCard addon.RateCard `json:"addonRateCard"`
}

func (SubscriptionAddonRateCard) Apply ¶

func (a SubscriptionAddonRateCard) Apply(target productcatalog.RateCard, annotations models.Annotations) error

Apply applies the addon rate card to the target rate card

func (SubscriptionAddonRateCard) Restore ¶

func (a SubscriptionAddonRateCard) Restore(target productcatalog.RateCard, annotations models.Annotations, instanceType productcatalog.AddonInstanceType) error

Restore restores the addon rate card to the target rate card TODO(galexi): instead of instance parameter, change SubscriptionAddonInstance type

type SubscriptionAddonRepository ¶

type SubscriptionAddonRepository interface {
	Create(ctx context.Context, namespace string, input CreateSubscriptionAddonRepositoryInput) (*models.NamespacedID, error)
	Get(ctx context.Context, id models.NamespacedID) (*SubscriptionAddon, error)
	List(ctx context.Context, namespace string, filter ListSubscriptionAddonRepositoryInput) (pagination.PagedResponse[SubscriptionAddon], error)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
diff
http
repo
service

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL