Package io.voucherify.client.api

Class QualificationsApi

java.lang.Object

io.voucherify.client.api.QualificationsApi

public class QualificationsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
QualificationsApi()
QualificationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
QualificationsCheckEligibilityResponseBody	checkEligibility(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody)	Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order.
okhttp3.Call	checkEligibilityAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, ApiCallback<QualificationsCheckEligibilityResponseBody> _callback)	Check Eligibility (asynchronously) 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order.
okhttp3.Call	checkEligibilityCall(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody, ApiCallback _callback)	Build call for checkEligibility
ApiResponse<QualificationsCheckEligibilityResponseBody>	checkEligibilityWithHttpInfo(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody)	Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QualificationsApi

public QualificationsApi()

QualificationsApi

public QualificationsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

checkEligibilityCall

public okhttp3.Call checkEligibilityCall(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody,
 ApiCallback _callback)
                                  throws ApiException

Build call for checkEligibility

Parameters:

qualificationsCheckEligibilityRequestBody - Define order and customer context. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

checkEligibility

public QualificationsCheckEligibilityResponseBody checkEligibility(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody)
                                                            throws ApiException

Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of Campaign Qualifications, Voucher Qualifications, and Promotions Validation API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version 👍 Scenario Guide Read the dedicated guide to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables.

Parameters:

qualificationsCheckEligibilityRequestBody - Define order and customer context. (optional)

Returns:

QualificationsCheckEligibilityResponseBody

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

checkEligibilityWithHttpInfo

public ApiResponse<QualificationsCheckEligibilityResponseBody> checkEligibilityWithHttpInfo(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody)
                                                                                     throws ApiException

Check Eligibility 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of Campaign Qualifications, Voucher Qualifications, and Promotions Validation API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version 👍 Scenario Guide Read the dedicated guide to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables.

Parameters:

qualificationsCheckEligibilityRequestBody - Define order and customer context. (optional)

Returns:

ApiResponse<QualificationsCheckEligibilityResponseBody>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

checkEligibilityAsync

public okhttp3.Call checkEligibilityAsync(QualificationsCheckEligibilityRequestBody qualificationsCheckEligibilityRequestBody,
 ApiCallback<QualificationsCheckEligibilityResponseBody> _callback)
                                   throws ApiException

Check Eligibility (asynchronously) 🚧 The Qualifications endpoint ignores the rules checking: - Limit of total redeemed discount amount per campaign - Limit of total redemptions count per campaign - Redemptions per customer - Redemptions per customer in a campaign Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of Campaign Qualifications, Voucher Qualifications, and Promotions Validation API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version 👍 Scenario Guide Read the dedicated guide to learn about some use cases this endpoint can cover. # Paging The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables.

Parameters:

qualificationsCheckEligibilityRequestBody - Define order and customer context. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object