Package software.xdev.brevo.model

Class GetCouponCollection

java.lang.Object
software.xdev.brevo.model.GetCouponCollection
public class GetCouponCollection extends Object
GetCouponCollection

  • Field Details

  • Constructor Details

    • GetCouponCollection

      public GetCouponCollection()

  • Method Details

    • id

      public GetCouponCollection id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      The id of the collection.
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • name

      public GetCouponCollection name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      The name of the collection.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • defaultCoupon

      public GetCouponCollection defaultCoupon(@Nonnull String defaultCoupon)

    • getDefaultCoupon

      @Nonnull public String getDefaultCoupon()
      The default coupon of the collection.
      Returns:
      defaultCoupon

    • setDefaultCoupon

      public void setDefaultCoupon(@Nonnull String defaultCoupon)

    • createdAt

      public GetCouponCollection createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

      @Nonnull public OffsetDateTime getCreatedAt()
      Datetime on which the collection was created.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • totalCoupons

      public GetCouponCollection totalCoupons(@Nonnull Long totalCoupons)

    • getTotalCoupons

      @Nonnull public Long getTotalCoupons()
      Total number of coupons in the collection.
      Returns:
      totalCoupons

    • setTotalCoupons

      public void setTotalCoupons(@Nonnull Long totalCoupons)

    • remainingCoupons

      public GetCouponCollection remainingCoupons(@Nonnull Long remainingCoupons)

    • getRemainingCoupons

      @Nonnull public Long getRemainingCoupons()
      Number of coupons that have not been sent yet.
      Returns:
      remainingCoupons

    • setRemainingCoupons

      public void setRemainingCoupons(@Nonnull Long remainingCoupons)

    • expirationDate

      public GetCouponCollection expirationDate(@Nullable OffsetDateTime expirationDate)

    • getExpirationDate

      @Nullable public OffsetDateTime getExpirationDate()
      Expiration date for the coupon collection in RFC3339 format.
      Returns:
      expirationDate

    • setExpirationDate

      public void setExpirationDate(@Nullable OffsetDateTime expirationDate)

    • remainingDaysAlert

      public GetCouponCollection remainingDaysAlert(@Nullable Integer remainingDaysAlert)

    • getRemainingDaysAlert

      @Nullable public Integer getRemainingDaysAlert()
      If present, an email notification is going to be sent the defined amount of days before to the expiration date.
      Returns:
      remainingDaysAlert

    • setRemainingDaysAlert

      public void setRemainingDaysAlert(@Nullable Integer remainingDaysAlert)

    • remainingCouponsAlert

      public GetCouponCollection remainingCouponsAlert(@Nullable Integer remainingCouponsAlert)

    • getRemainingCouponsAlert

      @Nullable public Integer getRemainingCouponsAlert()
      If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold.
      Returns:
      remainingCouponsAlert

    • setRemainingCouponsAlert

      public void setRemainingCouponsAlert(@Nullable Integer remainingCouponsAlert)

    • 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