Package com.commercetools.api.models.customer

Interface CustomerRemoveAddressAction

All Superinterfaces:
CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>
All Known Implementing Classes:
CustomerRemoveAddressActionImpl
public interface CustomerRemoveAddressAction extends CustomerUpdateAction

Removing an address from the Customer produces the CustomerAddressRemoved Message.

Either addressId or addressKey is required.

Example to create an instance using the builder pattern 

     CustomerRemoveAddressAction customerRemoveAddressAction = CustomerRemoveAddressAction.builder()
             .build()

  • Field Details

    • REMOVE_ADDRESS

      static final String REMOVE_ADDRESS
      discriminator value for CustomerRemoveAddressAction
      See Also:

  • Method Details

    • getAddressId

      String getAddressId()

      id of the Address to remove.

      Returns:
      addressId

    • getAddressKey

      String getAddressKey()

      key of the Address to remove.

      Returns:
      addressKey

    • setAddressId

      void setAddressId(String addressId)

      id of the Address to remove.

      Parameters:
      addressId - value to be set

    • setAddressKey

      void setAddressKey(String addressKey)

      key of the Address to remove.

      Parameters:
      addressKey - value to be set

    • of

      static CustomerRemoveAddressAction of()
      factory method
      Returns:
      instance of CustomerRemoveAddressAction

    • of

      static CustomerRemoveAddressAction of(CustomerRemoveAddressAction template)
      factory method to create a shallow copy CustomerRemoveAddressAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static CustomerRemoveAddressAction deepCopy(@Nullable CustomerRemoveAddressAction template)
      factory method to create a deep copy of CustomerRemoveAddressAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static CustomerRemoveAddressActionBuilder builder()
      builder factory method for CustomerRemoveAddressAction
      Returns:
      builder

    • builder

      static CustomerRemoveAddressActionBuilder builder(CustomerRemoveAddressAction template)
      create builder for CustomerRemoveAddressAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withCustomerRemoveAddressAction

      default <T> T withCustomerRemoveAddressAction(Function<CustomerRemoveAddressAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<CustomerRemoveAddressAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference