Package com.broadleafcommerce.billing.web.endpoint

Class SubscriptionBillingEventEndpoint

java.lang.Object

com.broadleafcommerce.billing.web.endpoint.SubscriptionBillingEventEndpoint

@FrameworkRestController
@FrameworkMapping
@DataRouteByKey("billing")
public class SubscriptionBillingEventEndpoint
extends Object

Constructor Summary

Constructors

Constructor	Description
SubscriptionBillingEventEndpoint(SubscriptionBillingEventService<BillingEvent> subscriptionBillingEventService, BillingEventService<BillingEvent,BillingEventDTO,CreateBillingEventRequest> billingEventService)

Method Summary

Modifier and Type	Method	Description
Collection<BillingEvent>	generateBillingEventsForNextSubscriptionPeriod(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String subscriptionId, boolean isSandboxAware, SubscriptionNextPeriodBillingEventGenerationRequest billingEventGenerationRequest)
protected BillingEventService<BillingEvent,BillingEventDTO,CreateBillingEventRequest>	getBillingEventService()
protected SubscriptionBillingEventService<BillingEvent>	getSubscriptionBillingEventService()
org.springframework.data.domain.Page<BillingEventDTO>	readBillingEventsForSubscriptionRefAndPeriodGreaterThanEqualWithDetails(String subscriptionId, Integer requestedPeriod, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SubscriptionBillingEventEndpoint

public SubscriptionBillingEventEndpoint(SubscriptionBillingEventService<BillingEvent> subscriptionBillingEventService,
 BillingEventService<BillingEvent,BillingEventDTO,CreateBillingEventRequest> billingEventService)

Method Details

generateBillingEventsForNextSubscriptionPeriod

@FrameworkPostMapping(path="/subscriptions/{subscriptionId}/billing-events",
                      consumes="application/json")
@Policy(permissionRoots="SUBSCRIPTION_BILLING_EVENT")
public Collection<BillingEvent> generateBillingEventsForNextSubscriptionPeriod(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("subscriptionId")
 String subscriptionId,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="true")
 boolean isSandboxAware,
 @RequestBody
 SubscriptionNextPeriodBillingEventGenerationRequest billingEventGenerationRequest)

readBillingEventsForSubscriptionRefAndPeriodGreaterThanEqualWithDetails

@FrameworkGetMapping(path="/subscriptions/{subscriptionId}/billing-events-with-details",
                     params="requestedPeriod",
                     produces="application/json")
@Policy(permissionRoots="SUBSCRIPTION_BILLING_EVENT")
public org.springframework.data.domain.Page<BillingEventDTO> readBillingEventsForSubscriptionRefAndPeriodGreaterThanEqualWithDetails(@PathVariable("subscriptionId")
 String subscriptionId,
 @RequestParam("requestedPeriod")
 Integer requestedPeriod,
 @PageableDefault(size=50,sort={"subscriptionPeriod","contextId"})
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getSubscriptionBillingEventService

protected SubscriptionBillingEventService<BillingEvent> getSubscriptionBillingEventService()

getBillingEventService

protected BillingEventService<BillingEvent,BillingEventDTO,CreateBillingEventRequest> getBillingEventService()