Package io.voucherify.client.model

Class QualificationsCheckEligibilityRequestBody

java.lang.Object
io.voucherify.client.model.QualificationsCheckEligibilityRequestBody
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class QualificationsCheckEligibilityRequestBody extends Object
Request body schema for **POST** `v1/qualifications`.

  • Field Details

  • Constructor Details

    • QualificationsCheckEligibilityRequestBody

      public QualificationsCheckEligibilityRequestBody()

  • Method Details

    • customer

      public QualificationsCheckEligibilityRequestBody customer(Customer customer)

    • getCustomer

      @Nullable public Customer getCustomer()
      Get customer
      Returns:
      customer

    • setCustomer

      public void setCustomer(Customer customer)

    • order

      public QualificationsCheckEligibilityRequestBody order(Order order)

    • getOrder

      @Nullable public Order getOrder()
      Get order
      Returns:
      order

    • setOrder

      public void setOrder(Order order)

    • trackingId

      public QualificationsCheckEligibilityRequestBody trackingId(String trackingId)

    • getTrackingId

      @Nullable public String getTrackingId()
      Is correspondent to Customer's source_id
      Returns:
      trackingId

    • setTrackingId

      public void setTrackingId(String trackingId)

    • scenario

      public QualificationsCheckEligibilityRequestBody scenario(QualificationsCheckEligibilityRequestBody.ScenarioEnum scenario)

    • getScenario

      @Nullable public QualificationsCheckEligibilityRequestBody.ScenarioEnum getScenario()
      Defines the scenario Voucherify should consider during the qualification process. - `ALL` - Scenario that returns all redeemables available for the customer in one API request. This scenario is used by default when no value is selected. - `CUSTOMER_WALLET` - returns vouchers applicable to the customer's cart based on the vouchers assigned to the customer's profile. - `AUDIENCE_ONLY` - returns all vouchers, promotion tiers, and campaigns available to the customer. Voucherify validates the rules based on the customer profile only. - `PRODUCTS` - returns all promotions available for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT` - returns all promotions available for products when a discount is defined as applicable to specific item(s). - `PROMOTION_STACKS` - returns the applicable promotion stacks. - `PRODUCTS_BY_CUSTOMER` - returns all promotions available for a customer for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT_BY_CUSTOMER` - returns all promotions available for a customer for products when a discount is defined as applicable to specific item(s).
      Returns:
      scenario

    • setScenario

      public void setScenario(QualificationsCheckEligibilityRequestBody.ScenarioEnum scenario)

    • options

      public QualificationsCheckEligibilityRequestBody options(QualificationsOption options)

    • getOptions

      @Nullable public QualificationsOption getOptions()
      Get options
      Returns:
      options

    • setOptions

      public void setOptions(QualificationsOption options)

    • metadata

      public QualificationsCheckEligibilityRequestBody metadata(Object metadata)

    • getMetadata

      @Nullable public Object getMetadata()
      A set of key/value pairs that you can send in the request body to check against redeemables requiring **redemption** metadata validation rules to be satisfied. The validation runs against rules that are defined through the <!-- [Create Validation Rules](https://docs.voucherify.io/reference/create-validation-rules) -->[Create Validation Rules](ref:create-validation-rules) endpoint or via the Dashboard; in the _Advanced Rule Builder_ &rarr; _Advanced_ &rarr; _Redemption metadata satisfy_ or _Basic Builder_ &rarr; _Attributes match_ &rarr; _REDEMPTION METADATA_. [Read more](https://support.voucherify.io/article/148-how-to-build-a-rule).
      Returns:
      metadata

    • setMetadata

      public void setMetadata(Object metadata)

    • 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 QualificationsCheckEligibilityRequestBody fromJson(String jsonString) throws IOException
      Create an instance of QualificationsCheckEligibilityRequestBody given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of QualificationsCheckEligibilityRequestBody
      Throws:
      IOException - if the JSON string is invalid with respect to QualificationsCheckEligibilityRequestBody

    • toJson

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