Package io.voucherify.client.api

Class PromotionsApi

java.lang.Object

io.voucherify.client.api.PromotionsApi

public class PromotionsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PromotionsApi()
PromotionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
PromotionsTiersCreateResponseBody	addPromotionTierToCampaign(String campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody)	Add Promotion Tier to Campaign This method allows you to add a new promotion tier to an existing campaign.
okhttp3.Call	addPromotionTierToCampaignAsync(String campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, ApiCallback<PromotionsTiersCreateResponseBody> _callback)	Add Promotion Tier to Campaign (asynchronously) This method allows you to add a new promotion tier to an existing campaign.
okhttp3.Call	addPromotionTierToCampaignCall(String campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody, ApiCallback _callback)	Build call for addPromotionTierToCampaign
ApiResponse<PromotionsTiersCreateResponseBody>	addPromotionTierToCampaignWithHttpInfo(String campaignId, PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody)	Add Promotion Tier to Campaign This method allows you to add a new promotion tier to an existing campaign.
PromotionsStacksCreateResponseBody	createPromotionStack(String campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody)	Create Promotion Stack This method creates one promotion stack.
okhttp3.Call	createPromotionStackAsync(String campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, ApiCallback<PromotionsStacksCreateResponseBody> _callback)	Create Promotion Stack (asynchronously) This method creates one promotion stack.
okhttp3.Call	createPromotionStackCall(String campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody, ApiCallback _callback)	Build call for createPromotionStack
ApiResponse<PromotionsStacksCreateResponseBody>	createPromotionStackWithHttpInfo(String campaignId, PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody)	Create Promotion Stack This method creates one promotion stack.
void	deletePromotionStack(String campaignId, String stackId)	Delete Promotion Stack This method deletes a promotion stack.
okhttp3.Call	deletePromotionStackAsync(String campaignId, String stackId, ApiCallback<Void> _callback)	Delete Promotion Stack (asynchronously) This method deletes a promotion stack.
okhttp3.Call	deletePromotionStackCall(String campaignId, String stackId, ApiCallback _callback)	Build call for deletePromotionStack
ApiResponse<Void>	deletePromotionStackWithHttpInfo(String campaignId, String stackId)	Delete Promotion Stack This method deletes a promotion stack.
void	deletePromotionTier(String promotionTierId)	Delete Promotion Tier This method deletes a promotion tier.
okhttp3.Call	deletePromotionTierAsync(String promotionTierId, ApiCallback<Void> _callback)	Delete Promotion Tier (asynchronously) This method deletes a promotion tier.
okhttp3.Call	deletePromotionTierCall(String promotionTierId, ApiCallback _callback)	Build call for deletePromotionTier
ApiResponse<Void>	deletePromotionTierWithHttpInfo(String promotionTierId)	Delete Promotion Tier This method deletes a promotion tier.
PromotionsTiersDisableResponseBody	disablePromotionTier(String promotionTierId)	Disable Promotion Tier This method disables a promotion tier, i.e.
okhttp3.Call	disablePromotionTierAsync(String promotionTierId, ApiCallback<PromotionsTiersDisableResponseBody> _callback)	Disable Promotion Tier (asynchronously) This method disables a promotion tier, i.e.
okhttp3.Call	disablePromotionTierCall(String promotionTierId, ApiCallback _callback)	Build call for disablePromotionTier
ApiResponse<PromotionsTiersDisableResponseBody>	disablePromotionTierWithHttpInfo(String promotionTierId)	Disable Promotion Tier This method disables a promotion tier, i.e.
PromotionsTiersEnableResponseBody	enablePromotionTier(String promotionTierId)	Enable Promotion Tier This method enables a promotion tier, i.e.
okhttp3.Call	enablePromotionTierAsync(String promotionTierId, ApiCallback<PromotionsTiersEnableResponseBody> _callback)	Enable Promotion Tier (asynchronously) This method enables a promotion tier, i.e.
okhttp3.Call	enablePromotionTierCall(String promotionTierId, ApiCallback _callback)	Build call for enablePromotionTier
ApiResponse<PromotionsTiersEnableResponseBody>	enablePromotionTierWithHttpInfo(String promotionTierId)	Enable Promotion Tier This method enables a promotion tier, i.e.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
PromotionsStacksGetResponseBody	getPromotionStack(String campaignId, String stackId)	Get Promotion Stack This method returns the details of a promotion stack, including the promotion tiers grouped within the stack.
okhttp3.Call	getPromotionStackAsync(String campaignId, String stackId, ApiCallback<PromotionsStacksGetResponseBody> _callback)	Get Promotion Stack (asynchronously) This method returns the details of a promotion stack, including the promotion tiers grouped within the stack.
okhttp3.Call	getPromotionStackCall(String campaignId, String stackId, ApiCallback _callback)	Build call for getPromotionStack
ApiResponse<PromotionsStacksGetResponseBody>	getPromotionStackWithHttpInfo(String campaignId, String stackId)	Get Promotion Stack This method returns the details of a promotion stack, including the promotion tiers grouped within the stack.
PromotionsTiersGetResponseBody	getPromotionTier(String promotionTierId)	Get Promotion Tier This method enables you to retrieve a specific promotion tier.
okhttp3.Call	getPromotionTierAsync(String promotionTierId, ApiCallback<PromotionsTiersGetResponseBody> _callback)	Get Promotion Tier (asynchronously) This method enables you to retrieve a specific promotion tier.
okhttp3.Call	getPromotionTierCall(String promotionTierId, ApiCallback _callback)	Build call for getPromotionTier
ApiResponse<PromotionsTiersGetResponseBody>	getPromotionTierWithHttpInfo(String promotionTierId)	Get Promotion Tier This method enables you to retrieve a specific promotion tier.
PromotionsStacksListResponseBody	listAllPromotionStacks(Integer limit, Integer page, ParameterOrderListAllPromotionStacks order, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt)	List Promotion Stacks This method enables you to list promotion stacks irrespective of the campaign they are associated with.
okhttp3.Call	listAllPromotionStacksAsync(Integer limit, Integer page, ParameterOrderListAllPromotionStacks order, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ApiCallback<PromotionsStacksListResponseBody> _callback)	List Promotion Stacks (asynchronously) This method enables you to list promotion stacks irrespective of the campaign they are associated with.
okhttp3.Call	listAllPromotionStacksCall(Integer limit, Integer page, ParameterOrderListAllPromotionStacks order, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ApiCallback _callback)	Build call for listAllPromotionStacks
ApiResponse<PromotionsStacksListResponseBody>	listAllPromotionStacksWithHttpInfo(Integer limit, Integer page, ParameterOrderListAllPromotionStacks order, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt)	List Promotion Stacks This method enables you to list promotion stacks irrespective of the campaign they are associated with.
PromotionsStacksListResponseBody	listPromotionStacksInCampaign(String campaignId)	List Promotion Stacks in Campaign This method enables you to list promotion stacks from a specified campaign.
okhttp3.Call	listPromotionStacksInCampaignAsync(String campaignId, ApiCallback<PromotionsStacksListResponseBody> _callback)	List Promotion Stacks in Campaign (asynchronously) This method enables you to list promotion stacks from a specified campaign.
okhttp3.Call	listPromotionStacksInCampaignCall(String campaignId, ApiCallback _callback)	Build call for listPromotionStacksInCampaign
ApiResponse<PromotionsStacksListResponseBody>	listPromotionStacksInCampaignWithHttpInfo(String campaignId)	List Promotion Stacks in Campaign This method enables you to list promotion stacks from a specified campaign.
PromotionsTiersListResponseBody	listPromotionTiers(Boolean isAvailable, Integer limit, Integer page, ParameterOrderListPromotionTiers order)	List Promotion Tiers This method enables you to list promotion tiers.
okhttp3.Call	listPromotionTiersAsync(Boolean isAvailable, Integer limit, Integer page, ParameterOrderListPromotionTiers order, ApiCallback<PromotionsTiersListResponseBody> _callback)	List Promotion Tiers (asynchronously) This method enables you to list promotion tiers.
okhttp3.Call	listPromotionTiersCall(Boolean isAvailable, Integer limit, Integer page, ParameterOrderListPromotionTiers order, ApiCallback _callback)	Build call for listPromotionTiers
PromotionsTiersListResponseBody	listPromotionTiersFromCampaign(String campaignId)	List Promotion Tiers from Campaign This method enables you to list promotion tiers from a specified campaign.
okhttp3.Call	listPromotionTiersFromCampaignAsync(String campaignId, ApiCallback<PromotionsTiersListResponseBody> _callback)	List Promotion Tiers from Campaign (asynchronously) This method enables you to list promotion tiers from a specified campaign.
okhttp3.Call	listPromotionTiersFromCampaignCall(String campaignId, ApiCallback _callback)	Build call for listPromotionTiersFromCampaign
ApiResponse<PromotionsTiersListResponseBody>	listPromotionTiersFromCampaignWithHttpInfo(String campaignId)	List Promotion Tiers from Campaign This method enables you to list promotion tiers from a specified campaign.
ApiResponse<PromotionsTiersListResponseBody>	listPromotionTiersWithHttpInfo(Boolean isAvailable, Integer limit, Integer page, ParameterOrderListPromotionTiers order)	List Promotion Tiers This method enables you to list promotion tiers.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
PromotionsStacksUpdateResponseBody	updatePromotionStack(String campaignId, String stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody)	Update Promotion Stack This methods allows for editing an existing stack.
okhttp3.Call	updatePromotionStackAsync(String campaignId, String stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, ApiCallback<PromotionsStacksUpdateResponseBody> _callback)	Update Promotion Stack (asynchronously) This methods allows for editing an existing stack.
okhttp3.Call	updatePromotionStackCall(String campaignId, String stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody, ApiCallback _callback)	Build call for updatePromotionStack
ApiResponse<PromotionsStacksUpdateResponseBody>	updatePromotionStackWithHttpInfo(String campaignId, String stackId, PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody)	Update Promotion Stack This methods allows for editing an existing stack.
PromotionsTiersUpdateResponseBody	updatePromotionTier(String promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody)	Update Promotion Tier This method updates a promotion tier.
okhttp3.Call	updatePromotionTierAsync(String promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, ApiCallback<PromotionsTiersUpdateResponseBody> _callback)	Update Promotion Tier (asynchronously) This method updates a promotion tier.
okhttp3.Call	updatePromotionTierCall(String promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody, ApiCallback _callback)	Build call for updatePromotionTier
ApiResponse<PromotionsTiersUpdateResponseBody>	updatePromotionTierWithHttpInfo(String promotionTierId, PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody)	Update Promotion Tier This method updates a promotion tier.

