Package io.voucherify.client.api

Class TemplatesApi

java.lang.Object

io.voucherify.client.api.TemplatesApi

public class TemplatesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
TemplatesApi()
TemplatesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
TemplatesCampaignsTierSetupCreateResponseBody	addTierFromTemplate(String campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody)	Add Promotion Tier From Template Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign.
okhttp3.Call	addTierFromTemplateAsync(String campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, ApiCallback<TemplatesCampaignsTierSetupCreateResponseBody> _callback)	Add Promotion Tier From Template (asynchronously) Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign.
okhttp3.Call	addTierFromTemplateCall(String campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody, ApiCallback _callback)	Build call for addTierFromTemplate
ApiResponse<TemplatesCampaignsTierSetupCreateResponseBody>	addTierFromTemplateWithHttpInfo(String campaignTemplateId, TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody)	Add Promotion Tier From Template Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign.
TemplatesCampaignsCampaignSetupCreateResponseBody	createCampaignFromTemplate(String campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody)	Create Campaign From Template Creates a campaign out of a campaign template.
okhttp3.Call	createCampaignFromTemplateAsync(String campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, ApiCallback<TemplatesCampaignsCampaignSetupCreateResponseBody> _callback)	Create Campaign From Template (asynchronously) Creates a campaign out of a campaign template.
okhttp3.Call	createCampaignFromTemplateCall(String campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody, ApiCallback _callback)	Build call for createCampaignFromTemplate
ApiResponse<TemplatesCampaignsCampaignSetupCreateResponseBody>	createCampaignFromTemplateWithHttpInfo(String campaignTemplateId, TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody)	Create Campaign From Template Creates a campaign out of a campaign template.
TemplatesCampaignsCreateTemplateResponseBody	createCampaignTemplate(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody)	Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier.
okhttp3.Call	createCampaignTemplateAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, ApiCallback<TemplatesCampaignsCreateTemplateResponseBody> _callback)	Create Campaign Template (asynchronously) Creates a template for a discount or gift campaign, or a promotion tier.
okhttp3.Call	createCampaignTemplateCall(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody, ApiCallback _callback)	Build call for createCampaignTemplate
ApiResponse<TemplatesCampaignsCreateTemplateResponseBody>	createCampaignTemplateWithHttpInfo(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody)	Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier.
void	deleteCampaignTemplate(String campaignTemplateId)	Delete Campaign Template Deletes the campaign template permanently.
okhttp3.Call	deleteCampaignTemplateAsync(String campaignTemplateId, ApiCallback<Void> _callback)	Delete Campaign Template (asynchronously) Deletes the campaign template permanently.
okhttp3.Call	deleteCampaignTemplateCall(String campaignTemplateId, ApiCallback _callback)	Build call for deleteCampaignTemplate
ApiResponse<Void>	deleteCampaignTemplateWithHttpInfo(String campaignTemplateId)	Delete Campaign Template Deletes the campaign template permanently.
ApiClient	getApiClient()
TemplatesCampaignsGetResponseBody	getCampaignTemplate(String campaignTemplateId)	Get Campaign Template Retrieves a campaign template available in the project.
okhttp3.Call	getCampaignTemplateAsync(String campaignTemplateId, ApiCallback<TemplatesCampaignsGetResponseBody> _callback)	Get Campaign Template (asynchronously) Retrieves a campaign template available in the project.
okhttp3.Call	getCampaignTemplateCall(String campaignTemplateId, ApiCallback _callback)	Build call for getCampaignTemplate
ApiResponse<TemplatesCampaignsGetResponseBody>	getCampaignTemplateWithHttpInfo(String campaignTemplateId)	Get Campaign Template Retrieves a campaign template available in the project.
String	getCustomBaseUrl()
int	getHostIndex()
TemplatesCampaignsListResponseBody	listCampaignTemplates(Integer limit, String startingAfterId, ParameterTemplatesList order, Boolean includeTotal, ParameterFiltersListTemplates filters)	List Campaign Templates Lists all campaign templates available in the project.
okhttp3.Call	listCampaignTemplatesAsync(Integer limit, String startingAfterId, ParameterTemplatesList order, Boolean includeTotal, ParameterFiltersListTemplates filters, ApiCallback<TemplatesCampaignsListResponseBody> _callback)	List Campaign Templates (asynchronously) Lists all campaign templates available in the project.
okhttp3.Call	listCampaignTemplatesCall(Integer limit, String startingAfterId, ParameterTemplatesList order, Boolean includeTotal, ParameterFiltersListTemplates filters, ApiCallback _callback)	Build call for listCampaignTemplates
ApiResponse<TemplatesCampaignsListResponseBody>	listCampaignTemplatesWithHttpInfo(Integer limit, String startingAfterId, ParameterTemplatesList order, Boolean includeTotal, ParameterFiltersListTemplates filters)	List Campaign Templates Lists all campaign templates available in the project.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
TemplatesCampaignsUpdateResponseBody	updateCampaignTemplate(String campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody)	Update Campaign Template Updates the name or description of the campaign template.
okhttp3.Call	updateCampaignTemplateAsync(String campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, ApiCallback<TemplatesCampaignsUpdateResponseBody> _callback)	Update Campaign Template (asynchronously) Updates the name or description of the campaign template.
okhttp3.Call	updateCampaignTemplateCall(String campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody, ApiCallback _callback)	Build call for updateCampaignTemplate
ApiResponse<TemplatesCampaignsUpdateResponseBody>	updateCampaignTemplateWithHttpInfo(String campaignTemplateId, TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody)	Update Campaign Template Updates the name or description of the campaign template.

