Package software.xdev.brevo.model

Class CreateOrderPayload

java.lang.Object
software.xdev.brevo.model.CreateOrderPayload
public class CreateOrderPayload extends Object
Payload for creating an order linked to a balance definition.

  • Field Details

  • Constructor Details

    • CreateOrderPayload

      public CreateOrderPayload()

  • Method Details

    • amount

      public CreateOrderPayload amount(@Nonnull BigDecimal amount)

    • getAmount

      @Nonnull public BigDecimal getAmount()
      Order amount (must be non-zero).
      Returns:
      amount

    • setAmount

      public void setAmount(@Nonnull BigDecimal amount)

    • balanceDefinitionId

      public CreateOrderPayload balanceDefinitionId(@Nonnull String balanceDefinitionId)

    • getBalanceDefinitionId

      @Nonnull public String getBalanceDefinitionId()
      Unique identifier (UUID) of the associated balance definition.
      Returns:
      balanceDefinitionId

    • setBalanceDefinitionId

      public void setBalanceDefinitionId(@Nonnull String balanceDefinitionId)

    • contactId

      public CreateOrderPayload contactId(@Nonnull Integer contactId)

    • getContactId

      @Nonnull public Integer getContactId()
      Unique identifier of the contact placing the order (must be ≥ 1). minimum: 1
      Returns:
      contactId

    • setContactId

      public void setContactId(@Nonnull Integer contactId)

    • dueAt

      public CreateOrderPayload dueAt(@Nonnull String dueAt)

    • getDueAt

      @Nonnull public String getDueAt()
      RFC3339 timestamp specifying when the order is due.
      Returns:
      dueAt

    • setDueAt

      public void setDueAt(@Nonnull String dueAt)

    • expiresAt

      public CreateOrderPayload expiresAt(@Nullable String expiresAt)

    • getExpiresAt

      @Nullable public String getExpiresAt()
      Optional RFC3339 timestamp defining order expiration.
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nullable String expiresAt)

    • meta

      public CreateOrderPayload meta(@Nullable Map<String,Object> meta)

    • putMetaItem

      public CreateOrderPayload putMetaItem(String key, Object metaItem)

    • getMeta

      @Nullable public Map<String,Object> getMeta()
      Optional metadata associated with the order.
      Returns:
      meta

    • setMeta

      public void setMeta(@Nullable Map<String,Object> meta)

    • source

      public CreateOrderPayload source(@Nonnull String source)

    • getSource

      @Nonnull public String getSource()
      Specifies the origin of the order (`engine` or `user`).
      Returns:
      source

    • setSource

      public void setSource(@Nonnull String source)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string