Package com.commercetools.api.models.business_unit

Interface BusinessUnitRemoveShippingAddressIdAction

All Superinterfaces:
BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>
public interface BusinessUnitRemoveShippingAddressIdAction extends BusinessUnitUpdateAction

Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.

Example to create an instance using the builder pattern 

     BusinessUnitRemoveShippingAddressIdAction businessUnitRemoveShippingAddressIdAction = BusinessUnitRemoveShippingAddressIdAction.builder()
             .build()

  • Field Details

    • REMOVE_SHIPPING_ADDRESS_ID

      static final String REMOVE_SHIPPING_ADDRESS_ID
      discriminator value for BusinessUnitRemoveShippingAddressIdAction
      See Also:

  • Method Details

    • getAddressId

      String getAddressId()

      ID of the address to be removed from shippingAddressIds. Either addressId or addressKey is required.

      Returns:
      addressId

    • getAddressKey

      String getAddressKey()

      Key of the address to be removed from shippingAddressIds. Either addressId or addressKey is required.

      Returns:
      addressKey

    • setAddressId

      void setAddressId(String addressId)

      ID of the address to be removed from shippingAddressIds. Either addressId or addressKey is required.

      Parameters:
      addressId - value to be set

    • setAddressKey

      void setAddressKey(String addressKey)

      Key of the address to be removed from shippingAddressIds. Either addressId or addressKey is required.

      Parameters:
      addressKey - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static BusinessUnitRemoveShippingAddressIdActionBuilder builder()
      builder factory method for BusinessUnitRemoveShippingAddressIdAction
      Returns:
      builder

    • builder

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

    • withBusinessUnitRemoveShippingAddressIdAction

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