Methods inherited from class java.lang.Object

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

Constructor Details

TemplatesApi

public TemplatesApi()

TemplatesApi

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

addTierFromTemplateCall

public okhttp3.Call addTierFromTemplateCall(String campaignTemplateId,
 TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody,
 ApiCallback _callback)
                                     throws ApiException

Build call for addTierFromTemplate

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsTierSetupCreateRequestBody - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

addTierFromTemplate

public TemplatesCampaignsTierSetupCreateResponseBody addTierFromTemplate(String campaignTemplateId,
 TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody)
                                                                  throws ApiException

Add Promotion Tier From Template Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule. 👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsTierSetupCreateRequestBody - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional)

Returns:

TemplatesCampaignsTierSetupCreateResponseBody

Throws:

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

addTierFromTemplateWithHttpInfo

public ApiResponse<TemplatesCampaignsTierSetupCreateResponseBody> addTierFromTemplateWithHttpInfo(String campaignTemplateId,
 TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody)
                                                                                           throws ApiException

Add Promotion Tier From Template Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule. 👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsTierSetupCreateRequestBody - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (optional)

Returns:

ApiResponse<TemplatesCampaignsTierSetupCreateResponseBody>

Throws:

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

addTierFromTemplateAsync

public okhttp3.Call addTierFromTemplateAsync(String campaignTemplateId,
 TemplatesCampaignsTierSetupCreateRequestBody templatesCampaignsTierSetupCreateRequestBody,
 ApiCallback<TemplatesCampaignsTierSetupCreateResponseBody> _callback)
                                      throws ApiException

