entitlementdriverv2

Documentation

Index

• Variables
• func MapAPIGrantV2ToCreateGrantInput(g api.EntitlementGrantCreateInputV2) (meteredentitlement.CreateEntitlementGrantInputs, error)
• func MapEntitlementGrantToAPIV2(grant *meteredentitlement.EntitlementGrant) api.EntitlementGrantV2
• func ParseAPICreateInputV2(inp *api.EntitlementV2CreateInputs, ns string, ...) (entitlement.CreateEntitlementInputs, ...)
• type CreateCustomerEntitlementGrantHandler
• type CreateCustomerEntitlementGrantHandlerParams
• type CreateCustomerEntitlementGrantHandlerRequest
• type CreateCustomerEntitlementGrantHandlerResponse
• type CreateCustomerEntitlementHandler
• type CreateCustomerEntitlementHandlerParams
• type CreateCustomerEntitlementHandlerRequest
• type CreateCustomerEntitlementHandlerResponse
• type DeleteCustomerEntitlementHandler
• type DeleteCustomerEntitlementHandlerParams
• type DeleteCustomerEntitlementHandlerRequest
• type DeleteCustomerEntitlementHandlerResponse
• type EntitlementHandler
  • func NewEntitlementHandler(connector entitlement.Service, balanceConnector meteredentitlement.Connector, ...) EntitlementHandler
• type GetCustomerEntitlementHandler
• type GetCustomerEntitlementHandlerParams
• type GetCustomerEntitlementHandlerRequest
• type GetCustomerEntitlementHandlerResponse
• type GetCustomerEntitlementHistoryHandler
• type GetCustomerEntitlementHistoryHandlerParams
• type GetCustomerEntitlementHistoryHandlerRequest
• type GetCustomerEntitlementHistoryHandlerResponse
• type GetEntitlementHandler
• type GetEntitlementHandlerParams
• type GetEntitlementHandlerRequest
• type GetEntitlementHandlerResponse
• type ListCustomerEntitlementGrantsHandler
• type ListCustomerEntitlementGrantsHandlerParams
• type ListCustomerEntitlementGrantsHandlerRequest
• type ListCustomerEntitlementGrantsHandlerResponse
• type ListCustomerEntitlementsHandler
• type ListCustomerEntitlementsHandlerParams
• type ListCustomerEntitlementsHandlerRequest
• type ListCustomerEntitlementsHandlerResponse
• type ListEntitlementsHandler
• type ListEntitlementsHandlerParams
• type ListEntitlementsHandlerRequest
• type ListEntitlementsHandlerResponse
• type OverrideCustomerEntitlementHandler
• type OverrideCustomerEntitlementHandlerParams
• type OverrideCustomerEntitlementHandlerRequest
• type OverrideCustomerEntitlementHandlerResponse
• type ResetCustomerEntitlementUsageHandler
• type ResetCustomerEntitlementUsageHandlerParams
• type ResetCustomerEntitlementUsageHandlerRequest
• type ResetCustomerEntitlementUsageHandlerResponse

Variables

var ParserV2 = parserV2{}

Functions

func MapAPIGrantV2ToCreateGrantInput

func MapAPIGrantV2ToCreateGrantInput(g api.EntitlementGrantCreateInputV2) (meteredentitlement.CreateEntitlementGrantInputs, error)

func MapEntitlementGrantToAPIV2

func MapEntitlementGrantToAPIV2(grant *meteredentitlement.EntitlementGrant) api.EntitlementGrantV2

func ParseAPICreateInputV2

func ParseAPICreateInputV2(inp *api.EntitlementV2CreateInputs, ns string, usageAttribution streaming.CustomerUsageAttribution) (entitlement.CreateEntitlementInputs, []entitlement.CreateEntitlementGrantInputs, error)

Types

type CreateCustomerEntitlementGrantHandler

type CreateCustomerEntitlementGrantHandler = httptransport.HandlerWithArgs[CreateCustomerEntitlementGrantHandlerRequest, CreateCustomerEntitlementGrantHandlerResponse, CreateCustomerEntitlementGrantHandlerParams]

CreateCustomerEntitlementGrant Creates a grant for a customer's entitlement (POST /api/v2/customers/{customerIdOrKey}/entitlements/{featureKey}/grants)

type CreateCustomerEntitlementGrantHandlerParams

type CreateCustomerEntitlementGrantHandlerParams struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
}

CreateCustomerEntitlementGrant Creates a grant for a customer's entitlement (POST /api/v2/customers/{customerIdOrKey}/entitlements/{featureKey}/grants)

type CreateCustomerEntitlementGrantHandlerRequest

type CreateCustomerEntitlementGrantHandlerRequest struct {
	CustomerID                string
	EntitlementIdOrFeatureKey string
	Namespace                 string
	GrantInput                meteredentitlement.CreateEntitlementGrantInputs
}

CreateCustomerEntitlementGrant Creates a grant for a customer's entitlement (POST /api/v2/customers/{customerIdOrKey}/entitlements/{featureKey}/grants)

type CreateCustomerEntitlementGrantHandlerResponse