Methods inherited from class java.lang.Object

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

Constructor Details

PromotionsApi

public PromotionsApi()

PromotionsApi

public PromotionsApi(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)

addPromotionTierToCampaignCall

public okhttp3.Call addPromotionTierToCampaignCall(String campaignId,
 PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody,
 ApiCallback _callback)
                                            throws ApiException

Build call for addPromotionTierToCampaign

Parameters:

campaignId - Unique campaign ID assigned by Voucherify. (required)

promotionsTiersCreateRequestBody - Specify the promotion tier parameters. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

addPromotionTierToCampaign

public PromotionsTiersCreateResponseBody addPromotionTierToCampaign(String campaignId,
 PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody)
                                                             throws ApiException

Add Promotion Tier to Campaign This method allows you to add a new promotion tier to an existing campaign. The tier hierarchy will be set as the next consequtive integer following the lowest ranking tier.

Parameters:

campaignId - Unique campaign ID assigned by Voucherify. (required)

promotionsTiersCreateRequestBody - Specify the promotion tier parameters. (optional)

Returns:

PromotionsTiersCreateResponseBody

Throws:

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

addPromotionTierToCampaignWithHttpInfo

public ApiResponse<PromotionsTiersCreateResponseBody> addPromotionTierToCampaignWithHttpInfo(String campaignId,
 PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody)
                                                                                      throws ApiException

