Package com.broadleafcommerce.customer.web.endpoint

Class CustomerPaymentAccountEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.CustomerPaymentAccountEndpoint

@FrameworkRestController
@FrameworkMapping("/customers/{customerId}/payment-accounts")
@DataRouteByExample(Customer.class)
@ConditionalOnCustomerAsSavedPaymentStorageLocation
@Deprecated(since="1.7.2",
            forRemoval=true)
public class CustomerPaymentAccountEndpoint
extends Object

Deprecated, for removal: This API element is subject to removal in a future version.

since 1.7.2, in favor of using SavedPaymentMethod in PaymentTransactionServices to manage saved payment methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomerPaymentAccountEndpoint.PaymentAccountUpdate	Deprecated, for removal: This API element is subject to removal in a future version. A custom DTO that is intended for the specific purpose of supporting PATCH for PaymentAccount.

Constructor Summary

Constructors

Constructor	Description
CustomerPaymentAccountEndpoint(CustomerService<Customer> customerService, PaymentAccountService<PaymentAccount> paymentAccountService, PaymentAccountSummaryService summaryService)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
PaymentAccountSummary	addPaymentAccountToCustomer(String customerId, PaymentAccount paymentAccountRequest, boolean makeDefaultAccount, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated, for removal: This API element is subject to removal in a future version.
void	deletePaymentAccount(String customerId, String paymentAccountId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated, for removal: This API element is subject to removal in a future version.
protected CustomerService<Customer>	getCustomerService()	Deprecated, for removal: This API element is subject to removal in a future version.
protected PaymentAccountService<PaymentAccount>	getPaymentAccountService()	Deprecated, for removal: This API element is subject to removal in a future version.
protected PaymentAccountSummaryService	getSummaryService()	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentAccountSummary	readPaymentAccount(String customerId, String paymentAccountId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated, for removal: This API element is subject to removal in a future version.
org.springframework.data.domain.Page<PaymentAccountSummary>	readPaymentAccounts(String customerId, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated, for removal: This API element is subject to removal in a future version.
PaymentAccountSummary	updatePaymentAccount(String customerId, String paymentAccountId, boolean makeDefaultAccount, CustomerPaymentAccountEndpoint.PaymentAccountUpdate paymentAccountRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerPaymentAccountEndpoint

public CustomerPaymentAccountEndpoint(CustomerService<Customer> customerService,
                                      PaymentAccountService<PaymentAccount> paymentAccountService,
                                      PaymentAccountSummaryService summaryService)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

readPaymentAccounts

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0)
@FrameworkGetMapping
public org.springframework.data.domain.Page<PaymentAccountSummary> readPaymentAccounts(@PathVariable("customerId")
                                                                                       String customerId,
                                                                                       @PageableDefault
                                                                                       org.springframework.data.domain.Pageable page,
                                                                                       cz.jirutka.rsql.parser.ast.Node filters,
                                                                                       @ContextOperation(READ)
                                                                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated, for removal: This API element is subject to removal in a future version.

addPaymentAccountToCustomer

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0)
@FrameworkPostMapping
public PaymentAccountSummary addPaymentAccountToCustomer(@PathVariable("customerId")
                                                         String customerId,
                                                         @RequestBody
                                                         PaymentAccount paymentAccountRequest,
                                                         @RequestParam(value="default",required=false,defaultValue="false")
                                                         boolean makeDefaultAccount,
                                                         @ContextOperation(CREATE)
                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated, for removal: This API element is subject to removal in a future version.

readPaymentAccount

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0)
@FrameworkGetMapping("/{paymentAccountId}")
public PaymentAccountSummary readPaymentAccount(@PathVariable("customerId")
                                                String customerId,
                                                @PathVariable("paymentAccountId")
                                                String paymentAccountId,
                                                @ContextOperation(READ)
                                                com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated, for removal: This API element is subject to removal in a future version.

updatePaymentAccount

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0)
@FrameworkPatchMapping("/{paymentAccountId}")
public PaymentAccountSummary updatePaymentAccount(@PathVariable("customerId")
                                                  String customerId,
                                                  @PathVariable("paymentAccountId")
                                                  String paymentAccountId,
                                                  @RequestParam(value="default",required=false,defaultValue="false")
                                                  boolean makeDefaultAccount,
                                                  @RequestBody
                                                  CustomerPaymentAccountEndpoint.PaymentAccountUpdate paymentAccountRequest,
                                                  @ContextOperation(UPDATE)
                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated, for removal: This API element is subject to removal in a future version.

deletePaymentAccount

@Policy(permissionRoots="CUSTOMER_SAVED_PAYMENT_MANAGEMENT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0)
@FrameworkDeleteMapping("/{paymentAccountId}")
@ResponseStatus(NO_CONTENT)
public void deletePaymentAccount(@PathVariable("customerId")
                                 String customerId,
                                 @PathVariable("paymentAccountId")
                                 String paymentAccountId,
                                 @ContextOperation(DELETE)
                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated, for removal: This API element is subject to removal in a future version.

getCustomerService

protected CustomerService<Customer> getCustomerService()

Deprecated, for removal: This API element is subject to removal in a future version.

getPaymentAccountService

protected PaymentAccountService<PaymentAccount> getPaymentAccountService()

Deprecated, for removal: This API element is subject to removal in a future version.

getSummaryService

protected PaymentAccountSummaryService getSummaryService()

Deprecated, for removal: This API element is subject to removal in a future version.