type CreateCustomerEntitlementGrantHandlerResponse = api.EntitlementGrantV2

CreateCustomerEntitlementGrant Creates a grant for a customer's entitlement (POST /api/v2/customers/{customerIdOrKey}/entitlements/{featureKey}/grants)

type CreateCustomerEntitlementHandler

type CreateCustomerEntitlementHandler httptransport.HandlerWithArgs[CreateCustomerEntitlementHandlerRequest, CreateCustomerEntitlementHandlerResponse, CreateCustomerEntitlementHandlerParams]

type CreateCustomerEntitlementHandlerParams

type CreateCustomerEntitlementHandlerParams = string // customerIdOrKey

type CreateCustomerEntitlementHandlerRequest

type CreateCustomerEntitlementHandlerRequest = struct {
	Namespace       string
	CustomerIDOrKey string
	APIInput        *api.EntitlementV2CreateInputs
}

type CreateCustomerEntitlementHandlerResponse

type CreateCustomerEntitlementHandlerResponse = api.EntitlementV2

type DeleteCustomerEntitlementHandler

type DeleteCustomerEntitlementHandler httptransport.HandlerWithArgs[DeleteCustomerEntitlementHandlerRequest, DeleteCustomerEntitlementHandlerResponse, DeleteCustomerEntitlementHandlerParams]

type DeleteCustomerEntitlementHandlerParams

type DeleteCustomerEntitlementHandlerParams struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
}

type DeleteCustomerEntitlementHandlerRequest

type DeleteCustomerEntitlementHandlerRequest struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
	Namespace                 string
}

type DeleteCustomerEntitlementHandlerResponse

type DeleteCustomerEntitlementHandlerResponse = interface{}

type EntitlementHandler

type EntitlementHandler interface {
	CreateCustomerEntitlement() CreateCustomerEntitlementHandler
	ListCustomerEntitlements() ListCustomerEntitlementsHandler
	GetCustomerEntitlement() GetCustomerEntitlementHandler
	DeleteCustomerEntitlement() DeleteCustomerEntitlementHandler
	OverrideCustomerEntitlement() OverrideCustomerEntitlementHandler
	ListCustomerEntitlementGrants() ListCustomerEntitlementGrantsHandler
	CreateCustomerEntitlementGrant() CreateCustomerEntitlementGrantHandler
	GetCustomerEntitlementHistory() GetCustomerEntitlementHistoryHandler
	ResetCustomerEntitlementUsage() ResetCustomerEntitlementUsageHandler
	ListEntitlements() ListEntitlementsHandler
	GetEntitlement() GetEntitlementHandler
}

EntitlementHandler exposes V2 customer entitlement endpoints

func NewEntitlementHandler

func NewEntitlementHandler(
	connector entitlement.Service,
	balanceConnector meteredentitlement.Connector,
	customerService customer.Service,
	namespaceDecoder namespacedriver.NamespaceDecoder,
	options ...httptransport.HandlerOption,
) EntitlementHandler

type GetCustomerEntitlementHandler

type GetCustomerEntitlementHandler httptransport.HandlerWithArgs[GetCustomerEntitlementHandlerRequest, GetCustomerEntitlementHandlerResponse, GetCustomerEntitlementHandlerParams]

type GetCustomerEntitlementHandlerParams

type GetCustomerEntitlementHandlerParams struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
}

type GetCustomerEntitlementHandlerRequest

type GetCustomerEntitlementHandlerRequest struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
	Namespace                 string
}

type GetCustomerEntitlementHandlerResponse

type GetCustomerEntitlementHandlerResponse = *api.EntitlementV2

type GetCustomerEntitlementHistoryHandler

type GetCustomerEntitlementHistoryHandler = httptransport.HandlerWithArgs[GetCustomerEntitlementHistoryHandlerRequest, GetCustomerEntitlementHistoryHandlerResponse, GetCustomerEntitlementHistoryHandlerParams]

GetCustomerEntitlementHistory (GET /api/v2/customers/{customerIdOrKey}/entitlements/{featureKey}/history)

type GetCustomerEntitlementHistoryHandlerParams

type GetCustomerEntitlementHistoryHandlerParams struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
	Params                    api.GetCustomerEntitlementHistoryV2Params
}

GetCustomerEntitlementHistory (GET /api/v2/customers/{customerIdOrKey}/entitlements/{featureKey}/history)

type GetCustomerEntitlementHistoryHandlerRequest

type GetCustomerEntitlementHistoryHandlerRequest struct {
	Namespace     string
	CustomerID    string
	EntitlementID string
	Params        api.GetCustomerEntitlementHistoryV2Params
}

GetCustomerEntitlementHistory (GET /api/v2/customers/{customerIdOrKey}/entitlements/{featureKey}/history)

type GetCustomerEntitlementHistoryHandlerResponse

type GetCustomerEntitlementHistoryHandlerResponse = api.WindowedBalanceHistory

GetCustomerEntitlementHistory (GET /api/v2/customers/{customerIdOrKey}/entitlements/{featureKey}/history)

type GetEntitlementHandler