Add Promotion Tier to Campaign This method allows you to add a new promotion tier to an existing campaign. The tier hierarchy will be set as the next consequtive integer following the lowest ranking tier.

Parameters:

campaignId - Unique campaign ID assigned by Voucherify. (required)

promotionsTiersCreateRequestBody - Specify the promotion tier parameters. (optional)

Returns:

ApiResponse<PromotionsTiersCreateResponseBody>

Throws:

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

addPromotionTierToCampaignAsync

public okhttp3.Call addPromotionTierToCampaignAsync(String campaignId,
 PromotionsTiersCreateRequestBody promotionsTiersCreateRequestBody,
 ApiCallback<PromotionsTiersCreateResponseBody> _callback)
                                             throws ApiException

Add Promotion Tier to Campaign (asynchronously) This method allows you to add a new promotion tier to an existing campaign. The tier hierarchy will be set as the next consequtive integer following the lowest ranking tier.

Parameters:

campaignId - Unique campaign ID assigned by Voucherify. (required)

promotionsTiersCreateRequestBody - Specify the promotion tier parameters. (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

createPromotionStackCall

public okhttp3.Call createPromotionStackCall(String campaignId,
 PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody,
 ApiCallback _callback)
                                      throws ApiException

Build call for createPromotionStack

Parameters:

campaignId - Unique campaign ID. (required)

promotionsStacksCreateRequestBody - Specify the order of promotion tiers for the promotion stack. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createPromotionStack

public PromotionsStacksCreateResponseBody createPromotionStack(String campaignId,
 PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody)
                                                        throws ApiException

Create Promotion Stack This method creates one promotion stack. The sequence of promotion tier IDs will determine the promotion stacking order.

Parameters:

campaignId - Unique campaign ID. (required)

promotionsStacksCreateRequestBody - Specify the order of promotion tiers for the promotion stack. (optional)

Returns:

PromotionsStacksCreateResponseBody

Throws:

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

createPromotionStackWithHttpInfo

public ApiResponse<PromotionsStacksCreateResponseBody> createPromotionStackWithHttpInfo(String campaignId,
 PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody)
                                                                                 throws ApiException

Create Promotion Stack This method creates one promotion stack. The sequence of promotion tier IDs will determine the promotion stacking order.

Parameters:

campaignId - Unique campaign ID. (required)

promotionsStacksCreateRequestBody - Specify the order of promotion tiers for the promotion stack. (optional)

Returns:

ApiResponse<PromotionsStacksCreateResponseBody>

Throws:

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

createPromotionStackAsync

public okhttp3.Call createPromotionStackAsync(String campaignId,
 PromotionsStacksCreateRequestBody promotionsStacksCreateRequestBody,
 ApiCallback<PromotionsStacksCreateResponseBody> _callback)
                                       throws ApiException

Create Promotion Stack (asynchronously) This method creates one promotion stack. The sequence of promotion tier IDs will determine the promotion stacking order.

Parameters:

campaignId - Unique campaign ID. (required)

promotionsStacksCreateRequestBody - Specify the order of promotion tiers for the promotion stack. (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

deletePromotionStackCall

public okhttp3.Call deletePromotionStackCall(String campaignId,
 String stackId,
 ApiCallback _callback)
                                      throws ApiException

Build call for deletePromotionStack

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deletePromotionStack

public void deletePromotionStack(String campaignId,
 String stackId)
                          throws ApiException

Delete Promotion Stack This method deletes a promotion stack.

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

Throws:

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

deletePromotionStackWithHttpInfo

public ApiResponse<Void> deletePromotionStackWithHttpInfo(String campaignId,
 String stackId)
                                                   throws ApiException

Delete Promotion Stack This method deletes a promotion stack.

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

Returns:

ApiResponse<Void>

Throws:

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

deletePromotionStackAsync

public okhttp3.Call deletePromotionStackAsync(String campaignId,
 String stackId,
 ApiCallback<Void> _callback)
                                       throws ApiException

Delete Promotion Stack (asynchronously) This method deletes a promotion stack.

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

_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

deletePromotionTierCall

public okhttp3.Call deletePromotionTierCall(String promotionTierId,
 ApiCallback _callback)
                                     throws ApiException

Build call for deletePromotionTier

Parameters:

promotionTierId - Unique promotion tier ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deletePromotionTier

public void deletePromotionTier(String promotionTierId)
                         throws ApiException

Delete Promotion Tier This method deletes a promotion tier.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

Throws:

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

deletePromotionTierWithHttpInfo

public ApiResponse<Void> deletePromotionTierWithHttpInfo(String promotionTierId)
                                                  throws ApiException

Delete Promotion Tier This method deletes a promotion tier.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

Returns:

ApiResponse<Void>

Throws:

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

deletePromotionTierAsync

public okhttp3.Call deletePromotionTierAsync(String promotionTierId,
 ApiCallback<Void> _callback)
                                      throws ApiException

Delete Promotion Tier (asynchronously) This method deletes a promotion tier.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

_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

disablePromotionTierCall

public okhttp3.Call disablePromotionTierCall(String promotionTierId,
 ApiCallback _callback)
                                      throws ApiException

Build call for disablePromotionTier

Parameters:

promotionTierId - Unique promotion tier ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

disablePromotionTier

public PromotionsTiersDisableResponseBody disablePromotionTier(String promotionTierId)
                                                        throws ApiException

Disable Promotion Tier This method disables a promotion tier, i.e. makes the active parameter false.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

Returns:

PromotionsTiersDisableResponseBody

Throws:

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

disablePromotionTierWithHttpInfo

public ApiResponse<PromotionsTiersDisableResponseBody> disablePromotionTierWithHttpInfo(String promotionTierId)
                                                                                 throws ApiException

Disable Promotion Tier This method disables a promotion tier, i.e. makes the active parameter false.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

Returns:

ApiResponse<PromotionsTiersDisableResponseBody>

Throws:

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

disablePromotionTierAsync

public okhttp3.Call disablePromotionTierAsync(String promotionTierId,
 ApiCallback<PromotionsTiersDisableResponseBody> _callback)
                                       throws ApiException

Disable Promotion Tier (asynchronously) This method disables a promotion tier, i.e. makes the active parameter false.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

_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

enablePromotionTierCall

public okhttp3.Call enablePromotionTierCall(String promotionTierId,
 ApiCallback _callback)
                                     throws ApiException

Build call for enablePromotionTier

Parameters:

promotionTierId - Unique promotion tier ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

enablePromotionTier

public PromotionsTiersEnableResponseBody enablePromotionTier(String promotionTierId)
                                                      throws ApiException

Enable Promotion Tier This method enables a promotion tier, i.e. makes the active parameter true.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

Returns:

PromotionsTiersEnableResponseBody

Throws:

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

enablePromotionTierWithHttpInfo

public ApiResponse<PromotionsTiersEnableResponseBody> enablePromotionTierWithHttpInfo(String promotionTierId)
                                                                               throws ApiException

Enable Promotion Tier This method enables a promotion tier, i.e. makes the active parameter true.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

Returns:

ApiResponse<PromotionsTiersEnableResponseBody>

Throws:

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

enablePromotionTierAsync

public okhttp3.Call enablePromotionTierAsync(String promotionTierId,
 ApiCallback<PromotionsTiersEnableResponseBody> _callback)
                                      throws ApiException

Enable Promotion Tier (asynchronously) This method enables a promotion tier, i.e. makes the active parameter true.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

_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

getPromotionStackCall

public okhttp3.Call getPromotionStackCall(String campaignId,
 String stackId,
 ApiCallback _callback)
                                   throws ApiException

Build call for getPromotionStack

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPromotionStack

public PromotionsStacksGetResponseBody getPromotionStack(String campaignId,
 String stackId)
                                                  throws ApiException

Get Promotion Stack This method returns the details of a promotion stack, including the promotion tiers grouped within the stack.

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

Returns:

PromotionsStacksGetResponseBody

Throws:

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

getPromotionStackWithHttpInfo

public ApiResponse<PromotionsStacksGetResponseBody> getPromotionStackWithHttpInfo(String campaignId,
 String stackId)
                                                                           throws ApiException

Get Promotion Stack This method returns the details of a promotion stack, including the promotion tiers grouped within the stack.

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

Returns:

ApiResponse<PromotionsStacksGetResponseBody>

Throws:

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

getPromotionStackAsync

public okhttp3.Call getPromotionStackAsync(String campaignId,
 String stackId,
 ApiCallback<PromotionsStacksGetResponseBody> _callback)
                                    throws ApiException

Get Promotion Stack (asynchronously) This method returns the details of a promotion stack, including the promotion tiers grouped within the stack.

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

_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

getPromotionTierCall

public okhttp3.Call getPromotionTierCall(String promotionTierId,
 ApiCallback _callback)
                                  throws ApiException

Build call for getPromotionTier

Parameters:

promotionTierId - Unique promotion tier ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPromotionTier

public PromotionsTiersGetResponseBody getPromotionTier(String promotionTierId)
                                                throws ApiException

Get Promotion Tier This method enables you to retrieve a specific promotion tier.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

Returns:

PromotionsTiersGetResponseBody

Throws:

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

getPromotionTierWithHttpInfo

public ApiResponse<PromotionsTiersGetResponseBody> getPromotionTierWithHttpInfo(String promotionTierId)
                                                                         throws ApiException

Get Promotion Tier This method enables you to retrieve a specific promotion tier.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

Returns:

ApiResponse<PromotionsTiersGetResponseBody>

Throws:

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

getPromotionTierAsync

public okhttp3.Call getPromotionTierAsync(String promotionTierId,
 ApiCallback<PromotionsTiersGetResponseBody> _callback)
                                   throws ApiException

Get Promotion Tier (asynchronously) This method enables you to retrieve a specific promotion tier.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

_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

listAllPromotionStacksCall

public okhttp3.Call listAllPromotionStacksCall(Integer limit,
 Integer page,
 ParameterOrderListAllPromotionStacks order,
 ParameterCreatedBeforeAfter createdAt,
 ParameterUpdatedBeforeAfter updatedAt,
 ApiCallback _callback)
                                        throws ApiException

Build call for listAllPromotionStacks

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

createdAt - A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z (optional)

updatedAt - A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before] 2017-09-08T13:52:18.227Z (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listAllPromotionStacks

public PromotionsStacksListResponseBody listAllPromotionStacks(Integer limit,
 Integer page,
 ParameterOrderListAllPromotionStacks order,
 ParameterCreatedBeforeAfter createdAt,
 ParameterUpdatedBeforeAfter updatedAt)
                                                        throws ApiException

List Promotion Stacks This method enables you to list promotion stacks irrespective of the campaign they are associated with. You can use filters in the query parameters to specify the stacks to be returned in the response. # Advanced filters for fetching promotion stacks

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

createdAt - A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z (optional)

updatedAt - A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before] 2017-09-08T13:52:18.227Z (optional)

Returns:

PromotionsStacksListResponseBody

Throws:

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

listAllPromotionStacksWithHttpInfo

public ApiResponse<PromotionsStacksListResponseBody> listAllPromotionStacksWithHttpInfo(Integer limit,
 Integer page,
 ParameterOrderListAllPromotionStacks order,
 ParameterCreatedBeforeAfter createdAt,
 ParameterUpdatedBeforeAfter updatedAt)
                                                                                 throws ApiException

List Promotion Stacks This method enables you to list promotion stacks irrespective of the campaign they are associated with. You can use filters in the query parameters to specify the stacks to be returned in the response. # Advanced filters for fetching promotion stacks

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

createdAt - A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z (optional)

updatedAt - A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before] 2017-09-08T13:52:18.227Z (optional)

