credit

type Balance struct {
	LedgerID        LedgerID          `json:"id"`
	Metadata        map[string]string `json:"metadata,omitempty"`
	Subject         string            `json:"subject"`
	FeatureBalances []FeatureBalance  `json:"featureBalances"`
	GrantBalances   []GrantBalance    `json:"grantBalances"`
}

type Connector interface {
	// Ledger
	CreateLedger(ctx context.Context, ledger Ledger) (Ledger, error)
	ListLedgers(ctx context.Context, params ListLedgersParams) ([]Ledger, error)

	// Grant
	CreateGrant(ctx context.Context, grant Grant) (Grant, error)
	VoidGrant(ctx context.Context, grant Grant) (Grant, error)
	ListGrants(ctx context.Context, params ListGrantsParams) ([]Grant, error)
	GetGrant(ctx context.Context, grantID NamespacedGrantID) (Grant, error)

	// Credit
	GetBalance(ctx context.Context, ledgerID NamespacedLedgerID, cutline time.Time) (Balance, error)
	GetHistory(ctx context.Context, ledgerID NamespacedLedgerID, from time.Time, to time.Time, pagination Pagination) (LedgerEntryList, error)
	GetHighWatermark(ctx context.Context, ledgerID NamespacedLedgerID) (HighWatermark, error)
	Reset(ctx context.Context, reset Reset) (Reset, []Grant, error)

	// Feature
	CreateFeature(ctx context.Context, feature Feature) (Feature, error)
	DeleteFeature(ctx context.Context, featureID NamespacedFeatureID) error
	ListFeatures(ctx context.Context, params ListFeaturesParams) ([]Feature, error)
	GetFeature(ctx context.Context, featureID NamespacedFeatureID) (Feature, error)
}

type EntryType string

type ExpirationPeriod struct {
	// Count The expiration period count like 12 months.
	Count uint8 `json:"count,omitempty"`

	// Duration The expiration period duration like month.
	Duration ExpirationPeriodDuration `json:"duration,omitempty"`
}

type ExpirationPeriodDuration string