type GetEntitlementHandler httptransport.HandlerWithArgs[GetEntitlementHandlerRequest, GetEntitlementHandlerResponse, GetEntitlementHandlerParams]

type GetEntitlementHandlerParams

type GetEntitlementHandlerParams struct {
	EntitlementId string
}

type GetEntitlementHandlerRequest

type GetEntitlementHandlerRequest struct {
	EntitlementId string
	Namespace     string
}

type GetEntitlementHandlerResponse

type GetEntitlementHandlerResponse = *api.EntitlementV2

type ListCustomerEntitlementGrantsHandler

type ListCustomerEntitlementGrantsHandler = httptransport.HandlerWithArgs[ListCustomerEntitlementGrantsHandlerRequest, ListCustomerEntitlementGrantsHandlerResponse, ListCustomerEntitlementGrantsHandlerParams]

type ListCustomerEntitlementGrantsHandlerParams

type ListCustomerEntitlementGrantsHandlerParams struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
	Params                    api.ListCustomerEntitlementGrantsV2Params
}

type ListCustomerEntitlementGrantsHandlerRequest

type ListCustomerEntitlementGrantsHandlerRequest struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
	Namespace                 string
	Params                    api.ListCustomerEntitlementGrantsV2Params
}

type ListCustomerEntitlementGrantsHandlerResponse

type ListCustomerEntitlementGrantsHandlerResponse = api.GrantV2PaginatedResponse

type ListCustomerEntitlementsHandler

type ListCustomerEntitlementsHandler httptransport.HandlerWithArgs[ListCustomerEntitlementsHandlerRequest, ListCustomerEntitlementsHandlerResponse, ListCustomerEntitlementsHandlerParams]

type ListCustomerEntitlementsHandlerParams

type ListCustomerEntitlementsHandlerParams struct {
	CustomerIdOrKey string
	Params          api.ListCustomerEntitlementsV2Params
}

type ListCustomerEntitlementsHandlerRequest

type ListCustomerEntitlementsHandlerRequest = struct {
	Namespace       string
	CustomerIdOrKey string
	ListParams      entitlement.ListEntitlementsParams
}

type ListCustomerEntitlementsHandlerResponse

type ListCustomerEntitlementsHandlerResponse = api.EntitlementV2PaginatedResponse

type ListEntitlementsHandler

type ListEntitlementsHandler httptransport.HandlerWithArgs[ListEntitlementsHandlerRequest, ListEntitlementsHandlerResponse, ListEntitlementsHandlerParams]

type ListEntitlementsHandlerParams

type ListEntitlementsHandlerParams = api.ListEntitlementsV2Params

type ListEntitlementsHandlerRequest

type ListEntitlementsHandlerRequest = entitlement.ListEntitlementsParams

type ListEntitlementsHandlerResponse

type ListEntitlementsHandlerResponse = pagination.Result[api.EntitlementV2]

type OverrideCustomerEntitlementHandler

type OverrideCustomerEntitlementHandler httptransport.HandlerWithArgs[OverrideCustomerEntitlementHandlerRequest, OverrideCustomerEntitlementHandlerResponse, OverrideCustomerEntitlementHandlerParams]

type OverrideCustomerEntitlementHandlerParams

type OverrideCustomerEntitlementHandlerParams struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
}

type OverrideCustomerEntitlementHandlerRequest

type OverrideCustomerEntitlementHandlerRequest struct {
	EntitlementIDOrFeatureKey string
	CustomerIDOrKey           string
	Namespace                 string
	APIInput                  *api.EntitlementV2CreateInputs
}

type OverrideCustomerEntitlementHandlerResponse

type OverrideCustomerEntitlementHandlerResponse = *api.EntitlementV2

type ResetCustomerEntitlementUsageHandler

type ResetCustomerEntitlementUsageHandler = httptransport.HandlerWithArgs[ResetCustomerEntitlementUsageHandlerRequest, ResetCustomerEntitlementUsageHandlerResponse, ResetCustomerEntitlementUsageHandlerParams]

ResetCustomerEntitlementUsage (POST /api/v2/customers/{customerId}/entitlements/{featureKey}/reset)

type ResetCustomerEntitlementUsageHandlerParams

type ResetCustomerEntitlementUsageHandlerParams struct {
	CustomerIDOrKey           string
	EntitlementIdOrFeatureKey string
}

ResetCustomerEntitlementUsage (POST /api/v2/customers/{customerId}/entitlements/{featureKey}/reset)

type ResetCustomerEntitlementUsageHandlerRequest

type ResetCustomerEntitlementUsageHandlerRequest struct {
	EntitlementID   string
	Namespace       string
	At              time.Time
	RetainAnchor    bool
	PreserveOverage *bool
}

ResetCustomerEntitlementUsage (POST /api/v2/customers/{customerId}/entitlements/{featureKey}/reset)

type ResetCustomerEntitlementUsageHandlerResponse

type ResetCustomerEntitlementUsageHandlerResponse = interface{}

ResetCustomerEntitlementUsage (POST /api/v2/customers/{customerId}/entitlements/{featureKey}/reset)