Returns:

ApiResponse<PromotionsStacksListResponseBody>

Throws:

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

listAllPromotionStacksAsync

public okhttp3.Call listAllPromotionStacksAsync(Integer limit,
 Integer page,
 ParameterOrderListAllPromotionStacks order,
 ParameterCreatedBeforeAfter createdAt,
 ParameterUpdatedBeforeAfter updatedAt,
 ApiCallback<PromotionsStacksListResponseBody> _callback)
                                         throws ApiException

List Promotion Stacks (asynchronously) This method enables you to list promotion stacks irrespective of the campaign they are associated with. You can use filters in the query parameters to specify the stacks to be returned in the response. # Advanced filters for fetching promotion stacks

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

createdAt - A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before] 2017-09-08T13:52:18.227Z (optional)

updatedAt - A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before] 2017-09-08T13:52:18.227Z (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

listPromotionStacksInCampaignCall

public okhttp3.Call listPromotionStacksInCampaignCall(String campaignId,
 ApiCallback _callback)
                                               throws ApiException

Build call for listPromotionStacksInCampaign

Parameters:

campaignId - Unique campaign ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listPromotionStacksInCampaign

public PromotionsStacksListResponseBody listPromotionStacksInCampaign(String campaignId)
                                                               throws ApiException

List Promotion Stacks in Campaign This method enables you to list promotion stacks from a specified campaign.

Parameters:

campaignId - Unique campaign ID. (required)

Returns:

PromotionsStacksListResponseBody

Throws:

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

listPromotionStacksInCampaignWithHttpInfo

public ApiResponse<PromotionsStacksListResponseBody> listPromotionStacksInCampaignWithHttpInfo(String campaignId)
                                                                                        throws ApiException

List Promotion Stacks in Campaign This method enables you to list promotion stacks from a specified campaign.

Parameters:

campaignId - Unique campaign ID. (required)

Returns:

ApiResponse<PromotionsStacksListResponseBody>

Throws:

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

listPromotionStacksInCampaignAsync

public okhttp3.Call listPromotionStacksInCampaignAsync(String campaignId,
 ApiCallback<PromotionsStacksListResponseBody> _callback)
                                                throws ApiException

List Promotion Stacks in Campaign (asynchronously) This method enables you to list promotion stacks from a specified campaign.

Parameters:

campaignId - Unique campaign ID. (required)

_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

listPromotionTiersCall

public okhttp3.Call listPromotionTiersCall(Boolean isAvailable,
 Integer limit,
 Integer page,
 ParameterOrderListPromotionTiers order,
 ApiCallback _callback)
                                    throws ApiException

Build call for listPromotionTiers

Parameters:

isAvailable - This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions. (optional)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listPromotionTiers

public PromotionsTiersListResponseBody listPromotionTiers(Boolean isAvailable,
 Integer limit,
 Integer page,
 ParameterOrderListPromotionTiers order)
                                                   throws ApiException

List Promotion Tiers This method enables you to list promotion tiers.

Parameters:

isAvailable - This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions. (optional)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

Returns:

PromotionsTiersListResponseBody

Throws:

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

listPromotionTiersWithHttpInfo

public ApiResponse<PromotionsTiersListResponseBody> listPromotionTiersWithHttpInfo(Boolean isAvailable,
 Integer limit,
 Integer page,
 ParameterOrderListPromotionTiers order)
                                                                            throws ApiException

List Promotion Tiers This method enables you to list promotion tiers.

Parameters:

isAvailable - This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions. (optional)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

Returns:

ApiResponse<PromotionsTiersListResponseBody>

Throws:

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

listPromotionTiersAsync

public okhttp3.Call listPromotionTiersAsync(Boolean isAvailable,
 Integer limit,
 Integer page,
 ParameterOrderListPromotionTiers order,
 ApiCallback<PromotionsTiersListResponseBody> _callback)
                                     throws ApiException

List Promotion Tiers (asynchronously) This method enables you to list promotion tiers.

Parameters:

isAvailable - This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions. (optional)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (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

listPromotionTiersFromCampaignCall

public okhttp3.Call listPromotionTiersFromCampaignCall(String campaignId,
 ApiCallback _callback)
                                                throws ApiException

Build call for listPromotionTiersFromCampaign

Parameters:

campaignId - Unique campaign ID assigned by Voucherify. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listPromotionTiersFromCampaign

public PromotionsTiersListResponseBody listPromotionTiersFromCampaign(String campaignId)
                                                               throws ApiException

List Promotion Tiers from Campaign This method enables you to list promotion tiers from a specified campaign.

Parameters:

campaignId - Unique campaign ID assigned by Voucherify. (required)

Returns:

PromotionsTiersListResponseBody

Throws:

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

listPromotionTiersFromCampaignWithHttpInfo

public ApiResponse<PromotionsTiersListResponseBody> listPromotionTiersFromCampaignWithHttpInfo(String campaignId)
                                                                                        throws ApiException

List Promotion Tiers from Campaign This method enables you to list promotion tiers from a specified campaign.

Parameters:

campaignId - Unique campaign ID assigned by Voucherify. (required)

Returns:

ApiResponse<PromotionsTiersListResponseBody>

Throws:

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

listPromotionTiersFromCampaignAsync

public okhttp3.Call listPromotionTiersFromCampaignAsync(String campaignId,
 ApiCallback<PromotionsTiersListResponseBody> _callback)
                                                 throws ApiException

List Promotion Tiers from Campaign (asynchronously) This method enables you to list promotion tiers from a specified campaign.

Parameters:

campaignId - Unique campaign ID assigned by Voucherify. (required)

_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

updatePromotionStackCall

public okhttp3.Call updatePromotionStackCall(String campaignId,
 String stackId,
 PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody,
 ApiCallback _callback)
                                      throws ApiException

Build call for updatePromotionStack

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

promotionsStacksUpdateRequestBody - Specify the promotion stack parameters that you would like to update. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updatePromotionStack

public PromotionsStacksUpdateResponseBody updatePromotionStack(String campaignId,
 String stackId,
 PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody)
                                                        throws ApiException

Update Promotion Stack This methods allows for editing an existing stack.

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

promotionsStacksUpdateRequestBody - Specify the promotion stack parameters that you would like to update. (optional)

Returns:

PromotionsStacksUpdateResponseBody

Throws:

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

updatePromotionStackWithHttpInfo

public ApiResponse<PromotionsStacksUpdateResponseBody> updatePromotionStackWithHttpInfo(String campaignId,
 String stackId,
 PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody)
                                                                                 throws ApiException

Update Promotion Stack This methods allows for editing an existing stack.

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

promotionsStacksUpdateRequestBody - Specify the promotion stack parameters that you would like to update. (optional)

Returns:

ApiResponse<PromotionsStacksUpdateResponseBody>

Throws:

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

updatePromotionStackAsync

public okhttp3.Call updatePromotionStackAsync(String campaignId,
 String stackId,
 PromotionsStacksUpdateRequestBody promotionsStacksUpdateRequestBody,
 ApiCallback<PromotionsStacksUpdateResponseBody> _callback)
                                       throws ApiException

Update Promotion Stack (asynchronously) This methods allows for editing an existing stack.

Parameters:

campaignId - ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign. (required)

stackId - Promotion stack ID. (required)

promotionsStacksUpdateRequestBody - Specify the promotion stack parameters that you would like to update. (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

updatePromotionTierCall

public okhttp3.Call updatePromotionTierCall(String promotionTierId,
 PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody,
 ApiCallback _callback)
                                     throws ApiException

Build call for updatePromotionTier

Parameters:

promotionTierId - Unique promotion tier ID. (required)

promotionsTiersUpdateRequestBody - Specify the promotion tier parameters that you would like to update. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updatePromotionTier

public PromotionsTiersUpdateResponseBody updatePromotionTier(String promotionTierId,
 PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody)
                                                      throws ApiException

Update Promotion Tier This method updates a promotion tier.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

promotionsTiersUpdateRequestBody - Specify the promotion tier parameters that you would like to update. (optional)

Returns:

PromotionsTiersUpdateResponseBody

Throws:

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

updatePromotionTierWithHttpInfo

public ApiResponse<PromotionsTiersUpdateResponseBody> updatePromotionTierWithHttpInfo(String promotionTierId,
 PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody)
                                                                               throws ApiException

Update Promotion Tier This method updates a promotion tier.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

promotionsTiersUpdateRequestBody - Specify the promotion tier parameters that you would like to update. (optional)

Returns:

ApiResponse<PromotionsTiersUpdateResponseBody>

Throws:

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

updatePromotionTierAsync

public okhttp3.Call updatePromotionTierAsync(String promotionTierId,
 PromotionsTiersUpdateRequestBody promotionsTiersUpdateRequestBody,
 ApiCallback<PromotionsTiersUpdateResponseBody> _callback)
                                      throws ApiException

Update Promotion Tier (asynchronously) This method updates a promotion tier.

Parameters:

promotionTierId - Unique promotion tier ID. (required)

promotionsTiersUpdateRequestBody - Specify the promotion tier parameters that you would like to update. (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