Package io.voucherify.client.model

Class QualificationsOption

java.lang.Object
io.voucherify.client.model.QualificationsOption
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class QualificationsOption extends Object
Configure parameters returned in the response.

  • Field Details

  • Constructor Details

    • QualificationsOption

      public QualificationsOption()

  • Method Details

    • limit

      public QualificationsOption limit(Integer limit)

    • getLimit

      @Nullable public Integer getLimit()
      The maximum number of redeemables to be returned in the API request. The actual number of returned redeemables will be determined by the API. The default value is set to 5 maximum: 100
      Returns:
      limit

    • setLimit

      public void setLimit(Integer limit)

    • startingAfter

      public QualificationsOption startingAfter(OffsetDateTime startingAfter)

    • getStartingAfter

      @Nullable public OffsetDateTime getStartingAfter()
      Cursor used for paging.
      Returns:
      startingAfter

    • setStartingAfter

      public void setStartingAfter(OffsetDateTime startingAfter)

    • filters

      public QualificationsOption filters(QualificationsOptionFilters filters)

    • getFilters

      @Nullable public QualificationsOptionFilters getFilters()
      Get filters
      Returns:
      filters

    • setFilters

      public void setFilters(QualificationsOptionFilters filters)

    • expand

      public QualificationsOption expand(List<QualificationsOption.ExpandEnum> expand)

    • addExpandItem

      public QualificationsOption addExpandItem(QualificationsOption.ExpandEnum expandItem)

    • getExpand

      @Nullable public List<QualificationsOption.ExpandEnum> getExpand()
      The expand array lets you configure the parameters included in the response. Depending on the strings included in the array, the response will contain different details. | **Expand Option** | **Response Body** | |:---|:---| | [`\"redeemable\"`] | Returns the redeemables':<br>- metadata<br>- redeemable name,<br>- campaign name,<br>- campaign ID| | [`\"category\"`] | - Returns an expanded `categories` object, showing details about the category. | | [`\"validation_rules\"`] | - Returns an expanded `validation_rules` object, showing details about the validation rules. |
      Returns:
      expand

    • setExpand

      public void setExpand(List<QualificationsOption.ExpandEnum> expand)

    • sortingRule

      public QualificationsOption sortingRule(QualificationsOption.SortingRuleEnum sortingRule)

    • getSortingRule

      @Nullable public QualificationsOption.SortingRuleEnum getSortingRule()
      Is used to determine the order in which data is displayed in the result array. - `DEFAULT` - Sorting descending by `created_at` - `BEST_DEAL` - Sorting descending by `total_applied_discount_amount` - `LEAST_DEAL` - Sorting ascending by `total_applied_discount_amount`
      Returns:
      sortingRule

    • setSortingRule

      public void setSortingRule(QualificationsOption.SortingRuleEnum sortingRule)

    • 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

    • fromJson

      public static QualificationsOption fromJson(String jsonString) throws IOException
      Create an instance of QualificationsOption given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of QualificationsOption
      Throws:
      IOException - if the JSON string is invalid with respect to QualificationsOption

    • toJson

      public String toJson()
      Convert an instance of QualificationsOption to an JSON string
      Returns:
      JSON string