Package com.commercetools.api.models.me

Interface MyCustomerRemoveAddressAction

All Superinterfaces:
MyCustomerUpdateAction, ResourceUpdateAction<MyCustomerUpdateAction>
public interface MyCustomerRemoveAddressAction extends MyCustomerUpdateAction

Removing an address of the Customer produces the CustomerAddressRemoved Message.

Either addressId or addressKey is required.

Example to create an instance using the builder pattern 

     MyCustomerRemoveAddressAction myCustomerRemoveAddressAction = MyCustomerRemoveAddressAction.builder()
             .build()

  • Field Details

    • REMOVE_ADDRESS

      static final String REMOVE_ADDRESS
      discriminator value for MyCustomerRemoveAddressAction
      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 MyCustomerRemoveAddressAction of()
      factory method
      Returns:
      instance of MyCustomerRemoveAddressAction

    • of

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

    • deepCopy

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

    • builder

      static MyCustomerRemoveAddressActionBuilder builder()
      builder factory method for MyCustomerRemoveAddressAction
      Returns:
      builder

    • builder

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

    • withMyCustomerRemoveAddressAction

      default <T> T withMyCustomerRemoveAddressAction(Function<MyCustomerRemoveAddressAction,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<MyCustomerRemoveAddressAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference