Interface OrderSetCustomLineItemCustomFieldAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderSetCustomLineItemCustomFieldAction extends OrderUpdateAction
OrderSetCustomLineItemCustomFieldAction
Example to create an instance using the builder pattern

     OrderSetCustomLineItemCustomFieldAction orderSetCustomLineItemCustomFieldAction = OrderSetCustomLineItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 
  • Field Details

    • SET_CUSTOM_LINE_ITEM_CUSTOM_FIELD

      static final String SET_CUSTOM_LINE_ITEM_CUSTOM_FIELD
      discriminator value for OrderSetCustomLineItemCustomFieldAction
      See Also:
  • Method Details

    • getCustomLineItemId

      String getCustomLineItemId()

      id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Returns:
      customLineItemId
    • getCustomLineItemKey

      String getCustomLineItemKey()

      key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Returns:
      customLineItemKey
    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field.

      Returns:
      name
    • getValue

      Object getValue()

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Returns:
      value
    • setCustomLineItemId

      void setCustomLineItemId(String customLineItemId)

      id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Parameters:
      customLineItemId - value to be set
    • setCustomLineItemKey

      void setCustomLineItemKey(String customLineItemKey)

      key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Parameters:
      customLineItemKey - value to be set
    • setName

      void setName(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set
    • setValue

      void setValue(Object value)

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Parameters:
      value - value to be set
    • of

      factory method
      Returns:
      instance of OrderSetCustomLineItemCustomFieldAction
    • of

      factory method to create a shallow copy OrderSetCustomLineItemCustomFieldAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • deepCopy

      factory method to create a deep copy of OrderSetCustomLineItemCustomFieldAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • builder

      builder factory method for OrderSetCustomLineItemCustomFieldAction
      Returns:
      builder
    • builder

      create builder for OrderSetCustomLineItemCustomFieldAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withOrderSetCustomLineItemCustomFieldAction

      default <T> T withOrderSetCustomLineItemCustomFieldAction(Function<OrderSetCustomLineItemCustomFieldAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value
    • ofUnset

      static OrderSetCustomLineItemCustomFieldAction ofUnset(String name, String customLineItemId)
    • typeReference

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