type Feature struct {
	Namespace string     `json:"-"`
	ID        *FeatureID `json:"id,omitempty"`

	// Name The name of the feature.
	Name string `json:"name"`

	// MeterSlug The meter that the feature is associated with and decreases grants by usage.
	MeterSlug string `json:"meterSlug,omitempty"`

	// MeterGroupByFilters Optional meter group by filters. Useful if the meter scope is broader than what feature tracks.
	MeterGroupByFilters *map[string]string `json:"meterGroupByFilters,omitempty"`

	// Read-only fields
	Archived *bool `json:"archived,omitempty"`

	CreatedAt *time.Time `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

type FeatureBalance struct {
	Feature
	Balance float64 `json:"balance"`
	Usage   float64 `json:"usage"`
}

type FeatureID string

type FeatureInvalidFiltersError struct {
	RequestedFilters    map[string]string
	MeterGroupByColumns []string
}

type FeatureNotFoundError struct {
	ID FeatureID
}

type FeatureOrderBy string

type FeatureWithNameAlreadyExistsError struct {
	Name string
	ID   FeatureID
}

type Grant struct {
	Namespace string `json:"-"`
	// ID is the readonly identifies of a grant.
	ID *GrantID `json:"id,omitempty"`

	// Parent ID is the readonly identifies of the grant's parent if any.
	ParentID *GrantID `json:"parentID,omitempty"`

	// Subject The subject to grant the amount to.
	LedgerID LedgerID `json:"ledgerID"`

	// Type The grant type.
	Type GrantType `json:"type"`

	// FeatureID The feature ID.
	FeatureID *FeatureID `json:"featureID"`

	// Amount The amount to grant. Can be positive or negative number.
	Amount float64 `json:"amount"`

	// Priority is a positive decimal numbers. With lower numbers indicating higher importance;
	// for example, a priority of 1 is more urgent than a priority of 2.
	// When there are several credit grants available for a single invoice, the system selects the credit with the highest priority.
	// In cases where credit grants share the same priority level, the grant closest to its expiration will be used first.
	// In the case of two credits have identical priorities and expiration dates, the system will use the credit that was created first.
	Priority uint8 `json:"priority"`

	// EffectiveAt The effective date.
	EffectiveAt time.Time `json:"effectiveAt"`

	// Expiration The expiration configuration.
	Expiration ExpirationPeriod `json:"expiration"`
	// ExpiresAt contains the exact expiration date calculated from effectiveAt and Expiration for rendering
	ExpiresAt time.Time `json:"expiresAt"`

	Metadata map[string]string `json:"metadata,omitempty"`

	// Rollover Grant rollover configuration.
	Rollover *GrantRollover `json:"rollover,omitempty"`

	// Void The voided date.
	Void bool `json:"void"`

	CreatedAt *time.Time `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

type GrantBalance struct {
	Grant
	Balance float64 `json:"balance"`
}

type GrantID string

type GrantNotFoundError struct {
	GrantID GrantID
}

type GrantRollover struct {
	// MaxAmount Maximum amount to rollover.
	MaxAmount *float64 `json:"maxAmount,omitempty"`

	// Type The rollover type to use:
	Type GrantRolloverType `json:"type"`
}

type GrantRolloverType string

type GrantType string

type HighWatermarBeforeError struct {
	Namespace     string
	LedgerID      LedgerID
	HighWatermark time.Time
}

type HighWatermark struct {
	LedgerID LedgerID  `ch:"ledger_id"`
	Time     time.Time `ch:"time"`
}

type Ledger struct {
	Namespace string `json:"-"`
	// ID is the ID of the ledger instance
	ID LedgerID `json:"id,omitempty"`

	// Subject specifies which metering subject this ledger is referring to
	Subject string `json:"subject"`

	Metadata map[string]string `json:"metadata,omitempty"`

	// CreatedAt is the time the ledger was created
	CreatedAt time.Time `json:"createdAt"`
}

type LedgerAlreadyExistsError struct {
	Ledger Ledger
}

type LedgerAlreadyExistsProblemResponse struct {
	*models.StatusProblem
	ConflictingEntity Ledger `json:"conflictingEntity"`
}

type LedgerEntry struct {
	ID        *GrantID        `json:"id,omitempty"`
	Type      LedgerEntryType `json:"type"`
	Time      time.Time       `json:"time"`
	FeatureID *FeatureID      `json:"featureId,omitempty"`
	Amount    *float64        `json:"amount,omitempty"`
	Period    *Period         `json:"period,omitempty"`
}

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

type LedgerEntryType string

type LedgerID string

type LedgerNotFoundError struct {
	LedgerID LedgerID
}

type LedgerOrderBy string

type ListFeaturesParams struct {
	Namespace       string
	IncludeArchived bool
	Offset          int
	Limit           int
	OrderBy         FeatureOrderBy
}

type ListGrantsParams struct {
	Namespace         string
	LedgerIDs         []LedgerID
	From              *time.Time
	To                *time.Time
	FromHighWatermark bool
	IncludeVoid       bool
	Limit             int
}

type ListLedgersParams struct {
	Namespace   string
	Subjects    []string
	SubjectLike string
	Offset      int
	Limit       int
	OrderBy     LedgerOrderBy
}

type LockErrNotObtainedError struct {
	Namespace string
	ID        LedgerID
}

type NamespacedFeatureID struct {
	Namespace string
	ID        FeatureID
}

type NamespacedGrantID struct {
	Namespace string
	ID        GrantID
}

type NamespacedLedgerID struct {
	Namespace string
	ID        LedgerID
}

type Pagination struct {
	Offset int
	Limit  int
}

type Period struct {
	From time.Time `json:"from"`
	To   time.Time `json:"to"`
}

type Reset struct {
	Namespace string `json:"-"`
	// ID is the readonly identifies of a reset.
	ID *GrantID `json:"id,omitempty"`

	// Subject The subject to grant the amount to.
	LedgerID LedgerID `json:"ledgerID"`

	// EffectiveAt The effective date, cannot be in the future.
	EffectiveAt time.Time `json:"effectiveAt"`
}