Package com.broadleafcommerce.billing.web.endpoint

Class BillingEventEndpoint

java.lang.Object

com.broadleafcommerce.billing.web.endpoint.BillingEventEndpoint

@FrameworkRestController
@FrameworkMapping("/billing-events")
@DataRouteByKey("billing")
public class BillingEventEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected BillingEventPaymentService<BillingEventPayment,BillingEventPaymentWithEvent,BillingEventDTO,BillingEventPaymentWithTransaction>	billingEventPaymentService
protected BillingEventService<BillingEvent,BillingEventDTO,CreateBillingEventRequest>	billingEventService
protected PaymentTransactionDetailService<PaymentTransactionDetail>	paymentTransactionDetailService
protected RefundEventDetailService<RefundEventDetail,RefundDetailsWithRefundAndBillingEvent>	refundEventDetailService
protected RefundEventService<RefundEvent,RefundEventWithDetails>	refundEventService
protected com.broadleafcommerce.common.extension.TypeFactory	typeFactory

Constructor Summary

Constructors

Constructor	Description
BillingEventEndpoint()

Method Summary

Modifier and Type	Method	Description
List<BillingEvent>	bulkCreateBillingEvents(List<CreateBillingEventRequest> requests, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
BillingEvent	createBillingEvent(@Valid CreateBillingEventRequest newEvent, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Set<String>	getBillingEventIds(Collection<BillingEventDTO> billingEvents)
protected List<BillingEventDTOWithRefunds>	getBulkBillingEventWithRefunds(Collection<BillingEventDTO> billingEvents, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected List<BillingEventDTOWithRefunds>	mapBillingEventsToRefunds(Collection<BillingEventDTO> billingEvents, Map<String,List<RefundEventWithDetails>> refunds)
List<BillingEvent>	readAllBillingEventsByOrderRef(String orderRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<BillingEvent>	readAllBillingEventsBySubscriptionId(String subscriptionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<BillingEvent>	readAllBillingEventsBySubscriptionIds(List<String> subscriptionIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<BillingEvent>	readAllBillingEventsByUserId(String userId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<BillingEventDTO>	readAllNewBillingEventsBySubscriptionId(String subscriptionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. in favor of BillingEventWithDetailsEndpoint.readAllBillingEventDTOsBySubscriptionId(String, ContextInfo)
List<BillingEventDTO>	readAllNewBillingEventsByUserId(String userId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. in favor of BillingEventWithDetailsEndpoint.readAllBillingEventDTOsByUserId(String, ContextInfo)
BillingEvent	readBillingEventByEventId(String eventId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
BillingEventDTO	readNewBillingEventByEventId(String eventId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. in favor of BillingEventWithDetailsEndpoint.readBillingEventDTOByEventId(String, ContextInfo)
BillingEventDTOWithRefunds	readNewBillingRefundsByBillingId(String eventId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. in favor of BillingEventWithRefundDetailsEndpoint.readBillingRefundsByBillingId(String, ContextInfo)
Map<String,BillingEventDTOWithRefunds>	readNewBillingRefundsByBillingIds(String[] requestIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. in favor of BillingEventWithRefundDetailsEndpoint.readBillingRefundsByBillingEventIds(Set, ContextInfo)
List<BillingEventDTOWithRefunds>	readNewBillingRefundsBySubscriptionId(String subscriptionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. in favor of BillingEventWithRefundDetailsEndpoint.readBillingRefundsBySubscriptionId(String, ContextInfo)
Map<String,List<BillingEventDTOWithRefunds>>	readNewBillingRefundsBySubscriptionIds(String[] requestIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. in favor of BillingEventWithRefundDetailsEndpoint.readBillingRefundsBySubscriptionIds(Set, ContextInfo)
BillingEvent	updateBillingEvent(String eventId, BillingEvent billingEventRequest, 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

Field Details

billingEventService

@Autowired
protected BillingEventService<BillingEvent,BillingEventDTO,CreateBillingEventRequest> billingEventService

billingEventPaymentService

@Autowired
protected BillingEventPaymentService<BillingEventPayment,BillingEventPaymentWithEvent,BillingEventDTO,BillingEventPaymentWithTransaction> billingEventPaymentService

refundEventService

@Autowired
protected RefundEventService<RefundEvent,RefundEventWithDetails> refundEventService

refundEventDetailService

@Autowired
protected RefundEventDetailService<RefundEventDetail,RefundDetailsWithRefundAndBillingEvent> refundEventDetailService

paymentTransactionDetailService

@Autowired
protected PaymentTransactionDetailService<PaymentTransactionDetail> paymentTransactionDetailService

typeFactory

@Autowired
protected com.broadleafcommerce.common.extension.TypeFactory typeFactory

Constructor Details

BillingEventEndpoint

public BillingEventEndpoint()

Method Details

readBillingEventByEventId

@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/{eventId}")
public BillingEvent readBillingEventByEventId(@PathVariable("eventId")
 String eventId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAllBillingEventsByUserId

@Policy(permissionRoots="BILLING")
@FrameworkGetMapping
public List<BillingEvent> readAllBillingEventsByUserId(@RequestParam("userId")
 String userId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAllBillingEventsBySubscriptionId

@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/subscriptions/{subscriptionId}")
public List<BillingEvent> readAllBillingEventsBySubscriptionId(@PathVariable("subscriptionId")
 String subscriptionId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAllBillingEventsBySubscriptionIds

@Policy(permissionRoots="BILLING")
@FrameworkGetMapping(params="subscriptionIds")
public List<BillingEvent> readAllBillingEventsBySubscriptionIds(@RequestParam("subscriptionIds")
 List<String> subscriptionIds,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAllBillingEventsByOrderRef

@Policy(permissionRoots="BILLING")
@FrameworkGetMapping(params="orderRef")
public List<BillingEvent> readAllBillingEventsByOrderRef(@RequestParam("orderRef")
 String orderRef,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readNewBillingEventByEventId

@Deprecated(since="1.0.0")
@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/new/{eventId}")
public BillingEventDTO readNewBillingEventByEventId(@PathVariable("eventId")
 String eventId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

in favor of BillingEventWithDetailsEndpoint.readBillingEventDTOByEventId(String, ContextInfo)

readAllNewBillingEventsByUserId

@Deprecated(since="1.0.0")
@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/new")
public List<BillingEventDTO> readAllNewBillingEventsByUserId(@RequestParam("userId")
 String userId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

in favor of BillingEventWithDetailsEndpoint.readAllBillingEventDTOsByUserId(String, ContextInfo)

readAllNewBillingEventsBySubscriptionId

@Deprecated(since="1.0.0")
@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/new/subscriptions/{subscriptionId}")
public List<BillingEventDTO> readAllNewBillingEventsBySubscriptionId(@PathVariable("subscriptionId")
 String subscriptionId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

in favor of BillingEventWithDetailsEndpoint.readAllBillingEventDTOsBySubscriptionId(String, ContextInfo)

createBillingEvent

@Policy(permissionRoots="BILLING")
@FrameworkPostMapping
public BillingEvent createBillingEvent(@RequestBody @Valid
 @Valid CreateBillingEventRequest newEvent,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

bulkCreateBillingEvents

@Policy(permissionRoots="BILLING")
@FrameworkPostMapping(value="/bulk",
                      consumes="application/json")
public List<BillingEvent> bulkCreateBillingEvents(@RequestBody
 List<CreateBillingEventRequest> requests,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

updateBillingEvent

@Policy(permissionRoots="BILLING")
@FrameworkPatchMapping("/{eventId}")
public BillingEvent updateBillingEvent(@PathVariable("eventId")
 String eventId,
 @RequestBody
 BillingEvent billingEventRequest,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readNewBillingRefundsByBillingId

@Deprecated(since="1.0.0")
@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/new/with-refunds/{eventId}")
public BillingEventDTOWithRefunds readNewBillingRefundsByBillingId(@PathVariable("eventId")
 String eventId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

in favor of BillingEventWithRefundDetailsEndpoint.readBillingRefundsByBillingId(String, ContextInfo)

readNewBillingRefundsByBillingIds

@Deprecated(since="1.0.0")
@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/new/with-refunds/bulk")
public Map<String,BillingEventDTOWithRefunds> readNewBillingRefundsByBillingIds(@RequestParam("ids")
 String[] requestIds,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

in favor of BillingEventWithRefundDetailsEndpoint.readBillingRefundsByBillingEventIds(Set, ContextInfo)

readNewBillingRefundsBySubscriptionId

@Deprecated(since="1.0.0")
@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/new/with-refunds/subscription/{subscriptionId}")
public List<BillingEventDTOWithRefunds> readNewBillingRefundsBySubscriptionId(@PathVariable("subscriptionId")
 String subscriptionId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

in favor of BillingEventWithRefundDetailsEndpoint.readBillingRefundsBySubscriptionId(String, ContextInfo)

readNewBillingRefundsBySubscriptionIds

@Deprecated(since="1.0.0")
@Policy(permissionRoots="BILLING")
@FrameworkGetMapping("/new/with-refunds/subscription/bulk")
public Map<String,List<BillingEventDTOWithRefunds>> readNewBillingRefundsBySubscriptionIds(@RequestParam("ids")
 String[] requestIds,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

in favor of BillingEventWithRefundDetailsEndpoint.readBillingRefundsBySubscriptionIds(Set, ContextInfo)

getBulkBillingEventWithRefunds

protected List<BillingEventDTOWithRefunds> getBulkBillingEventWithRefunds(Collection<BillingEventDTO> billingEvents,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getBillingEventIds

protected Set<String> getBillingEventIds(Collection<BillingEventDTO> billingEvents)

mapBillingEventsToRefunds

protected List<BillingEventDTOWithRefunds> mapBillingEventsToRefunds(Collection<BillingEventDTO> billingEvents,
 Map<String,List<RefundEventWithDetails>> refunds)