Add Promotion Tier From Template (asynchronously) Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule. 👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsTierSetupCreateRequestBody - Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. (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

createCampaignFromTemplateCall

public okhttp3.Call createCampaignFromTemplateCall(String campaignTemplateId,
 TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody,
 ApiCallback _callback)
                                            throws ApiException

Build call for createCampaignFromTemplate

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsCampaignSetupCreateRequestBody - Only name is required. The rest of the fields will overwrite the template configuration. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createCampaignFromTemplate

public TemplatesCampaignsCampaignSetupCreateResponseBody createCampaignFromTemplate(String campaignTemplateId,
 TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody)
                                                                             throws ApiException

Create Campaign From Template Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule. 👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsCampaignSetupCreateRequestBody - Only name is required. The rest of the fields will overwrite the template configuration. (optional)

Returns:

TemplatesCampaignsCampaignSetupCreateResponseBody

Throws:

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

createCampaignFromTemplateWithHttpInfo

public ApiResponse<TemplatesCampaignsCampaignSetupCreateResponseBody> createCampaignFromTemplateWithHttpInfo(String campaignTemplateId,
 TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody)
                                                                                                      throws ApiException

Create Campaign From Template Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule. 👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsCampaignSetupCreateRequestBody - Only name is required. The rest of the fields will overwrite the template configuration. (optional)

Returns:

ApiResponse<TemplatesCampaignsCampaignSetupCreateResponseBody>

Throws:

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

createCampaignFromTemplateAsync

public okhttp3.Call createCampaignFromTemplateAsync(String campaignTemplateId,
 TemplatesCampaignsCampaignSetupCreateRequestBody templatesCampaignsCampaignSetupCreateRequestBody,
 ApiCallback<TemplatesCampaignsCampaignSetupCreateResponseBody> _callback)
                                             throws ApiException

Create Campaign From Template (asynchronously) Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule. 👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsCampaignSetupCreateRequestBody - Only name is required. The rest of the fields will overwrite the template configuration. (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

createCampaignTemplateCall

public okhttp3.Call createCampaignTemplateCall(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody,
 ApiCallback _callback)
                                        throws ApiException

Build call for createCampaignTemplate

Parameters:

templatesCampaignsCreateRequestBody - Provide details for a campaign template (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createCampaignTemplate

public TemplatesCampaignsCreateTemplateResponseBody createCampaignTemplate(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody)
                                                                    throws ApiException

Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments 👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign, - Promotion tier. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

templatesCampaignsCreateRequestBody - Provide details for a campaign template (optional)

Returns:

TemplatesCampaignsCreateTemplateResponseBody

Throws:

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

createCampaignTemplateWithHttpInfo

public ApiResponse<TemplatesCampaignsCreateTemplateResponseBody> createCampaignTemplateWithHttpInfo(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody)
                                                                                             throws ApiException

Create Campaign Template Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments 👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign, - Promotion tier. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

templatesCampaignsCreateRequestBody - Provide details for a campaign template (optional)

Returns:

ApiResponse<TemplatesCampaignsCreateTemplateResponseBody>

Throws:

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

createCampaignTemplateAsync

public okhttp3.Call createCampaignTemplateAsync(TemplatesCampaignsCreateRequestBody templatesCampaignsCreateRequestBody,
 ApiCallback<TemplatesCampaignsCreateTemplateResponseBody> _callback)
                                         throws ApiException

Create Campaign Template (asynchronously) Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments 👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign, - Promotion tier. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

templatesCampaignsCreateRequestBody - Provide details for a campaign template (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

deleteCampaignTemplateCall

public okhttp3.Call deleteCampaignTemplateCall(String campaignTemplateId,
 ApiCallback _callback)
                                        throws ApiException

Build call for deleteCampaignTemplate

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteCampaignTemplate

public void deleteCampaignTemplate(String campaignTemplateId)
                            throws ApiException

Delete Campaign Template Deletes the campaign template permanently. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

Throws:

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

deleteCampaignTemplateWithHttpInfo

public ApiResponse<Void> deleteCampaignTemplateWithHttpInfo(String campaignTemplateId)
                                                     throws ApiException

Delete Campaign Template Deletes the campaign template permanently. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteCampaignTemplateAsync

public okhttp3.Call deleteCampaignTemplateAsync(String campaignTemplateId,
 ApiCallback<Void> _callback)
                                         throws ApiException

Delete Campaign Template (asynchronously) Deletes the campaign template permanently. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was 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

getCampaignTemplateCall

public okhttp3.Call getCampaignTemplateCall(String campaignTemplateId,
 ApiCallback _callback)
                                     throws ApiException

Build call for getCampaignTemplate

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCampaignTemplate

public TemplatesCampaignsGetResponseBody getCampaignTemplate(String campaignTemplateId)
                                                      throws ApiException

Get Campaign Template Retrieves a campaign template available in the project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

Returns:

TemplatesCampaignsGetResponseBody

Throws:

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

getCampaignTemplateWithHttpInfo

public ApiResponse<TemplatesCampaignsGetResponseBody> getCampaignTemplateWithHttpInfo(String campaignTemplateId)
                                                                               throws ApiException

Get Campaign Template Retrieves a campaign template available in the project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

Returns:

ApiResponse<TemplatesCampaignsGetResponseBody>

Throws:

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

getCampaignTemplateAsync

public okhttp3.Call getCampaignTemplateAsync(String campaignTemplateId,
 ApiCallback<TemplatesCampaignsGetResponseBody> _callback)
                                      throws ApiException

Get Campaign Template (asynchronously) Retrieves a campaign template available in the project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was 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

listCampaignTemplatesCall

public okhttp3.Call listCampaignTemplatesCall(Integer limit,
 String startingAfterId,
 ParameterTemplatesList order,
 Boolean includeTotal,
 ParameterFiltersListTemplates filters,
 ApiCallback _callback)
                                       throws ApiException

Build call for listCampaignTemplates

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

startingAfterId - A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. (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)

includeTotal - If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. (optional)

filters - Filters for listing templates. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listCampaignTemplates

public TemplatesCampaignsListResponseBody listCampaignTemplates(Integer limit,
 String startingAfterId,
 ParameterTemplatesList order,
 Boolean includeTotal,
 ParameterFiltersListTemplates filters)
                                                         throws ApiException

List Campaign Templates Lists all campaign templates available in the project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

startingAfterId - A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. (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)

includeTotal - If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. (optional)

filters - Filters for listing templates. (optional)

Returns:

TemplatesCampaignsListResponseBody

Throws:

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

listCampaignTemplatesWithHttpInfo

public ApiResponse<TemplatesCampaignsListResponseBody> listCampaignTemplatesWithHttpInfo(Integer limit,
 String startingAfterId,
 ParameterTemplatesList order,
 Boolean includeTotal,
 ParameterFiltersListTemplates filters)
                                                                                  throws ApiException

List Campaign Templates Lists all campaign templates available in the project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

startingAfterId - A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. (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)

includeTotal - If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. (optional)

filters - Filters for listing templates. (optional)

Returns:

ApiResponse<TemplatesCampaignsListResponseBody>

Throws:

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

listCampaignTemplatesAsync

public okhttp3.Call listCampaignTemplatesAsync(Integer limit,
 String startingAfterId,
 ParameterTemplatesList order,
 Boolean includeTotal,
 ParameterFiltersListTemplates filters,
 ApiCallback<TemplatesCampaignsListResponseBody> _callback)
                                        throws ApiException

List Campaign Templates (asynchronously) Lists all campaign templates available in the project. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

startingAfterId - A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. (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)

includeTotal - If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. (optional)

filters - Filters for listing templates. (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

updateCampaignTemplateCall

public okhttp3.Call updateCampaignTemplateCall(String campaignTemplateId,
 TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody,
 ApiCallback _callback)
                                        throws ApiException

Build call for updateCampaignTemplate

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsUpdateRequestBody - Provide the new name or description for the campaign template (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateCampaignTemplate

public TemplatesCampaignsUpdateResponseBody updateCampaignTemplate(String campaignTemplateId,
 TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody)
                                                            throws ApiException

Update Campaign Template Updates the name or description of the campaign template. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsUpdateRequestBody - Provide the new name or description for the campaign template (optional)

Returns:

TemplatesCampaignsUpdateResponseBody

Throws:

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

updateCampaignTemplateWithHttpInfo

public ApiResponse<TemplatesCampaignsUpdateResponseBody> updateCampaignTemplateWithHttpInfo(String campaignTemplateId,
 TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody)
                                                                                     throws ApiException

Update Campaign Template Updates the name or description of the campaign template. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsUpdateRequestBody - Provide the new name or description for the campaign template (optional)

Returns:

ApiResponse<TemplatesCampaignsUpdateResponseBody>

Throws:

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

updateCampaignTemplateAsync

public okhttp3.Call updateCampaignTemplateAsync(String campaignTemplateId,
 TemplatesCampaignsUpdateRequestBody templatesCampaignsUpdateRequestBody,
 ApiCallback<TemplatesCampaignsUpdateResponseBody> _callback)
                                         throws ApiException

Update Campaign Template (asynchronously) Updates the name or description of the campaign template. 📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.

Parameters:

campaignTemplateId - Pass the campaign template ID that was assigned by Voucherify. (required)

templatesCampaignsUpdateRequestBody - Provide the new name or description for the campaign template (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