creditdriver

Documentation

Index

• Constants
• type CreateFeatureHandler
• type CreateLedgerGrantHandler
• type CreateLedgerHandler
• type DeleteFeatureHandler
• type GetFeatureHandler
• type GetLedgerBalaceHandlerParams
• type GetLedgerBalanceHandler
• type GetLedgerBalanceRequest
• type GetLedgerGrantHandler
• type GetLedgerHistoryHandler
• type GetLedgerHistoryRequest
• type GrantPathParams
• type Handlers
  • func New(creditConnector credit.Connector, meterRepository meter.Repository, ...) Handlers
• type ListFeaturesHandler
• type ListLedgerGrantsByLedgerHandler
• type ListLedgerGrantsByLedgerParams
• type ListLedgerGrantsHandler
• type ListLedgersHandler
• type ResetLedgerHandler
• type VoidLedgerGrantHandler

Constants

const (
	// DefaultLedgerQueryLimit specifies how many entries to return by default for credit related queries
	DefaultLedgerQueryLimit = 1000

	// MaxLedgerQueryLimit specifies the maximum number of entries to return for credit related queries
	MaxLedgerQueryLimit = 1000
)

Types

type CreateFeatureHandler

type CreateFeatureHandler httptransport.Handler[credit.Feature, credit.Feature]

type CreateLedgerGrantHandler

type CreateLedgerGrantHandler httptransport.HandlerWithArgs[credit.Grant, credit.Grant, api.LedgerID]

type CreateLedgerHandler

type CreateLedgerHandler httptransport.Handler[credit.Ledger, credit.Ledger]

type DeleteFeatureHandler

type DeleteFeatureHandler httptransport.HandlerWithArgs[credit.NamespacedFeatureID, any, api.FeatureID]

type GetFeatureHandler

type GetFeatureHandler httptransport.HandlerWithArgs[credit.NamespacedFeatureID, credit.Feature, api.FeatureID]

type GetLedgerBalaceHandlerParams

type GetLedgerBalaceHandlerParams struct {
	LedgerID    api.LedgerID
	QueryParams api.GetLedgerBalanceParams
}

type GetLedgerBalanceHandler

type GetLedgerBalanceHandler httptransport.HandlerWithArgs[GetLedgerBalanceRequest, api.LedgerBalance, GetLedgerBalaceHandlerParams]

type GetLedgerBalanceRequest

type GetLedgerBalanceRequest struct {
	LedgerID credit.NamespacedLedgerID
	Cutline  time.Time
}

type GetLedgerGrantHandler

type GetLedgerGrantHandler httptransport.HandlerWithArgs[credit.NamespacedGrantID, credit.Grant, GrantPathParams]

type GetLedgerHistoryHandler

type GetLedgerHistoryHandler httptransport.HandlerWithArgs[GetLedgerHistoryRequest, []api.LedgerEntry, GetLedgerHistoryRequest]

type GetLedgerHistoryRequest

type GetLedgerHistoryRequest struct {
	api.GetLedgerHistoryParams
	// Namespace is filled by the request encoder
	Namespace string
	LedgerID  api.LedgerID
}

type GrantPathParams

type GrantPathParams struct {
	LedgerID api.LedgerID
	GrantID  api.LedgerGrantID
}

type Handlers

type Handlers struct {
	GetFeature    GetFeatureHandler
	ListFeatures  ListFeaturesHandler
	CreateFeature CreateFeatureHandler
	DeleteFeature DeleteFeatureHandler

	// Ledger
	CreateLedger     CreateLedgerHandler
	ListLedgers      ListLedgersHandler
	GetLedgerHistory GetLedgerHistoryHandler

	// Reset
	ResetLedger ResetLedgerHandler

	// Grant
	ListLedgerGrants         ListLedgerGrantsHandler
	ListLedgerGrantsByLedger ListLedgerGrantsByLedgerHandler
	CreateLedgerGrant        CreateLedgerGrantHandler
	VoidLedgerGrant          VoidLedgerGrantHandler
	GetLedgerGrant           GetLedgerGrantHandler

	// Balances
	GetLedgerBalance GetLedgerBalanceHandler
}

func New

func New(
	creditConnector credit.Connector,
	meterRepository meter.Repository,
	namespaceDecoder namespacedriver.NamespaceDecoder,
	options ...httptransport.HandlerOption,
) Handlers

type ListFeaturesHandler

type ListFeaturesHandler httptransport.HandlerWithArgs[credit.ListFeaturesParams, []credit.Feature, api.ListFeaturesParams]

type ListLedgerGrantsByLedgerHandler

type ListLedgerGrantsByLedgerHandler httptransport.HandlerWithArgs[credit.ListGrantsParams, []api.LedgerGrantResponse, ListLedgerGrantsByLedgerParams]

type ListLedgerGrantsByLedgerParams

type ListLedgerGrantsByLedgerParams struct {
	LedgerID credit.LedgerID
	Params   api.ListLedgerGrantsByLedgerParams
}

type ListLedgerGrantsHandler

type ListLedgerGrantsHandler httptransport.HandlerWithArgs[credit.ListGrantsParams, []api.LedgerGrantResponse, api.ListLedgerGrantsParams]

type ListLedgersHandler

type ListLedgersHandler httptransport.HandlerWithArgs[credit.ListLedgersParams, []credit.Ledger, api.ListLedgersParams]

type ResetLedgerHandler

type ResetLedgerHandler httptransport.HandlerWithArgs[credit.Reset, credit.Reset, api.LedgerID]

type VoidLedgerGrantHandler

type VoidLedgerGrantHandler httptransport.HandlerWithArgs[credit.Grant, credit.Grant, GrantPathParams]