Package io.voucherify.client.api

Class VouchersApi

java.lang.Object
io.voucherify.client.api.VouchersApi
public class VouchersApi extends Object

  • Constructor Details

    • VouchersApi

      public VouchersApi()

    • VouchersApi

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

    • createVoucherCall

      public okhttp3.Call createVoucherCall(String code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, ApiCallback _callback) throws ApiException
      Build call for createVoucher
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      vouchersCreateWithSpecificCodeRequestBody - Specify the details of the voucher that you would like to create. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • createVoucher

      public VouchersCreateResponseBody createVoucher(String code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody) throws ApiException
      Create Voucher Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new standalone voucher if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In the case of the loyalty card, a campaign name or ID is required. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a standalone voucher campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      vouchersCreateWithSpecificCodeRequestBody - Specify the details of the voucher that you would like to create. (optional)
      Returns:
      VouchersCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createVoucherWithHttpInfo

      public ApiResponse<VouchersCreateResponseBody> createVoucherWithHttpInfo(String code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody) throws ApiException
      Create Voucher Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new standalone voucher if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In the case of the loyalty card, a campaign name or ID is required. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a standalone voucher campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      vouchersCreateWithSpecificCodeRequestBody - Specify the details of the voucher that you would like to create. (optional)
      Returns:
      ApiResponse<VouchersCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createVoucherAsync

      public okhttp3.Call createVoucherAsync(String code, VouchersCreateWithSpecificCodeRequestBody vouchersCreateWithSpecificCodeRequestBody, ApiCallback<VouchersCreateResponseBody> _callback) throws ApiException
      Create Voucher (asynchronously) Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new standalone voucher if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In the case of the loyalty card, a campaign name or ID is required. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a standalone voucher campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      vouchersCreateWithSpecificCodeRequestBody - Specify the details of the voucher that you would like to create. (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

    • deleteVoucherCall

      public okhttp3.Call deleteVoucherCall(String code, Boolean force, ApiCallback _callback) throws ApiException
      Build call for deleteVoucher
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      force - If this flag is set to true, the voucher will be removed permanently. If it is set to false or not set at all, the voucher will be moved to the bin. Going forward, the user will be able to create another voucher with exactly the same code. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • deleteVoucher

      public void deleteVoucher(String code, Boolean force) throws ApiException
      Delete Voucher Deletes a voucher. This operation cannot be undone. Additionally, this operation removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the voucher will be moved to the bin.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      force - If this flag is set to true, the voucher will be removed permanently. If it is set to false or not set at all, the voucher will be moved to the bin. Going forward, the user will be able to create another voucher with exactly the same code. (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteVoucherWithHttpInfo

      public ApiResponse<Void> deleteVoucherWithHttpInfo(String code, Boolean force) throws ApiException
      Delete Voucher Deletes a voucher. This operation cannot be undone. Additionally, this operation removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the voucher will be moved to the bin.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      force - If this flag is set to true, the voucher will be removed permanently. If it is set to false or not set at all, the voucher will be moved to the bin. Going forward, the user will be able to create another voucher with exactly the same code. (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteVoucherAsync

      public okhttp3.Call deleteVoucherAsync(String code, Boolean force, ApiCallback<Void> _callback) throws ApiException
      Delete Voucher (asynchronously) Deletes a voucher. This operation cannot be undone. Additionally, this operation removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the voucher will be moved to the bin.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      force - If this flag is set to true, the voucher will be removed permanently. If it is set to false or not set at all, the voucher will be moved to the bin. Going forward, the user will be able to create another voucher with exactly the same code. (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

    • disableVoucherCall

      public okhttp3.Call disableVoucherCall(String code, ApiCallback _callback) throws ApiException
      Build call for disableVoucher
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • disableVoucher

      public VouchersDisableResponseBody disableVoucher(String code) throws ApiException
      Disable Voucher There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - *enable* and *disable*. ___ This method sets the voucher state to **inactive**. The voucher cannot be redeemed.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      Returns:
      VouchersDisableResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • disableVoucherWithHttpInfo

      public ApiResponse<VouchersDisableResponseBody> disableVoucherWithHttpInfo(String code) throws ApiException
      Disable Voucher There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - *enable* and *disable*. ___ This method sets the voucher state to **inactive**. The voucher cannot be redeemed.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      Returns:
      ApiResponse<VouchersDisableResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • disableVoucherAsync

      public okhttp3.Call disableVoucherAsync(String code, ApiCallback<VouchersDisableResponseBody> _callback) throws ApiException
      Disable Voucher (asynchronously) There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - *enable* and *disable*. ___ This method sets the voucher state to **inactive**. The voucher cannot be redeemed.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (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

    • enableVoucherCall

      public okhttp3.Call enableVoucherCall(String code, ApiCallback _callback) throws ApiException
      Build call for enableVoucher
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • enableVoucher

      public VouchersEnableResponseBody enableVoucher(String code) throws ApiException
      Enable Voucher There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - *enable* and *disable*. ___ The method sets the voucher state to **active**. The voucher can be redeemed - only if the redemption occurs after the start date and the voucher is not expired.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      Returns:
      VouchersEnableResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • enableVoucherWithHttpInfo

      public ApiResponse<VouchersEnableResponseBody> enableVoucherWithHttpInfo(String code) throws ApiException
      Enable Voucher There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - *enable* and *disable*. ___ The method sets the voucher state to **active**. The voucher can be redeemed - only if the redemption occurs after the start date and the voucher is not expired.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      Returns:
      ApiResponse<VouchersEnableResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • enableVoucherAsync

      public okhttp3.Call enableVoucherAsync(String code, ApiCallback<VouchersEnableResponseBody> _callback) throws ApiException
      Enable Voucher (asynchronously) There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - *enable* and *disable*. ___ The method sets the voucher state to **active**. The voucher can be redeemed - only if the redemption occurs after the start date and the voucher is not expired.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (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

    • exportVoucherTransactionsCall

      public okhttp3.Call exportVoucherTransactionsCall(String code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, ApiCallback _callback) throws ApiException
      Build call for exportVoucherTransactions
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      vouchersTransactionsExportCreateRequestBody - Specify the parameters for the camapign transaction export. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • exportVoucherTransactions

      public VouchersTransactionsExportCreateResponseBody exportVoucherTransactions(String code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody) throws ApiException
      Export Voucher Transactions Export transactions that are associated with credit movements on a gift card or loyalty card.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      vouchersTransactionsExportCreateRequestBody - Specify the parameters for the camapign transaction export. (optional)
      Returns:
      VouchersTransactionsExportCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • exportVoucherTransactionsWithHttpInfo

      public ApiResponse<VouchersTransactionsExportCreateResponseBody> exportVoucherTransactionsWithHttpInfo(String code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody) throws ApiException
      Export Voucher Transactions Export transactions that are associated with credit movements on a gift card or loyalty card.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      vouchersTransactionsExportCreateRequestBody - Specify the parameters for the camapign transaction export. (optional)
      Returns:
      ApiResponse<VouchersTransactionsExportCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • exportVoucherTransactionsAsync

      public okhttp3.Call exportVoucherTransactionsAsync(String code, VouchersTransactionsExportCreateRequestBody vouchersTransactionsExportCreateRequestBody, ApiCallback<VouchersTransactionsExportCreateResponseBody> _callback) throws ApiException
      Export Voucher Transactions (asynchronously) Export transactions that are associated with credit movements on a gift card or loyalty card.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      vouchersTransactionsExportCreateRequestBody - Specify the parameters for the camapign transaction export. (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

    • generateRandomCodeCall

      public okhttp3.Call generateRandomCodeCall(VouchersCreateRequestBody vouchersCreateRequestBody, ApiCallback _callback) throws ApiException
      Build call for generateRandomCode
      Parameters:
      vouchersCreateRequestBody - Specify the details of the voucher that you would like to create. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • generateRandomCode

      public VouchersCreateResponseBody generateRandomCode(VouchersCreateRequestBody vouchersCreateRequestBody) throws ApiException
      Generate Random Code Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new standalone voucher if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a standalone voucher campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
      Parameters:
      vouchersCreateRequestBody - Specify the details of the voucher that you would like to create. (optional)
      Returns:
      VouchersCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • generateRandomCodeWithHttpInfo

      public ApiResponse<VouchersCreateResponseBody> generateRandomCodeWithHttpInfo(VouchersCreateRequestBody vouchersCreateRequestBody) throws ApiException
      Generate Random Code Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new standalone voucher if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a standalone voucher campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
      Parameters:
      vouchersCreateRequestBody - Specify the details of the voucher that you would like to create. (optional)
      Returns:
      ApiResponse<VouchersCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • generateRandomCodeAsync

      public okhttp3.Call generateRandomCodeAsync(VouchersCreateRequestBody vouchersCreateRequestBody, ApiCallback<VouchersCreateResponseBody> _callback) throws ApiException
      Generate Random Code (asynchronously) Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new standalone voucher if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required. You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API. This method will return an error when trying to create a voucher that already exists. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null. Voucherify developers work on adding an optional feature to create a standalone voucher campaign through the API. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
      Parameters:
      vouchersCreateRequestBody - Specify the details of the voucher that you would like to create. (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

    • getVoucherCall

      public okhttp3.Call getVoucherCall(String code, ApiCallback _callback) throws ApiException
      Build call for getVoucher
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getVoucher

      public VouchersGetResponseBody getVoucher(String code) throws ApiException
      Get Voucher Retrieves the voucher with the given code or unique Voucherify ID. You can either pass the voucher ID which was assigned by Voucherify, e.g., v_7HxHkf4VAkMuc8u4lZs78lyRwhRze5UE, or the code of the voucher as the path parameter value, e.g., 7fjWdr.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      Returns:
      VouchersGetResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getVoucherWithHttpInfo

      public ApiResponse<VouchersGetResponseBody> getVoucherWithHttpInfo(String code) throws ApiException
      Get Voucher Retrieves the voucher with the given code or unique Voucherify ID. You can either pass the voucher ID which was assigned by Voucherify, e.g., v_7HxHkf4VAkMuc8u4lZs78lyRwhRze5UE, or the code of the voucher as the path parameter value, e.g., 7fjWdr.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      Returns:
      ApiResponse<VouchersGetResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getVoucherAsync

      public okhttp3.Call getVoucherAsync(String code, ApiCallback<VouchersGetResponseBody> _callback) throws ApiException
      Get Voucher (asynchronously) Retrieves the voucher with the given code or unique Voucherify ID. You can either pass the voucher ID which was assigned by Voucherify, e.g., v_7HxHkf4VAkMuc8u4lZs78lyRwhRze5UE, or the code of the voucher as the path parameter value, e.g., 7fjWdr.
      Parameters:
      code - A unique **code** that identifies the voucher. (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

    • importVouchersCall

      public okhttp3.Call importVouchersCall(List<VouchersImportCreateItemRequestBody> vouchersImportCreateItemRequestBody, ApiCallback _callback) throws ApiException
      Build call for importVouchers
      Parameters:
      vouchersImportCreateItemRequestBody - The request body is an array of objects. Each object contains details about a specific voucher. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • importVouchers

      public VouchersImportCreateResponseBody importVouchers(List<VouchersImportCreateItemRequestBody> vouchersImportCreateItemRequestBody) throws ApiException
      Import Vouchers Import standalone vouchers and gift cards into the repository. 📘 Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
      Parameters:
      vouchersImportCreateItemRequestBody - The request body is an array of objects. Each object contains details about a specific voucher. (required)
      Returns:
      VouchersImportCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • importVouchersWithHttpInfo

      public ApiResponse<VouchersImportCreateResponseBody> importVouchersWithHttpInfo(List<VouchersImportCreateItemRequestBody> vouchersImportCreateItemRequestBody) throws ApiException
      Import Vouchers Import standalone vouchers and gift cards into the repository. 📘 Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
      Parameters:
      vouchersImportCreateItemRequestBody - The request body is an array of objects. Each object contains details about a specific voucher. (required)
      Returns:
      ApiResponse<VouchersImportCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • importVouchersAsync

      public okhttp3.Call importVouchersAsync(List<VouchersImportCreateItemRequestBody> vouchersImportCreateItemRequestBody, ApiCallback<VouchersImportCreateResponseBody> _callback) throws ApiException
      Import Vouchers (asynchronously) Import standalone vouchers and gift cards into the repository. 📘 Important notes - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both **standalone discount vouchers and gift cards**, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For **gift cards**, you can also import the following field: - gift.amount For **discount vouchers**, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type **requires** the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
      Parameters:
      vouchersImportCreateItemRequestBody - The request body is an array of objects. Each object contains details about a specific voucher. (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

    • importVouchersUsingCsvCall

      public okhttp3.Call importVouchersUsingCsvCall(File _file, ApiCallback _callback) throws ApiException
      Build call for importVouchersUsingCsv
      Parameters:
      _file - File path. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • importVouchersUsingCsv

      public VouchersImportCsvCreateResponseBody importVouchersUsingCsv(File _file) throws ApiException
      Import Vouchers using CSV Import standalone vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ 📘 Standard voucher fields mapping - Go to the import vouchers endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. 📘 Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the List Vouchers endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
      Parameters:
      _file - File path. (optional)
      Returns:
      VouchersImportCsvCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • importVouchersUsingCsvWithHttpInfo

      public ApiResponse<VouchersImportCsvCreateResponseBody> importVouchersUsingCsvWithHttpInfo(File _file) throws ApiException
      Import Vouchers using CSV Import standalone vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ 📘 Standard voucher fields mapping - Go to the import vouchers endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. 📘 Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the List Vouchers endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
      Parameters:
      _file - File path. (optional)
      Returns:
      ApiResponse<VouchersImportCsvCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • importVouchersUsingCsvAsync

      public okhttp3.Call importVouchersUsingCsvAsync(File _file, ApiCallback<VouchersImportCsvCreateResponseBody> _callback) throws ApiException
      Import Vouchers using CSV (asynchronously) Import standalone vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file [here](https://support.voucherify.io/article/45-import-codes-and-share-them-digitally#coupons). ___ 📘 Standard voucher fields mapping - Go to the import vouchers endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - **Start and expiration dates** need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code **metadata**. - You **cannot import the same codes** to a single Voucherify Project. 📘 Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the List Vouchers endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
      Parameters:
      _file - File path. (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

    • listVoucherTransactionsCall

      public okhttp3.Call listVoucherTransactionsCall(String code, Integer limit, ParameterOrderListTransactions order, String startingAfterId, ApiCallback _callback) throws ApiException
      Build call for listVoucherTransactions
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listVoucherTransactions

      public VouchersTransactionsListResponseBody listVoucherTransactions(String code, Integer limit, ParameterOrderListTransactions order, String startingAfterId) throws ApiException
      List Voucher Transactions List transactions that are associated with credit movements on a gift card or loyalty card.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. (optional)
      Returns:
      VouchersTransactionsListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listVoucherTransactionsWithHttpInfo

      public ApiResponse<VouchersTransactionsListResponseBody> listVoucherTransactionsWithHttpInfo(String code, Integer limit, ParameterOrderListTransactions order, String startingAfterId) throws ApiException
      List Voucher Transactions List transactions that are associated with credit movements on a gift card or loyalty card.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. (optional)
      Returns:
      ApiResponse<VouchersTransactionsListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listVoucherTransactionsAsync

      public okhttp3.Call listVoucherTransactionsAsync(String code, Integer limit, ParameterOrderListTransactions order, String startingAfterId, ApiCallback<VouchersTransactionsListResponseBody> _callback) throws ApiException
      List Voucher Transactions (asynchronously) List transactions that are associated with credit movements on a gift card or loyalty card.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. (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

    • listVouchersCall

      public okhttp3.Call listVouchersCall(Integer limit, Integer page, String category, String campaignId, String customer, String campaign, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ParameterOrderVouchers order, String code, List<String> ids, ApiCallback _callback) throws ApiException
      Build call for listVouchers
      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)
      page - Which page of results to return. The lowest value is 1. (optional)
      category - Limit search results to vouchers within the specified category. (optional)
      campaignId - Limit search results to vouchers within the specified campaign (optional)
      customer - A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters. (optional)
      campaign - A unique campaign name, identifies the parent campaign. (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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      code - (optional)
      ids - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listVouchers

      public VouchersListResponseBody listVouchers(Integer limit, Integer page, String category, String campaignId, String customer, String campaign, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ParameterOrderVouchers order, String code, List<String> ids) throws ApiException
      List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers.
      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)
      page - Which page of results to return. The lowest value is 1. (optional)
      category - Limit search results to vouchers within the specified category. (optional)
      campaignId - Limit search results to vouchers within the specified campaign (optional)
      customer - A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters. (optional)
      campaign - A unique campaign name, identifies the parent campaign. (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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      code - (optional)
      ids - (optional)
      Returns:
      VouchersListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listVouchersWithHttpInfo

      public ApiResponse<VouchersListResponseBody> listVouchersWithHttpInfo(Integer limit, Integer page, String category, String campaignId, String customer, String campaign, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ParameterOrderVouchers order, String code, List<String> ids) throws ApiException
      List Vouchers Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers.
      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)
      page - Which page of results to return. The lowest value is 1. (optional)
      category - Limit search results to vouchers within the specified category. (optional)
      campaignId - Limit search results to vouchers within the specified campaign (optional)
      customer - A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters. (optional)
      campaign - A unique campaign name, identifies the parent campaign. (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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      code - (optional)
      ids - (optional)
      Returns:
      ApiResponse<VouchersListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listVouchersAsync

      public okhttp3.Call listVouchersAsync(Integer limit, Integer page, String category, String campaignId, String customer, String campaign, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ParameterOrderVouchers order, String code, List<String> ids, ApiCallback<VouchersListResponseBody> _callback) throws ApiException
      List Vouchers (asynchronously) Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers.
      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)
      page - Which page of results to return. The lowest value is 1. (optional)
      category - Limit search results to vouchers within the specified category. (optional)
      campaignId - Limit search results to vouchers within the specified campaign (optional)
      customer - A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters. (optional)
      campaign - A unique campaign name, identifies the parent campaign. (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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      code - (optional)
      ids - (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

    • releaseValidationSessionCall

      public okhttp3.Call releaseValidationSessionCall(String code, String sessionKey, ApiCallback _callback) throws ApiException
      Build call for releaseValidationSession
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify. (required)
      sessionKey - A unique session identifier. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • releaseValidationSession

      public void releaseValidationSession(String code, String sessionKey) throws ApiException
      Release Validation Session Manually release a validation session that has been set up for the voucher. This method undos the actions that are explained in our guide on how a validation session was established, you can read more here. 📘 Release Session using Dashboard You can also use the Validations Manager in the Dashboard to unlock sessions. [Read more](https://support.voucherify.io/article/16-dashboard-sections#validations).
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify. (required)
      sessionKey - A unique session identifier. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • releaseValidationSessionWithHttpInfo

      public ApiResponse<Void> releaseValidationSessionWithHttpInfo(String code, String sessionKey) throws ApiException
      Release Validation Session Manually release a validation session that has been set up for the voucher. This method undos the actions that are explained in our guide on how a validation session was established, you can read more here. 📘 Release Session using Dashboard You can also use the Validations Manager in the Dashboard to unlock sessions. [Read more](https://support.voucherify.io/article/16-dashboard-sections#validations).
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify. (required)
      sessionKey - A unique session identifier. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • releaseValidationSessionAsync

      public okhttp3.Call releaseValidationSessionAsync(String code, String sessionKey, ApiCallback<Void> _callback) throws ApiException
      Release Validation Session (asynchronously) Manually release a validation session that has been set up for the voucher. This method undos the actions that are explained in our guide on how a validation session was established, you can read more here. 📘 Release Session using Dashboard You can also use the Validations Manager in the Dashboard to unlock sessions. [Read more](https://support.voucherify.io/article/16-dashboard-sections#validations).
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify. (required)
      sessionKey - A unique session identifier. (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

    • updateVoucherCall

      public okhttp3.Call updateVoucherCall(String code, VouchersUpdateRequestBody vouchersUpdateRequestBody, ApiCallback _callback) throws ApiException
      Build call for updateVoucher
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      vouchersUpdateRequestBody - Specify the parameters to be updated. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateVoucher

      public VouchersUpdateResponseBody updateVoucher(String code, VouchersUpdateRequestBody vouchersUpdateRequestBody) throws ApiException
      Update Voucher Updates the specified voucher by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      vouchersUpdateRequestBody - Specify the parameters to be updated. (required)
      Returns:
      VouchersUpdateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateVoucherWithHttpInfo

      public ApiResponse<VouchersUpdateResponseBody> updateVoucherWithHttpInfo(String code, VouchersUpdateRequestBody vouchersUpdateRequestBody) throws ApiException
      Update Voucher Updates the specified voucher by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      vouchersUpdateRequestBody - Specify the parameters to be updated. (required)
      Returns:
      ApiResponse<VouchersUpdateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateVoucherAsync

      public okhttp3.Call updateVoucherAsync(String code, VouchersUpdateRequestBody vouchersUpdateRequestBody, ApiCallback<VouchersUpdateResponseBody> _callback) throws ApiException
      Update Voucher (asynchronously) Updates the specified voucher by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped.
      Parameters:
      code - A unique **code** that identifies the voucher. (required)
      vouchersUpdateRequestBody - Specify the parameters to be updated. (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

    • updateVoucherBalanceCall

      public okhttp3.Call updateVoucherBalanceCall(String code, VouchersBalanceUpdateRequestBody vouchersBalanceUpdateRequestBody, ApiCallback _callback) throws ApiException
      Build call for updateVoucherBalance
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      vouchersBalanceUpdateRequestBody - Provide the amount to be added to/subtracted from the voucher. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateVoucherBalance

      public VouchersBalanceUpdateResponseBody updateVoucherBalance(String code, VouchersBalanceUpdateRequestBody vouchersBalanceUpdateRequestBody) throws ApiException
      Add or Remove Voucher Balance Add balance to an existing gift card or loyalty card.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      vouchersBalanceUpdateRequestBody - Provide the amount to be added to/subtracted from the voucher. (required)
      Returns:
      VouchersBalanceUpdateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateVoucherBalanceWithHttpInfo

      public ApiResponse<VouchersBalanceUpdateResponseBody> updateVoucherBalanceWithHttpInfo(String code, VouchersBalanceUpdateRequestBody vouchersBalanceUpdateRequestBody) throws ApiException
      Add or Remove Voucher Balance Add balance to an existing gift card or loyalty card.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      vouchersBalanceUpdateRequestBody - Provide the amount to be added to/subtracted from the voucher. (required)
      Returns:
      ApiResponse<VouchersBalanceUpdateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateVoucherBalanceAsync

      public okhttp3.Call updateVoucherBalanceAsync(String code, VouchersBalanceUpdateRequestBody vouchersBalanceUpdateRequestBody, ApiCallback<VouchersBalanceUpdateResponseBody> _callback) throws ApiException
      Add or Remove Voucher Balance (asynchronously) Add balance to an existing gift card or loyalty card.
      Parameters:
      code - A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. (required)
      vouchersBalanceUpdateRequestBody - Provide the amount to be added to/subtracted from the voucher. (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

    • updateVouchersInBulkCall

      public okhttp3.Call updateVouchersInBulkCall(List<VouchersUpdateInBulkItemRequestBody> vouchersUpdateInBulkItemRequestBody, ApiCallback _callback) throws ApiException
      Build call for updateVouchersInBulk
      Parameters:
      vouchersUpdateInBulkItemRequestBody - List the codes to be updated with the metadata key/value pairs for that code. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateVouchersInBulk

      public VouchersUpdateInBulkResponseBody updateVouchersInBulk(List<VouchersUpdateInBulkItemRequestBody> vouchersUpdateInBulkItemRequestBody) throws ApiException
      Update Vouchers in Bulk Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported. 🚧 Currently, only **metadata** updates are supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
      Parameters:
      vouchersUpdateInBulkItemRequestBody - List the codes to be updated with the metadata key/value pairs for that code. (required)
      Returns:
      VouchersUpdateInBulkResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateVouchersInBulkWithHttpInfo

      public ApiResponse<VouchersUpdateInBulkResponseBody> updateVouchersInBulkWithHttpInfo(List<VouchersUpdateInBulkItemRequestBody> vouchersUpdateInBulkItemRequestBody) throws ApiException
      Update Vouchers in Bulk Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported. 🚧 Currently, only **metadata** updates are supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
      Parameters:
      vouchersUpdateInBulkItemRequestBody - List the codes to be updated with the metadata key/value pairs for that code. (required)
      Returns:
      ApiResponse<VouchersUpdateInBulkResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateVouchersInBulkAsync

      public okhttp3.Call updateVouchersInBulkAsync(List<VouchersUpdateInBulkItemRequestBody> vouchersUpdateInBulkItemRequestBody, ApiCallback<VouchersUpdateInBulkResponseBody> _callback) throws ApiException
      Update Vouchers in Bulk (asynchronously) Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to **10 MB** of data. Upserts are not supported. 🚧 Currently, only **metadata** updates are supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
      Parameters:
      vouchersUpdateInBulkItemRequestBody - List the codes to be updated with the metadata key/value pairs for that code. (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

    • updateVouchersMetadataInBulkCall

      public okhttp3.Call updateVouchersMetadataInBulkCall(VouchersMetadataUpdateInBulkRequestBody vouchersMetadataUpdateInBulkRequestBody, ApiCallback _callback) throws ApiException
      Build call for updateVouchersMetadataInBulk
      Parameters:
      vouchersMetadataUpdateInBulkRequestBody - List the codes of the vouchers you would like to update with the metadata key/value pairs. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateVouchersMetadataInBulk

      public VouchersMetadataUpdateInBulkResponseBody updateVouchersMetadataInBulk(VouchersMetadataUpdateInBulkRequestBody vouchersMetadataUpdateInBulkRequestBody) throws ApiException
      Update Vouchers' Metadata in Bulk Updates metadata parameters for a list of codes. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. Upserts are not supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
      Parameters:
      vouchersMetadataUpdateInBulkRequestBody - List the codes of the vouchers you would like to update with the metadata key/value pairs. (required)
      Returns:
      VouchersMetadataUpdateInBulkResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateVouchersMetadataInBulkWithHttpInfo

      public ApiResponse<VouchersMetadataUpdateInBulkResponseBody> updateVouchersMetadataInBulkWithHttpInfo(VouchersMetadataUpdateInBulkRequestBody vouchersMetadataUpdateInBulkRequestBody) throws ApiException
      Update Vouchers' Metadata in Bulk Updates metadata parameters for a list of codes. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. Upserts are not supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
      Parameters:
      vouchersMetadataUpdateInBulkRequestBody - List the codes of the vouchers you would like to update with the metadata key/value pairs. (required)
      Returns:
      ApiResponse<VouchersMetadataUpdateInBulkResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateVouchersMetadataInBulkAsync

      public okhttp3.Call updateVouchersMetadataInBulkAsync(VouchersMetadataUpdateInBulkRequestBody vouchersMetadataUpdateInBulkRequestBody, ApiCallback<VouchersMetadataUpdateInBulkResponseBody> _callback) throws ApiException
      Update Vouchers' Metadata in Bulk (asynchronously) Updates metadata parameters for a list of codes. Every resource in the list will receive the metadata defined in the request. The request can include up to **10 MB** of data. Upserts are not supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
      Parameters:
      vouchersMetadataUpdateInBulkRequestBody - List the codes of the vouchers you would like to update with the metadata key/value pairs. (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