Package software.xdev.brevo.model

Class CreateTransactionPayload

java.lang.Object
software.xdev.brevo.model.CreateTransactionPayload
public class CreateTransactionPayload extends Object
Payload for creating a transaction, specifying balance details and optional expiration.

  • Field Details

  • Constructor Details

    • CreateTransactionPayload

      public CreateTransactionPayload()

  • Method Details

    • loyaltySubscriptionId

      public CreateTransactionPayload loyaltySubscriptionId(@Nullable String loyaltySubscriptionId)

    • getLoyaltySubscriptionId

      @Nullable public String getLoyaltySubscriptionId()
      Unique identifier for the loyalty subscription (required unless `contactId` is provided).
      Returns:
      loyaltySubscriptionId

    • setLoyaltySubscriptionId

      public void setLoyaltySubscriptionId(@Nullable String loyaltySubscriptionId)

    • amount

      public CreateTransactionPayload amount(@Nonnull BigDecimal amount)

    • getAmount

      @Nonnull public BigDecimal getAmount()
      Transaction amount (must be provided).
      Returns:
      amount

    • setAmount

      public void setAmount(@Nonnull BigDecimal amount)

    • autoComplete

      public CreateTransactionPayload autoComplete(@Nullable Boolean autoComplete)

    • getAutoComplete

      @Nullable public Boolean getAutoComplete()
      Whether the transaction should be automatically completed.
      Returns:
      autoComplete

    • setAutoComplete

      public void setAutoComplete(@Nullable Boolean autoComplete)

    • balanceDefinitionId

      public CreateTransactionPayload 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)

    • balanceExpiryInMinutes

      public CreateTransactionPayload balanceExpiryInMinutes(@Nullable Integer balanceExpiryInMinutes)

    • getBalanceExpiryInMinutes

      @Nullable public Integer getBalanceExpiryInMinutes()
      Optional expiry time for the balance in minutes (must be greater than 0 if provided).
      Returns:
      balanceExpiryInMinutes

    • setBalanceExpiryInMinutes

      public void setBalanceExpiryInMinutes(@Nullable Integer balanceExpiryInMinutes)

    • contactId

      public CreateTransactionPayload contactId(@Nullable Integer contactId)

    • getContactId

      @Nullable public Integer getContactId()
      Unique identifier of the contact involved in the transaction (required unless `LoyaltySubscriptionId` is provided). minimum: 1
      Returns:
      contactId

    • setContactId

      public void setContactId(@Nullable Integer contactId)

    • eventTime

      public CreateTransactionPayload eventTime(@Nullable String eventTime)

    • getEventTime

      @Nullable public String getEventTime()
      Optional timestamp specifying when the transaction occurred.
      Returns:
      eventTime

    • setEventTime

      public void setEventTime(@Nullable String eventTime)

    • meta

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

    • putMetaItem

      public CreateTransactionPayload putMetaItem(String key, Object metaItem)

    • getMeta

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

    • setMeta

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

    • ttl

      public CreateTransactionPayload ttl(@Nullable Integer ttl)

    • getTtl

      @Nullable public Integer getTtl()
      Optional time-to-live for the transaction (must be greater than 0 if provided).
      Returns:
      ttl

    • setTtl

      public void setTtl(@Nullable Integer ttl)

    • 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