Package io.voucherify.client.api

Class LoyaltiesApi

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

  • Constructor Details

    • LoyaltiesApi

      public LoyaltiesApi()

    • LoyaltiesApi

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

    • addMemberCall

      public okhttp3.Call addMemberCall(String campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, ApiCallback _callback) throws ApiException
      Build call for addMember
      Parameters:
      campaignId - Unique campaign ID of the loyalty program. (required)
      loyaltiesMembersCreateRequestBody - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the List Publications endpoint. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • addMember

      public LoyaltiesMembersCreateResponseBody addMember(String campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody) throws ApiException
      Add Member This method assigns a loyalty card to a customer. It selects a loyalty card suitable for publication, adds a publish entry, and returns the published voucher. A voucher is suitable for publication when its active and hasnt been published yet. 📘 Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign.
      Parameters:
      campaignId - Unique campaign ID of the loyalty program. (required)
      loyaltiesMembersCreateRequestBody - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the List Publications endpoint. (optional)
      Returns:
      LoyaltiesMembersCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • addMemberWithHttpInfo

      public ApiResponse<LoyaltiesMembersCreateResponseBody> addMemberWithHttpInfo(String campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody) throws ApiException
      Add Member This method assigns a loyalty card to a customer. It selects a loyalty card suitable for publication, adds a publish entry, and returns the published voucher. A voucher is suitable for publication when its active and hasnt been published yet. 📘 Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign.
      Parameters:
      campaignId - Unique campaign ID of the loyalty program. (required)
      loyaltiesMembersCreateRequestBody - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the List Publications endpoint. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • addMemberAsync

      public okhttp3.Call addMemberAsync(String campaignId, LoyaltiesMembersCreateRequestBody loyaltiesMembersCreateRequestBody, ApiCallback<LoyaltiesMembersCreateResponseBody> _callback) throws ApiException
      Add Member (asynchronously) This method assigns a loyalty card to a customer. It selects a loyalty card suitable for publication, adds a publish entry, and returns the published voucher. A voucher is suitable for publication when its active and hasnt been published yet. 📘 Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign.
      Parameters:
      campaignId - Unique campaign ID of the loyalty program. (required)
      loyaltiesMembersCreateRequestBody - Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the List Publications endpoint. (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

    • createEarningRuleCall

      public okhttp3.Call createEarningRuleCall(String campaignId, List<LoyaltiesEarningRulesCreateRequestBodyItem> loyaltiesEarningRulesCreateRequestBodyItem, ApiCallback _callback) throws ApiException
      Build call for createEarningRule
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesEarningRulesCreateRequestBodyItem - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • createEarningRule

      public List<LoyaltiesEarningRulesCreateResponseBody> createEarningRule(String campaignId, List<LoyaltiesEarningRulesCreateRequestBodyItem> loyaltiesEarningRulesCreateRequestBodyItem) throws ApiException
      Create Earning Rule Create earning rules for a loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesEarningRulesCreateRequestBodyItem - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional)
      Returns:
      List<LoyaltiesEarningRulesCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createEarningRuleWithHttpInfo

      public ApiResponse<List<LoyaltiesEarningRulesCreateResponseBody>> createEarningRuleWithHttpInfo(String campaignId, List<LoyaltiesEarningRulesCreateRequestBodyItem> loyaltiesEarningRulesCreateRequestBodyItem) throws ApiException
      Create Earning Rule Create earning rules for a loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesEarningRulesCreateRequestBodyItem - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (optional)
      Returns:
      ApiResponse<List<LoyaltiesEarningRulesCreateResponseBody>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createEarningRuleAsync

      public okhttp3.Call createEarningRuleAsync(String campaignId, List<LoyaltiesEarningRulesCreateRequestBodyItem> loyaltiesEarningRulesCreateRequestBodyItem, ApiCallback<List<LoyaltiesEarningRulesCreateResponseBody>> _callback) throws ApiException
      Create Earning Rule (asynchronously) Create earning rules for a loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesEarningRulesCreateRequestBodyItem - Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object (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

    • createInBulkLoyaltyTiersCall

      public okhttp3.Call createInBulkLoyaltyTiersCall(String campaignId, List<LoyaltiesTiersCreateInBulkRequestBodyItem> loyaltiesTiersCreateInBulkRequestBodyItem, ApiCallback _callback) throws ApiException
      Build call for createInBulkLoyaltyTiers
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (required)
      loyaltiesTiersCreateInBulkRequestBodyItem - Provide tier definitions you want to add to existing loyalty campaign. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • createInBulkLoyaltyTiers

      public List<LoyaltyTier> createInBulkLoyaltyTiers(String campaignId, List<LoyaltiesTiersCreateInBulkRequestBodyItem> loyaltiesTiersCreateInBulkRequestBodyItem) throws ApiException
      Create loyalty tiers Creates loyalty tiers for desired campaign.
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (required)
      loyaltiesTiersCreateInBulkRequestBodyItem - Provide tier definitions you want to add to existing loyalty campaign. (optional)
      Returns:
      List<LoyaltyTier>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createInBulkLoyaltyTiersWithHttpInfo

      public ApiResponse<List<LoyaltyTier>> createInBulkLoyaltyTiersWithHttpInfo(String campaignId, List<LoyaltiesTiersCreateInBulkRequestBodyItem> loyaltiesTiersCreateInBulkRequestBodyItem) throws ApiException
      Create loyalty tiers Creates loyalty tiers for desired campaign.
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (required)
      loyaltiesTiersCreateInBulkRequestBodyItem - Provide tier definitions you want to add to existing loyalty campaign. (optional)
      Returns:
      ApiResponse<List<LoyaltyTier>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createInBulkLoyaltyTiersAsync

      public okhttp3.Call createInBulkLoyaltyTiersAsync(String campaignId, List<LoyaltiesTiersCreateInBulkRequestBodyItem> loyaltiesTiersCreateInBulkRequestBodyItem, ApiCallback<List<LoyaltyTier>> _callback) throws ApiException
      Create loyalty tiers (asynchronously) Creates loyalty tiers for desired campaign.
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (required)
      loyaltiesTiersCreateInBulkRequestBodyItem - Provide tier definitions you want to add to existing loyalty campaign. (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

    • createLoyaltyProgramCall

      public okhttp3.Call createLoyaltyProgramCall(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, ApiCallback _callback) throws ApiException
      Build call for createLoyaltyProgram
      Parameters:
      loyaltiesCreateCampaignRequestBody - Specify the loyalty campaign details. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • createLoyaltyProgram

      public LoyaltiesCreateCampaignResponseBody createLoyaltyProgram(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody) throws ApiException
      Create Loyalty Campaign Creates a batch of loyalty cards aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. 📘 Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asyncronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the loyalty campaign object description.
      Parameters:
      loyaltiesCreateCampaignRequestBody - Specify the loyalty campaign details. (optional)
      Returns:
      LoyaltiesCreateCampaignResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createLoyaltyProgramWithHttpInfo

      public ApiResponse<LoyaltiesCreateCampaignResponseBody> createLoyaltyProgramWithHttpInfo(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody) throws ApiException
      Create Loyalty Campaign Creates a batch of loyalty cards aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. 📘 Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asyncronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the loyalty campaign object description.
      Parameters:
      loyaltiesCreateCampaignRequestBody - Specify the loyalty campaign details. (optional)
      Returns:
      ApiResponse<LoyaltiesCreateCampaignResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createLoyaltyProgramAsync

      public okhttp3.Call createLoyaltyProgramAsync(LoyaltiesCreateCampaignRequestBody loyaltiesCreateCampaignRequestBody, ApiCallback<LoyaltiesCreateCampaignResponseBody> _callback) throws ApiException
      Create Loyalty Campaign (asynchronously) Creates a batch of loyalty cards aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. 📘 Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asyncronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the loyalty campaign object description.
      Parameters:
      loyaltiesCreateCampaignRequestBody - Specify the loyalty campaign details. (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

    • createPointsExpirationExportCall

      public okhttp3.Call createPointsExpirationExportCall(String campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, ApiCallback _callback) throws ApiException
      Build call for createPointsExpirationExport
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltiesPointsExpirationExportCreateRequestBody - Specify the data filters, types of data to return and order in which the results should be returned. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • createPointsExpirationExport

      public LoyaltiesPointsExpirationExportCreateResponseBody createPointsExpirationExport(String campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody) throws ApiException
      Create Points Expiration Export Schedule the generation of a points expiration CSV file for a particular campaign.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltiesPointsExpirationExportCreateRequestBody - Specify the data filters, types of data to return and order in which the results should be returned. (optional)
      Returns:
      LoyaltiesPointsExpirationExportCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createPointsExpirationExportWithHttpInfo

      public ApiResponse<LoyaltiesPointsExpirationExportCreateResponseBody> createPointsExpirationExportWithHttpInfo(String campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody) throws ApiException
      Create Points Expiration Export Schedule the generation of a points expiration CSV file for a particular campaign.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltiesPointsExpirationExportCreateRequestBody - Specify the data filters, types of data to return and order in which the results should be returned. (optional)
      Returns:
      ApiResponse<LoyaltiesPointsExpirationExportCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createPointsExpirationExportAsync

      public okhttp3.Call createPointsExpirationExportAsync(String campaignId, LoyaltiesPointsExpirationExportCreateRequestBody loyaltiesPointsExpirationExportCreateRequestBody, ApiCallback<LoyaltiesPointsExpirationExportCreateResponseBody> _callback) throws ApiException
      Create Points Expiration Export (asynchronously) Schedule the generation of a points expiration CSV file for a particular campaign.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltiesPointsExpirationExportCreateRequestBody - Specify the data filters, types of data to return and order in which the results should be returned. (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

    • createRewardAssignment1Call

      public okhttp3.Call createRewardAssignment1Call(String campaignId, List<LoyaltiesRewardsCreateAssignmentItemRequestBody> loyaltiesRewardsCreateAssignmentItemRequestBody, ApiCallback _callback) throws ApiException
      Build call for createRewardAssignment1
      Parameters:
      campaignId - Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesRewardsCreateAssignmentItemRequestBody - Define the cost of the rewards in loyalty points. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • createRewardAssignment1

      public LoyaltiesRewardsCreateAssignmentResponseBody createRewardAssignment1(String campaignId, List<LoyaltiesRewardsCreateAssignmentItemRequestBody> loyaltiesRewardsCreateAssignmentItemRequestBody) throws ApiException
      Create Reward Assignment Add rewards to a loyalty campaign.
      Parameters:
      campaignId - Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesRewardsCreateAssignmentItemRequestBody - Define the cost of the rewards in loyalty points. (optional)
      Returns:
      LoyaltiesRewardsCreateAssignmentResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createRewardAssignment1WithHttpInfo

      public ApiResponse<LoyaltiesRewardsCreateAssignmentResponseBody> createRewardAssignment1WithHttpInfo(String campaignId, List<LoyaltiesRewardsCreateAssignmentItemRequestBody> loyaltiesRewardsCreateAssignmentItemRequestBody) throws ApiException
      Create Reward Assignment Add rewards to a loyalty campaign.
      Parameters:
      campaignId - Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesRewardsCreateAssignmentItemRequestBody - Define the cost of the rewards in loyalty points. (optional)
      Returns:
      ApiResponse<LoyaltiesRewardsCreateAssignmentResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createRewardAssignment1Async

      public okhttp3.Call createRewardAssignment1Async(String campaignId, List<LoyaltiesRewardsCreateAssignmentItemRequestBody> loyaltiesRewardsCreateAssignmentItemRequestBody, ApiCallback<LoyaltiesRewardsCreateAssignmentResponseBody> _callback) throws ApiException
      Create Reward Assignment (asynchronously) Add rewards to a loyalty campaign.
      Parameters:
      campaignId - Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesRewardsCreateAssignmentItemRequestBody - Define the cost of the rewards in loyalty points. (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

    • deleteEarningRuleCall

      public okhttp3.Call deleteEarningRuleCall(String campaignId, String earningRuleId, ApiCallback _callback) throws ApiException
      Build call for deleteEarningRule
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • deleteEarningRule

      public void deleteEarningRule(String campaignId, String earningRuleId) throws ApiException
      Delete Earning Rule This method deletes an earning rule for a specific loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteEarningRuleWithHttpInfo

      public ApiResponse<Void> deleteEarningRuleWithHttpInfo(String campaignId, String earningRuleId) throws ApiException
      Delete Earning Rule This method deletes an earning rule for a specific loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteEarningRuleAsync

      public okhttp3.Call deleteEarningRuleAsync(String campaignId, String earningRuleId, ApiCallback<Void> _callback) throws ApiException
      Delete Earning Rule (asynchronously) This method deletes an earning rule for a specific loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • deleteLoyaltyProgramCall

      public okhttp3.Call deleteLoyaltyProgramCall(String campaignId, Boolean force, ApiCallback _callback) throws ApiException
      Build call for deleteLoyaltyProgram
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      force - If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • deleteLoyaltyProgram

      public LoyaltiesDeleteResponseBody deleteLoyaltyProgram(String campaignId, Boolean force) throws ApiException
      Delete Loyalty Campaign Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards. If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      force - If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name. (optional)
      Returns:
      LoyaltiesDeleteResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteLoyaltyProgramWithHttpInfo

      public ApiResponse<LoyaltiesDeleteResponseBody> deleteLoyaltyProgramWithHttpInfo(String campaignId, Boolean force) throws ApiException
      Delete Loyalty Campaign Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards. If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      force - If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name. (optional)
      Returns:
      ApiResponse<LoyaltiesDeleteResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteLoyaltyProgramAsync

      public okhttp3.Call deleteLoyaltyProgramAsync(String campaignId, Boolean force, ApiCallback<LoyaltiesDeleteResponseBody> _callback) throws ApiException
      Delete Loyalty Campaign (asynchronously) Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards. If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      force - If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name. (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

    • deleteRewardAssignment1Call

      public okhttp3.Call deleteRewardAssignment1Call(String campaignId, String assignmentId, ApiCallback _callback) throws ApiException
      Build call for deleteRewardAssignment1
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • deleteRewardAssignment1

      public void deleteRewardAssignment1(String campaignId, String assignmentId) throws ApiException
      Delete Reward Assignment This method deletes a reward assignment for a particular loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteRewardAssignment1WithHttpInfo

      public ApiResponse<Void> deleteRewardAssignment1WithHttpInfo(String campaignId, String assignmentId) throws ApiException
      Delete Reward Assignment This method deletes a reward assignment for a particular loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteRewardAssignment1Async

      public okhttp3.Call deleteRewardAssignment1Async(String campaignId, String assignmentId, ApiCallback<Void> _callback) throws ApiException
      Delete Reward Assignment (asynchronously) This method deletes a reward assignment for a particular loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • disableEarningRuleCall

      public okhttp3.Call disableEarningRuleCall(String campaignId, String earningRuleId, ApiCallback _callback) throws ApiException
      Build call for disableEarningRule
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      earningRuleId - Unique earning rule ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • disableEarningRule

      public LoyaltiesEarningRulesDisableResponseBody disableEarningRule(String campaignId, String earningRuleId) throws ApiException
      Disable Earning Rule Disable an earning rule.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      earningRuleId - Unique earning rule ID. (required)
      Returns:
      LoyaltiesEarningRulesDisableResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • disableEarningRuleWithHttpInfo

      public ApiResponse<LoyaltiesEarningRulesDisableResponseBody> disableEarningRuleWithHttpInfo(String campaignId, String earningRuleId) throws ApiException
      Disable Earning Rule Disable an earning rule.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      earningRuleId - Unique earning rule ID. (required)
      Returns:
      ApiResponse<LoyaltiesEarningRulesDisableResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • disableEarningRuleAsync

      public okhttp3.Call disableEarningRuleAsync(String campaignId, String earningRuleId, ApiCallback<LoyaltiesEarningRulesDisableResponseBody> _callback) throws ApiException
      Disable Earning Rule (asynchronously) Disable an earning rule.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      earningRuleId - Unique earning rule ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • enableEarningRuleCall

      public okhttp3.Call enableEarningRuleCall(String campaignId, String earningRuleId, ApiCallback _callback) throws ApiException
      Build call for enableEarningRule
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      earningRuleId - Unique earning rule ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • enableEarningRule

      public LoyaltiesEarningRulesEnableResponseBody enableEarningRule(String campaignId, String earningRuleId) throws ApiException
      Enable Earning Rule Enable an earning rule.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      earningRuleId - Unique earning rule ID. (required)
      Returns:
      LoyaltiesEarningRulesEnableResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • enableEarningRuleWithHttpInfo

      public ApiResponse<LoyaltiesEarningRulesEnableResponseBody> enableEarningRuleWithHttpInfo(String campaignId, String earningRuleId) throws ApiException
      Enable Earning Rule Enable an earning rule.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      earningRuleId - Unique earning rule ID. (required)
      Returns:
      ApiResponse<LoyaltiesEarningRulesEnableResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • enableEarningRuleAsync

      public okhttp3.Call enableEarningRuleAsync(String campaignId, String earningRuleId, ApiCallback<LoyaltiesEarningRulesEnableResponseBody> _callback) throws ApiException
      Enable Earning Rule (asynchronously) Enable an earning rule.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      earningRuleId - Unique earning rule ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • exportLoyaltyCardTransactionsCall

      public okhttp3.Call exportLoyaltyCardTransactionsCall(String memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, ApiCallback _callback) throws ApiException
      Build call for exportLoyaltyCardTransactions
      Parameters:
      memberId - A unique code identifying the loyalty card that you are looking to export transaction data for. (required)
      loyaltiesMembersTransactionsExportCreateRequestBody - Specify the parameters and filters for the transaction export. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • exportLoyaltyCardTransactions

      public LoyaltiesMembersTransactionsExportCreateResponseBody exportLoyaltyCardTransactions(String memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody) throws ApiException
      Export Loyalty Card Transactions Export transactions that are associated with point movements on a loyalty card.
      Parameters:
      memberId - A unique code identifying the loyalty card that you are looking to export transaction data for. (required)
      loyaltiesMembersTransactionsExportCreateRequestBody - Specify the parameters and filters for the transaction export. (optional)
      Returns:
      LoyaltiesMembersTransactionsExportCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • exportLoyaltyCardTransactionsWithHttpInfo

      public ApiResponse<LoyaltiesMembersTransactionsExportCreateResponseBody> exportLoyaltyCardTransactionsWithHttpInfo(String memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody) throws ApiException
      Export Loyalty Card Transactions Export transactions that are associated with point movements on a loyalty card.
      Parameters:
      memberId - A unique code identifying the loyalty card that you are looking to export transaction data for. (required)
      loyaltiesMembersTransactionsExportCreateRequestBody - Specify the parameters and filters for the transaction export. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersTransactionsExportCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • exportLoyaltyCardTransactionsAsync

      public okhttp3.Call exportLoyaltyCardTransactionsAsync(String memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, ApiCallback<LoyaltiesMembersTransactionsExportCreateResponseBody> _callback) throws ApiException
      Export Loyalty Card Transactions (asynchronously) Export transactions that are associated with point movements on a loyalty card.
      Parameters:
      memberId - A unique code identifying the loyalty card that you are looking to export transaction data for. (required)
      loyaltiesMembersTransactionsExportCreateRequestBody - Specify the parameters and filters for the 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

    • exportLoyaltyCardTransactions1Call

      public okhttp3.Call exportLoyaltyCardTransactions1Call(String campaignId, String memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, ApiCallback _callback) throws ApiException
      Build call for exportLoyaltyCardTransactions1
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. (required)
      memberId - A unique code identifying the loyalty card that you are looking to export transaction data for. (required)
      loyaltiesMembersTransactionsExportCreateRequestBody - Specify the parameters and filters for the transaction export. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • exportLoyaltyCardTransactions1

      public LoyaltiesMembersTransactionsExportCreateResponseBody exportLoyaltyCardTransactions1(String campaignId, String memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody) throws ApiException
      Export Loyalty Card Transactions Export transactions that are associated with point movements on a loyalty card.
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. (required)
      memberId - A unique code identifying the loyalty card that you are looking to export transaction data for. (required)
      loyaltiesMembersTransactionsExportCreateRequestBody - Specify the parameters and filters for the transaction export. (optional)
      Returns:
      LoyaltiesMembersTransactionsExportCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • exportLoyaltyCardTransactions1WithHttpInfo

      public ApiResponse<LoyaltiesMembersTransactionsExportCreateResponseBody> exportLoyaltyCardTransactions1WithHttpInfo(String campaignId, String memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody) throws ApiException
      Export Loyalty Card Transactions Export transactions that are associated with point movements on a loyalty card.
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. (required)
      memberId - A unique code identifying the loyalty card that you are looking to export transaction data for. (required)
      loyaltiesMembersTransactionsExportCreateRequestBody - Specify the parameters and filters for the transaction export. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersTransactionsExportCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • exportLoyaltyCardTransactions1Async

      public okhttp3.Call exportLoyaltyCardTransactions1Async(String campaignId, String memberId, LoyaltiesMembersTransactionsExportCreateRequestBody loyaltiesMembersTransactionsExportCreateRequestBody, ApiCallback<LoyaltiesMembersTransactionsExportCreateResponseBody> _callback) throws ApiException
      Export Loyalty Card Transactions (asynchronously) Export transactions that are associated with point movements on a loyalty card.
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. (required)
      memberId - A unique code identifying the loyalty card that you are looking to export transaction data for. (required)
      loyaltiesMembersTransactionsExportCreateRequestBody - Specify the parameters and filters for the 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

    • getEarningRuleCall

      public okhttp3.Call getEarningRuleCall(String campaignId, String earningRuleId, ApiCallback _callback) throws ApiException
      Build call for getEarningRule
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getEarningRule

      public LoyaltiesEarningRulesGetResponseBody getEarningRule(String campaignId, String earningRuleId) throws ApiException
      Get Earning Rule Retrieves an earning rule assigned to a campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      Returns:
      LoyaltiesEarningRulesGetResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getEarningRuleWithHttpInfo

      public ApiResponse<LoyaltiesEarningRulesGetResponseBody> getEarningRuleWithHttpInfo(String campaignId, String earningRuleId) throws ApiException
      Get Earning Rule Retrieves an earning rule assigned to a campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      Returns:
      ApiResponse<LoyaltiesEarningRulesGetResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getEarningRuleAsync

      public okhttp3.Call getEarningRuleAsync(String campaignId, String earningRuleId, ApiCallback<LoyaltiesEarningRulesGetResponseBody> _callback) throws ApiException
      Get Earning Rule (asynchronously) Retrieves an earning rule assigned to a campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • getLoyaltyProgramCall

      public okhttp3.Call getLoyaltyProgramCall(String campaignId, ApiCallback _callback) throws ApiException
      Build call for getLoyaltyProgram
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getLoyaltyProgram

      public LoyaltiesGetCampaignResponseBody getLoyaltyProgram(String campaignId) throws ApiException
      Get Loyalty Campaign Retrieve a specific loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      Returns:
      LoyaltiesGetCampaignResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getLoyaltyProgramWithHttpInfo

      public ApiResponse<LoyaltiesGetCampaignResponseBody> getLoyaltyProgramWithHttpInfo(String campaignId) throws ApiException
      Get Loyalty Campaign Retrieve a specific loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      Returns:
      ApiResponse<LoyaltiesGetCampaignResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getLoyaltyProgramAsync

      public okhttp3.Call getLoyaltyProgramAsync(String campaignId, ApiCallback<LoyaltiesGetCampaignResponseBody> _callback) throws ApiException
      Get Loyalty Campaign (asynchronously) Retrieve a specific loyalty campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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

    • getLoyaltyTierCall

      public okhttp3.Call getLoyaltyTierCall(String campaignId, String loyaltyTierId, ApiCallback _callback) throws ApiException
      Build call for getLoyaltyTier
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getLoyaltyTier

      public LoyaltiesTiersGetResponseBody getLoyaltyTier(String campaignId, String loyaltyTierId) throws ApiException
      Get Loyalty Tier Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (required)
      Returns:
      LoyaltiesTiersGetResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getLoyaltyTierWithHttpInfo

      public ApiResponse<LoyaltiesTiersGetResponseBody> getLoyaltyTierWithHttpInfo(String campaignId, String loyaltyTierId) throws ApiException
      Get Loyalty Tier Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (required)
      Returns:
      ApiResponse<LoyaltiesTiersGetResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getLoyaltyTierAsync

      public okhttp3.Call getLoyaltyTierAsync(String campaignId, String loyaltyTierId, ApiCallback<LoyaltiesTiersGetResponseBody> _callback) throws ApiException
      Get Loyalty Tier (asynchronously) Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • getMemberCall

      public okhttp3.Call getMemberCall(String memberId, ApiCallback _callback) throws ApiException
      Build call for getMember
      Parameters:
      memberId - Unique loyalty card code assigned to a particular customer. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getMember

      public LoyaltiesMembersGetResponseBody getMember(String memberId) throws ApiException
      Get Member Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter.
      Parameters:
      memberId - Unique loyalty card code assigned to a particular customer. (required)
      Returns:
      LoyaltiesMembersGetResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getMemberWithHttpInfo

      public ApiResponse<LoyaltiesMembersGetResponseBody> getMemberWithHttpInfo(String memberId) throws ApiException
      Get Member Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter.
      Parameters:
      memberId - Unique loyalty card code assigned to a particular customer. (required)
      Returns:
      ApiResponse<LoyaltiesMembersGetResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getMemberAsync

      public okhttp3.Call getMemberAsync(String memberId, ApiCallback<LoyaltiesMembersGetResponseBody> _callback) throws ApiException
      Get Member (asynchronously) Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter.
      Parameters:
      memberId - Unique loyalty card code assigned to a particular customer. (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

    • getMember1Call

      public okhttp3.Call getMember1Call(String campaignId, String memberId, ApiCallback _callback) throws ApiException
      Build call for getMember1
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - Unique code that identifies the loyalty card. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getMember1

      public LoyaltiesMembersGetResponseBody getMember1(String campaignId, String memberId) throws ApiException
      Get Member Retrieves the loyalty card with the given member ID (i.e. voucher code).
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - Unique code that identifies the loyalty card. (required)
      Returns:
      LoyaltiesMembersGetResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getMember1WithHttpInfo

      public ApiResponse<LoyaltiesMembersGetResponseBody> getMember1WithHttpInfo(String campaignId, String memberId) throws ApiException
      Get Member Retrieves the loyalty card with the given member ID (i.e. voucher code).
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - Unique code that identifies the loyalty card. (required)
      Returns:
      ApiResponse<LoyaltiesMembersGetResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getMember1Async

      public okhttp3.Call getMember1Async(String campaignId, String memberId, ApiCallback<LoyaltiesMembersGetResponseBody> _callback) throws ApiException
      Get Member (asynchronously) Retrieves the loyalty card with the given member ID (i.e. voucher code).
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - Unique code that identifies the loyalty card. (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

    • getRewardAssignment1Call

      public okhttp3.Call getRewardAssignment1Call(String campaignId, String assignmentId, ApiCallback _callback) throws ApiException
      Build call for getRewardAssignment1
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - Unique reward assignment ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getRewardAssignment1

      public LoyaltiesRewardAssignmentsGetResponseBody getRewardAssignment1(String campaignId, String assignmentId) throws ApiException
      Get Reward Assignment Retrieve specific reward assignment.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - Unique reward assignment ID. (required)
      Returns:
      LoyaltiesRewardAssignmentsGetResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getRewardAssignment1WithHttpInfo

      public ApiResponse<LoyaltiesRewardAssignmentsGetResponseBody> getRewardAssignment1WithHttpInfo(String campaignId, String assignmentId) throws ApiException
      Get Reward Assignment Retrieve specific reward assignment.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - Unique reward assignment ID. (required)
      Returns:
      ApiResponse<LoyaltiesRewardAssignmentsGetResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getRewardAssignment1Async

      public okhttp3.Call getRewardAssignment1Async(String campaignId, String assignmentId, ApiCallback<LoyaltiesRewardAssignmentsGetResponseBody> _callback) throws ApiException
      Get Reward Assignment (asynchronously) Retrieve specific reward assignment.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - Unique reward assignment ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • getRewardAssignment2Call

      public okhttp3.Call getRewardAssignment2Call(String campaignId, String assignmentId, ApiCallback _callback) throws ApiException
      Build call for getRewardAssignment2
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getRewardAssignment2

      public LoyaltiesRewardsGetResponseBody getRewardAssignment2(String campaignId, String assignmentId) throws ApiException
      Get Reward Assignment Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this endpoint.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      Returns:
      LoyaltiesRewardsGetResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getRewardAssignment2WithHttpInfo

      public ApiResponse<LoyaltiesRewardsGetResponseBody> getRewardAssignment2WithHttpInfo(String campaignId, String assignmentId) throws ApiException
      Get Reward Assignment Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this endpoint.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      Returns:
      ApiResponse<LoyaltiesRewardsGetResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getRewardAssignment2Async

      public okhttp3.Call getRewardAssignment2Async(String campaignId, String assignmentId, ApiCallback<LoyaltiesRewardsGetResponseBody> _callback) throws ApiException
      Get Reward Assignment (asynchronously) Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this endpoint.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • getRewardDetailsCall

      public okhttp3.Call getRewardDetailsCall(String campaignId, String assignmentId, ApiCallback _callback) throws ApiException
      Build call for getRewardDetails
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - Unique reward assignment ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getRewardDetails

      public LoyaltiesRewardAssignmentsRewardGetResponseBody getRewardDetails(String campaignId, String assignmentId) throws ApiException
      Get Reward Details Get reward details in the context of a loyalty campaign and reward assignment ID.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - Unique reward assignment ID. (required)
      Returns:
      LoyaltiesRewardAssignmentsRewardGetResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getRewardDetailsWithHttpInfo

      public ApiResponse<LoyaltiesRewardAssignmentsRewardGetResponseBody> getRewardDetailsWithHttpInfo(String campaignId, String assignmentId) throws ApiException
      Get Reward Details Get reward details in the context of a loyalty campaign and reward assignment ID.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - Unique reward assignment ID. (required)
      Returns:
      ApiResponse<LoyaltiesRewardAssignmentsRewardGetResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getRewardDetailsAsync

      public okhttp3.Call getRewardDetailsAsync(String campaignId, String assignmentId, ApiCallback<LoyaltiesRewardAssignmentsRewardGetResponseBody> _callback) throws ApiException
      Get Reward Details (asynchronously) Get reward details in the context of a loyalty campaign and reward assignment ID.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - Unique reward assignment ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • listEarningRulesCall

      public okhttp3.Call listEarningRulesCall(String campaignId, Integer limit, Integer page, ParameterOrderListEarningRules order, ApiCallback _callback) throws ApiException
      Build call for listEarningRules
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listEarningRules

      public LoyaltiesEarningRulesListResponseBody listEarningRules(String campaignId, Integer limit, Integer page, ParameterOrderListEarningRules order) throws ApiException
      List Earning Rules Returns a list of all earning rules within a given campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      Returns:
      LoyaltiesEarningRulesListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listEarningRulesWithHttpInfo

      public ApiResponse<LoyaltiesEarningRulesListResponseBody> listEarningRulesWithHttpInfo(String campaignId, Integer limit, Integer page, ParameterOrderListEarningRules order) throws ApiException
      List Earning Rules Returns a list of all earning rules within a given campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      Returns:
      ApiResponse<LoyaltiesEarningRulesListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listEarningRulesAsync

      public okhttp3.Call listEarningRulesAsync(String campaignId, Integer limit, Integer page, ParameterOrderListEarningRules order, ApiCallback<LoyaltiesEarningRulesListResponseBody> _callback) throws ApiException
      List Earning Rules (asynchronously) Returns a list of all earning rules within a given campaign.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • listLoyaltyCardTransactionsCall

      public okhttp3.Call listLoyaltyCardTransactionsCall(String memberId, Integer limit, ParameterOrderListTransactions order, String startingAfterId, ApiCallback _callback) throws ApiException
      Build call for listLoyaltyCardTransactions
      Parameters:
      memberId - A unique code identifying the loyalty card that you are looking to retrieve transaction data for. (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

    • listLoyaltyCardTransactions

      public LoyaltiesMembersTransactionsListResponseBody listLoyaltyCardTransactions(String memberId, Integer limit, ParameterOrderListTransactions order, String startingAfterId) throws ApiException
      List Loyalty Card Transactions Retrieve transaction data related to point movements for a specific loyalty card.
      Parameters:
      memberId - A unique code identifying the loyalty card that you are looking to retrieve transaction data for. (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:
      LoyaltiesMembersTransactionsListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyCardTransactionsWithHttpInfo

      public ApiResponse<LoyaltiesMembersTransactionsListResponseBody> listLoyaltyCardTransactionsWithHttpInfo(String memberId, Integer limit, ParameterOrderListTransactions order, String startingAfterId) throws ApiException
      List Loyalty Card Transactions Retrieve transaction data related to point movements for a specific loyalty card.
      Parameters:
      memberId - A unique code identifying the loyalty card that you are looking to retrieve transaction data for. (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<LoyaltiesMembersTransactionsListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyCardTransactionsAsync

      public okhttp3.Call listLoyaltyCardTransactionsAsync(String memberId, Integer limit, ParameterOrderListTransactions order, String startingAfterId, ApiCallback<LoyaltiesMembersTransactionsListResponseBody> _callback) throws ApiException
      List Loyalty Card Transactions (asynchronously) Retrieve transaction data related to point movements for a specific loyalty card.
      Parameters:
      memberId - A unique code identifying the loyalty card that you are looking to retrieve transaction data for. (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

    • listLoyaltyCardTransactions1Call

      public okhttp3.Call listLoyaltyCardTransactions1Call(String campaignId, String memberId, Integer limit, ParameterOrderListTransactions order, String startingAfterId, ApiCallback _callback) throws ApiException
      Build call for listLoyaltyCardTransactions1
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return. (required)
      memberId - A unique code identifying the loyalty card that you are looking to retrieve transaction data for. (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

    • listLoyaltyCardTransactions1

      public LoyaltiesMembersTransactionsListResponseBody listLoyaltyCardTransactions1(String campaignId, String memberId, Integer limit, ParameterOrderListTransactions order, String startingAfterId) throws ApiException
      List Loyalty Card Transactions Retrieve transaction data related to point movements for a specific loyalty card.
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return. (required)
      memberId - A unique code identifying the loyalty card that you are looking to retrieve transaction data for. (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:
      LoyaltiesMembersTransactionsListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyCardTransactions1WithHttpInfo

      public ApiResponse<LoyaltiesMembersTransactionsListResponseBody> listLoyaltyCardTransactions1WithHttpInfo(String campaignId, String memberId, Integer limit, ParameterOrderListTransactions order, String startingAfterId) throws ApiException
      List Loyalty Card Transactions Retrieve transaction data related to point movements for a specific loyalty card.
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return. (required)
      memberId - A unique code identifying the loyalty card that you are looking to retrieve transaction data for. (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<LoyaltiesMembersTransactionsListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyCardTransactions1Async

      public okhttp3.Call listLoyaltyCardTransactions1Async(String campaignId, String memberId, Integer limit, ParameterOrderListTransactions order, String startingAfterId, ApiCallback<LoyaltiesMembersTransactionsListResponseBody> _callback) throws ApiException
      List Loyalty Card Transactions (asynchronously) Retrieve transaction data related to point movements for a specific loyalty card.
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return. (required)
      memberId - A unique code identifying the loyalty card that you are looking to retrieve transaction data for. (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

    • listLoyaltyProgramsCall

      public okhttp3.Call listLoyaltyProgramsCall(Integer limit, Integer page, ParameterOrderListCampaigns order, ApiCallback _callback) throws ApiException
      Build call for listLoyaltyPrograms
      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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listLoyaltyPrograms

      public LoyaltiesListCampaignsResponseBody listLoyaltyPrograms(Integer limit, Integer page, ParameterOrderListCampaigns order) throws ApiException
      List Loyalty Campaigns Returns a list of your loyalty campaigns.
      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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      Returns:
      LoyaltiesListCampaignsResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyProgramsWithHttpInfo

      public ApiResponse<LoyaltiesListCampaignsResponseBody> listLoyaltyProgramsWithHttpInfo(Integer limit, Integer page, ParameterOrderListCampaigns order) throws ApiException
      List Loyalty Campaigns Returns a list of your loyalty campaigns.
      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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      Returns:
      ApiResponse<LoyaltiesListCampaignsResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyProgramsAsync

      public okhttp3.Call listLoyaltyProgramsAsync(Integer limit, Integer page, ParameterOrderListCampaigns order, ApiCallback<LoyaltiesListCampaignsResponseBody> _callback) throws ApiException
      List Loyalty Campaigns (asynchronously) Returns a list of your loyalty campaigns.
      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)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • listLoyaltyTierEarningRulesCall

      public okhttp3.Call listLoyaltyTierEarningRulesCall(String campaignId, String loyaltyTierId, Integer limit, Integer page, ApiCallback _callback) throws ApiException
      Build call for listLoyaltyTierEarningRules
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listLoyaltyTierEarningRules

      public LoyaltiesTiersEarningRulesListResponseBody listLoyaltyTierEarningRules(String campaignId, String loyaltyTierId, Integer limit, Integer page) throws ApiException
      List Loyalty Tier Earning Rules Retrieve available earning rules for a given tier and the calculation method for earning points.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      Returns:
      LoyaltiesTiersEarningRulesListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyTierEarningRulesWithHttpInfo

      public ApiResponse<LoyaltiesTiersEarningRulesListResponseBody> listLoyaltyTierEarningRulesWithHttpInfo(String campaignId, String loyaltyTierId, Integer limit, Integer page) throws ApiException
      List Loyalty Tier Earning Rules Retrieve available earning rules for a given tier and the calculation method for earning points.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      Returns:
      ApiResponse<LoyaltiesTiersEarningRulesListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyTierEarningRulesAsync

      public okhttp3.Call listLoyaltyTierEarningRulesAsync(String campaignId, String loyaltyTierId, Integer limit, Integer page, ApiCallback<LoyaltiesTiersEarningRulesListResponseBody> _callback) throws ApiException
      List Loyalty Tier Earning Rules (asynchronously) Retrieve available earning rules for a given tier and the calculation method for earning points.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (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)
      page - Which page of results to return. The lowest value is 1. (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

    • listLoyaltyTierRewardsCall

      public okhttp3.Call listLoyaltyTierRewardsCall(String campaignId, String loyaltyTierId, ApiCallback _callback) throws ApiException
      Build call for listLoyaltyTierRewards
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listLoyaltyTierRewards

      public LoyaltiesTiersRewardsListResponseBody listLoyaltyTierRewards(String campaignId, String loyaltyTierId) throws ApiException
      List Loyalty Tier Rewards Get available rewards for a given tier.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (required)
      Returns:
      LoyaltiesTiersRewardsListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyTierRewardsWithHttpInfo

      public ApiResponse<LoyaltiesTiersRewardsListResponseBody> listLoyaltyTierRewardsWithHttpInfo(String campaignId, String loyaltyTierId) throws ApiException
      List Loyalty Tier Rewards Get available rewards for a given tier.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (required)
      Returns:
      ApiResponse<LoyaltiesTiersRewardsListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyTierRewardsAsync

      public okhttp3.Call listLoyaltyTierRewardsAsync(String campaignId, String loyaltyTierId, ApiCallback<LoyaltiesTiersRewardsListResponseBody> _callback) throws ApiException
      List Loyalty Tier Rewards (asynchronously) Get available rewards for a given tier.
      Parameters:
      campaignId - Unique campaign ID or name. (required)
      loyaltyTierId - Unique loyalty tier ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • listLoyaltyTiersCall

      public okhttp3.Call listLoyaltyTiersCall(String campaignId, Integer limit, ParameterOrderListLoyaltyTiers order, ApiCallback _callback) throws ApiException
      Build call for listLoyaltyTiers
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (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)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listLoyaltyTiers

      public LoyaltiesTiersListResponseBody listLoyaltyTiers(String campaignId, Integer limit, ParameterOrderListLoyaltyTiers order) throws ApiException
      List Loyalty Tiers Retrieve a list of loyalty tiers which were added to the loyalty program.
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (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)
      Returns:
      LoyaltiesTiersListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyTiersWithHttpInfo

      public ApiResponse<LoyaltiesTiersListResponseBody> listLoyaltyTiersWithHttpInfo(String campaignId, Integer limit, ParameterOrderListLoyaltyTiers order) throws ApiException
      List Loyalty Tiers Retrieve a list of loyalty tiers which were added to the loyalty program.
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (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)
      Returns:
      ApiResponse<LoyaltiesTiersListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLoyaltyTiersAsync

      public okhttp3.Call listLoyaltyTiersAsync(String campaignId, Integer limit, ParameterOrderListLoyaltyTiers order, ApiCallback<LoyaltiesTiersListResponseBody> _callback) throws ApiException
      List Loyalty Tiers (asynchronously) Retrieve a list of loyalty tiers which were added to the loyalty program.
      Parameters:
      campaignId - Unique loyalty campaign ID or name. (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)
      _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

    • listMemberActivityCall

      public okhttp3.Call listMemberActivityCall(String memberId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId, ApiCallback _callback) throws ApiException
      Build call for listMemberActivity
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (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 - Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the events starting after an event 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

    • listMemberActivity

      public LoyaltiesMemberActivityListResponseBody listMemberActivity(String memberId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId) throws ApiException
      List Member Activity 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (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 - Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)
      Returns:
      LoyaltiesMemberActivityListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMemberActivityWithHttpInfo

      public ApiResponse<LoyaltiesMemberActivityListResponseBody> listMemberActivityWithHttpInfo(String memberId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId) throws ApiException
      List Member Activity 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (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 - Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)
      Returns:
      ApiResponse<LoyaltiesMemberActivityListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMemberActivityAsync

      public okhttp3.Call listMemberActivityAsync(String memberId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId, ApiCallback<LoyaltiesMemberActivityListResponseBody> _callback) throws ApiException
      List Member Activity (asynchronously) 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (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 - Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the events starting after an event 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

    • listMemberActivity1Call

      public okhttp3.Call listMemberActivity1Call(String campaignId, String memberId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId, ApiCallback _callback) throws ApiException
      Build call for listMemberActivity1
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (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 - Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the events starting after an event 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

    • listMemberActivity1

      public LoyaltiesMemberActivityListResponseBody listMemberActivity1(String campaignId, String memberId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId) throws ApiException
      List Member Activity Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (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 - Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)
      Returns:
      LoyaltiesMemberActivityListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMemberActivity1WithHttpInfo

      public ApiResponse<LoyaltiesMemberActivityListResponseBody> listMemberActivity1WithHttpInfo(String campaignId, String memberId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId) throws ApiException
      List Member Activity Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (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 - Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the events starting after an event with the given ID. (optional)
      Returns:
      ApiResponse<LoyaltiesMemberActivityListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMemberActivity1Async

      public okhttp3.Call listMemberActivity1Async(String campaignId, String memberId, Integer limit, ParameterOrderCreatedAt order, String startingAfterId, ApiCallback<LoyaltiesMemberActivityListResponseBody> _callback) throws ApiException
      List Member Activity (asynchronously) Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (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 - Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order. (optional)
      startingAfterId - A cursor for pagination. It retrieves the events starting after an event 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

    • listMemberLoyaltyTierCall

      public okhttp3.Call listMemberLoyaltyTierCall(String memberId, ApiCallback _callback) throws ApiException
      Build call for listMemberLoyaltyTier
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listMemberLoyaltyTier

      public LoyaltiesMembersTiersListResponseBody listMemberLoyaltyTier(String memberId) throws ApiException
      List Member's Loyalty Tiers Retrieve member tiers using the loyalty card ID.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      Returns:
      LoyaltiesMembersTiersListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMemberLoyaltyTierWithHttpInfo

      public ApiResponse<LoyaltiesMembersTiersListResponseBody> listMemberLoyaltyTierWithHttpInfo(String memberId) throws ApiException
      List Member's Loyalty Tiers Retrieve member tiers using the loyalty card ID.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      Returns:
      ApiResponse<LoyaltiesMembersTiersListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMemberLoyaltyTierAsync

      public okhttp3.Call listMemberLoyaltyTierAsync(String memberId, ApiCallback<LoyaltiesMembersTiersListResponseBody> _callback) throws ApiException
      List Member's Loyalty Tiers (asynchronously) Retrieve member tiers using the loyalty card ID.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (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

    • listMemberRewardsCall

      public okhttp3.Call listMemberRewardsCall(String memberId, Boolean affordableOnly, ApiCallback _callback) throws ApiException
      Build call for listMemberRewards
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      affordableOnly - Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listMemberRewards

      public LoyaltiesMembersRewardsListResponseBody listMemberRewards(String memberId, Boolean affordableOnly) throws ApiException
      List Member Rewards Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      affordableOnly - Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford. (optional)
      Returns:
      LoyaltiesMembersRewardsListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMemberRewardsWithHttpInfo

      public ApiResponse<LoyaltiesMembersRewardsListResponseBody> listMemberRewardsWithHttpInfo(String memberId, Boolean affordableOnly) throws ApiException
      List Member Rewards Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      affordableOnly - Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersRewardsListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMemberRewardsAsync

      public okhttp3.Call listMemberRewardsAsync(String memberId, Boolean affordableOnly, ApiCallback<LoyaltiesMembersRewardsListResponseBody> _callback) throws ApiException
      List Member Rewards (asynchronously) Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      affordableOnly - Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to true to return rewards which the customer can actually afford. (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

    • listMembersCall

      public okhttp3.Call listMembersCall(String campaignId, Integer limit, Integer page, String customer, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ParameterOrderVouchers order, String code, List<String> ids, ApiCallback _callback) throws ApiException
      Build call for listMembers
      Parameters:
      campaignId - Unique campaign ID of the loyalty program. (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)
      page - Which page of results to return. The lowest value is 1. (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)
      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

    • listMembers

      public LoyaltiesListMembersResponseBody listMembers(String campaignId, Integer limit, Integer page, String customer, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ParameterOrderVouchers order, String code, List<String> ids) throws ApiException
      List Members Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
      Parameters:
      campaignId - Unique campaign ID of the loyalty program. (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)
      page - Which page of results to return. The lowest value is 1. (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)
      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:
      LoyaltiesListMembersResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMembersWithHttpInfo

      public ApiResponse<LoyaltiesListMembersResponseBody> listMembersWithHttpInfo(String campaignId, Integer limit, Integer page, String customer, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ParameterOrderVouchers order, String code, List<String> ids) throws ApiException
      List Members Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
      Parameters:
      campaignId - Unique campaign ID of the loyalty program. (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)
      page - Which page of results to return. The lowest value is 1. (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)
      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<LoyaltiesListMembersResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listMembersAsync

      public okhttp3.Call listMembersAsync(String campaignId, Integer limit, Integer page, String customer, ParameterCreatedBeforeAfter createdAt, ParameterUpdatedBeforeAfter updatedAt, ParameterOrderVouchers order, String code, List<String> ids, ApiCallback<LoyaltiesListMembersResponseBody> _callback) throws ApiException
      List Members (asynchronously) Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
      Parameters:
      campaignId - Unique campaign ID of the loyalty program. (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)
      page - Which page of results to return. The lowest value is 1. (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)
      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

    • listPointsExpirationCall

      public okhttp3.Call listPointsExpirationCall(String campaignId, String memberId, Integer limit, Integer page, ApiCallback _callback) throws ApiException
      Build call for listPointsExpiration
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      memberId - Loyalty card code. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listPointsExpiration

      public LoyaltiesMembersPointsExpirationListResponseBody listPointsExpiration(String campaignId, String memberId, Integer limit, Integer page) throws ApiException
      Get Points Expiration Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      memberId - Loyalty card code. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      Returns:
      LoyaltiesMembersPointsExpirationListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listPointsExpirationWithHttpInfo

      public ApiResponse<LoyaltiesMembersPointsExpirationListResponseBody> listPointsExpirationWithHttpInfo(String campaignId, String memberId, Integer limit, Integer page) throws ApiException
      Get Points Expiration Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      memberId - Loyalty card code. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersPointsExpirationListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listPointsExpirationAsync

      public okhttp3.Call listPointsExpirationAsync(String campaignId, String memberId, Integer limit, Integer page, ApiCallback<LoyaltiesMembersPointsExpirationListResponseBody> _callback) throws ApiException
      Get Points Expiration (asynchronously) Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      memberId - Loyalty card code. (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)
      page - Which page of results to return. The lowest value is 1. (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

    • listRewardAssignments1Call

      public okhttp3.Call listRewardAssignments1Call(String campaignId, Integer limit, Integer page, String assignmentId, ApiCallback _callback) throws ApiException
      Build call for listRewardAssignments1
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      assignmentId - A unique reward assignment ID. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listRewardAssignments1

      public LoyaltiesRewardAssignmentsListResponseBody listRewardAssignments1(String campaignId, Integer limit, Integer page, String assignmentId) throws ApiException
      List Reward Assignments Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to be more contextual to the type of data returned in the response.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      assignmentId - A unique reward assignment ID. (optional)
      Returns:
      LoyaltiesRewardAssignmentsListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listRewardAssignments1WithHttpInfo

      public ApiResponse<LoyaltiesRewardAssignmentsListResponseBody> listRewardAssignments1WithHttpInfo(String campaignId, Integer limit, Integer page, String assignmentId) throws ApiException
      List Reward Assignments Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to be more contextual to the type of data returned in the response.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      assignmentId - A unique reward assignment ID. (optional)
      Returns:
      ApiResponse<LoyaltiesRewardAssignmentsListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listRewardAssignments1Async

      public okhttp3.Call listRewardAssignments1Async(String campaignId, Integer limit, Integer page, String assignmentId, ApiCallback<LoyaltiesRewardAssignmentsListResponseBody> _callback) throws ApiException
      List Reward Assignments (asynchronously) Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to be more contextual to the type of data returned in the response.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      assignmentId - A unique reward assignment 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

    • listRewardAssignments2Call

      public okhttp3.Call listRewardAssignments2Call(String campaignId, Integer limit, Integer page, String assignmentId, ApiCallback _callback) throws ApiException
      Build call for listRewardAssignments2
      Parameters:
      campaignId - Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      assignmentId - A unique reward assignment ID. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listRewardAssignments2

      public LoyaltiesRewardsListAssignmentsResponseBody listRewardAssignments2(String campaignId, Integer limit, Integer page, String assignmentId) throws ApiException
      List Reward Assignments Returns active rewards from a given loyalty campaign.
      Parameters:
      campaignId - Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      assignmentId - A unique reward assignment ID. (optional)
      Returns:
      LoyaltiesRewardsListAssignmentsResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listRewardAssignments2WithHttpInfo

      public ApiResponse<LoyaltiesRewardsListAssignmentsResponseBody> listRewardAssignments2WithHttpInfo(String campaignId, Integer limit, Integer page, String assignmentId) throws ApiException
      List Reward Assignments Returns active rewards from a given loyalty campaign.
      Parameters:
      campaignId - Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      assignmentId - A unique reward assignment ID. (optional)
      Returns:
      ApiResponse<LoyaltiesRewardsListAssignmentsResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listRewardAssignments2Async

      public okhttp3.Call listRewardAssignments2Async(String campaignId, Integer limit, Integer page, String assignmentId, ApiCallback<LoyaltiesRewardsListAssignmentsResponseBody> _callback) throws ApiException
      List Reward Assignments (asynchronously) Returns active rewards from a given loyalty campaign.
      Parameters:
      campaignId - Unique campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (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)
      page - Which page of results to return. The lowest value is 1. (optional)
      assignmentId - A unique reward assignment 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

    • redeemRewardCall

      public okhttp3.Call redeemRewardCall(String memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, ApiCallback _callback) throws ApiException
      Build call for redeemReward
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      loyaltiesMembersRedemptionRedeemRequestBody - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • redeemReward

      public LoyaltiesMembersRedemptionRedeemResponseBody redeemReward(String memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody) throws ApiException
      Redeem Reward 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      loyaltiesMembersRedemptionRedeemRequestBody - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional)
      Returns:
      LoyaltiesMembersRedemptionRedeemResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • redeemRewardWithHttpInfo

      public ApiResponse<LoyaltiesMembersRedemptionRedeemResponseBody> redeemRewardWithHttpInfo(String memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody) throws ApiException
      Redeem Reward 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      loyaltiesMembersRedemptionRedeemRequestBody - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersRedemptionRedeemResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • redeemRewardAsync

      public okhttp3.Call redeemRewardAsync(String memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, ApiCallback<LoyaltiesMembersRedemptionRedeemResponseBody> _callback) throws ApiException
      Redeem Reward (asynchronously) 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      loyaltiesMembersRedemptionRedeemRequestBody - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • redeemReward1Call

      public okhttp3.Call redeemReward1Call(String campaignId, String memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, ApiCallback _callback) throws ApiException
      Build call for redeemReward1
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (required)
      loyaltiesMembersRedemptionRedeemRequestBody - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • redeemReward1

      public LoyaltiesMembersRedemptionRedeemResponseBody redeemReward1(String campaignId, String memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody) throws ApiException
      Redeem Reward Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (required)
      loyaltiesMembersRedemptionRedeemRequestBody - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional)
      Returns:
      LoyaltiesMembersRedemptionRedeemResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • redeemReward1WithHttpInfo

      public ApiResponse<LoyaltiesMembersRedemptionRedeemResponseBody> redeemReward1WithHttpInfo(String campaignId, String memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody) throws ApiException
      Redeem Reward Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (required)
      loyaltiesMembersRedemptionRedeemRequestBody - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersRedemptionRedeemResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • redeemReward1Async

      public okhttp3.Call redeemReward1Async(String campaignId, String memberId, LoyaltiesMembersRedemptionRedeemRequestBody loyaltiesMembersRedemptionRedeemRequestBody, ApiCallback<LoyaltiesMembersRedemptionRedeemResponseBody> _callback) throws ApiException
      Redeem Reward (asynchronously) Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (required)
      loyaltiesMembersRedemptionRedeemRequestBody - Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • transferPointsCall

      public okhttp3.Call transferPointsCall(String campaignId, String memberId, List<LoyaltiesTransferPoints> loyaltiesTransferPoints, ApiCallback _callback) throws ApiException
      Build call for transferPoints
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). (required)
      memberId - A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). (required)
      loyaltiesTransferPoints - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • transferPoints

      public LoyaltiesMembersTransfersCreateResponseBody transferPoints(String campaignId, String memberId, List<LoyaltiesTransferPoints> loyaltiesTransferPoints) throws ApiException
      Transfer Loyalty Points Transfer points between different loyalty cards. You need to provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters in the URL. In the request body, you provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). (required)
      memberId - A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). (required)
      loyaltiesTransferPoints - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional)
      Returns:
      LoyaltiesMembersTransfersCreateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • transferPointsWithHttpInfo

      public ApiResponse<LoyaltiesMembersTransfersCreateResponseBody> transferPointsWithHttpInfo(String campaignId, String memberId, List<LoyaltiesTransferPoints> loyaltiesTransferPoints) throws ApiException
      Transfer Loyalty Points Transfer points between different loyalty cards. You need to provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters in the URL. In the request body, you provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). (required)
      memberId - A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). (required)
      loyaltiesTransferPoints - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersTransfersCreateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • transferPointsAsync

      public okhttp3.Call transferPointsAsync(String campaignId, String memberId, List<LoyaltiesTransferPoints> loyaltiesTransferPoints, ApiCallback<LoyaltiesMembersTransfersCreateResponseBody> _callback) throws ApiException
      Transfer Loyalty Points (asynchronously) Transfer points between different loyalty cards. You need to provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters in the URL. In the request body, you provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.
      Parameters:
      campaignId - A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). (required)
      memberId - A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). (required)
      loyaltiesTransferPoints - Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. (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

    • updateEarningRuleCall

      public okhttp3.Call updateEarningRuleCall(String campaignId, String earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, ApiCallback _callback) throws ApiException
      Build call for updateEarningRule
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      loyaltiesEarningRulesUpdateRequestBody - Specify the parameters that you would like to update for the given earning rule. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateEarningRule

      public LoyaltiesEarningRulesUpdateResponseBody updateEarningRule(String campaignId, String earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody) throws ApiException
      Update Earning Rule Update an earning rule definition.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      loyaltiesEarningRulesUpdateRequestBody - Specify the parameters that you would like to update for the given earning rule. (optional)
      Returns:
      LoyaltiesEarningRulesUpdateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateEarningRuleWithHttpInfo

      public ApiResponse<LoyaltiesEarningRulesUpdateResponseBody> updateEarningRuleWithHttpInfo(String campaignId, String earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody) throws ApiException
      Update Earning Rule Update an earning rule definition.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      loyaltiesEarningRulesUpdateRequestBody - Specify the parameters that you would like to update for the given earning rule. (optional)
      Returns:
      ApiResponse<LoyaltiesEarningRulesUpdateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateEarningRuleAsync

      public okhttp3.Call updateEarningRuleAsync(String campaignId, String earningRuleId, LoyaltiesEarningRulesUpdateRequestBody loyaltiesEarningRulesUpdateRequestBody, ApiCallback<LoyaltiesEarningRulesUpdateResponseBody> _callback) throws ApiException
      Update Earning Rule (asynchronously) Update an earning rule definition.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      earningRuleId - A unique earning rule ID. (required)
      loyaltiesEarningRulesUpdateRequestBody - Specify the parameters that you would like to update for the given earning rule. (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

    • updateLoyaltyCardBalanceCall

      public okhttp3.Call updateLoyaltyCardBalanceCall(String memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, ApiCallback _callback) throws ApiException
      Build call for updateLoyaltyCardBalance
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      loyaltiesMembersBalanceUpdateRequestBody - Specify the point adjustment along with the expiration mechanism. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateLoyaltyCardBalance

      public LoyaltiesMembersBalanceUpdateResponseBody updateLoyaltyCardBalance(String memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody) throws ApiException
      Add or Remove Loyalty Card Balance This method gives adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      loyaltiesMembersBalanceUpdateRequestBody - Specify the point adjustment along with the expiration mechanism. (optional)
      Returns:
      LoyaltiesMembersBalanceUpdateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateLoyaltyCardBalanceWithHttpInfo

      public ApiResponse<LoyaltiesMembersBalanceUpdateResponseBody> updateLoyaltyCardBalanceWithHttpInfo(String memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody) throws ApiException
      Add or Remove Loyalty Card Balance This method gives adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      loyaltiesMembersBalanceUpdateRequestBody - Specify the point adjustment along with the expiration mechanism. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersBalanceUpdateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateLoyaltyCardBalanceAsync

      public okhttp3.Call updateLoyaltyCardBalanceAsync(String memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, ApiCallback<LoyaltiesMembersBalanceUpdateResponseBody> _callback) throws ApiException
      Add or Remove Loyalty Card Balance (asynchronously) This method gives adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter.
      Parameters:
      memberId - Unique loyalty card assigned to a particular customer. (required)
      loyaltiesMembersBalanceUpdateRequestBody - Specify the point adjustment along with the expiration mechanism. (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

    • updateLoyaltyCardBalance1Call

      public okhttp3.Call updateLoyaltyCardBalance1Call(String campaignId, String memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, ApiCallback _callback) throws ApiException
      Build call for updateLoyaltyCardBalance1
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (required)
      loyaltiesMembersBalanceUpdateRequestBody - Specify the point adjustment along with the expiration mechanism. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateLoyaltyCardBalance1

      public LoyaltiesMembersBalanceUpdateResponseBody updateLoyaltyCardBalance1(String campaignId, String memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody) throws ApiException
      Add or Remove Loyalty Card Balance This method adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls.
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (required)
      loyaltiesMembersBalanceUpdateRequestBody - Specify the point adjustment along with the expiration mechanism. (optional)
      Returns:
      LoyaltiesMembersBalanceUpdateResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateLoyaltyCardBalance1WithHttpInfo

      public ApiResponse<LoyaltiesMembersBalanceUpdateResponseBody> updateLoyaltyCardBalance1WithHttpInfo(String campaignId, String memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody) throws ApiException
      Add or Remove Loyalty Card Balance This method adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls.
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (required)
      loyaltiesMembersBalanceUpdateRequestBody - Specify the point adjustment along with the expiration mechanism. (optional)
      Returns:
      ApiResponse<LoyaltiesMembersBalanceUpdateResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateLoyaltyCardBalance1Async

      public okhttp3.Call updateLoyaltyCardBalance1Async(String campaignId, String memberId, LoyaltiesMembersBalanceUpdateRequestBody loyaltiesMembersBalanceUpdateRequestBody, ApiCallback<LoyaltiesMembersBalanceUpdateResponseBody> _callback) throws ApiException
      Add or Remove Loyalty Card Balance (asynchronously) This method adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls.
      Parameters:
      campaignId - Unique campaign ID. (required)
      memberId - A code that identifies the loyalty card. (required)
      loyaltiesMembersBalanceUpdateRequestBody - Specify the point adjustment along with the expiration mechanism. (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

    • updateLoyaltyProgramCall

      public okhttp3.Call updateLoyaltyProgramCall(String campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, ApiCallback _callback) throws ApiException
      Build call for updateLoyaltyProgram
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesUpdateCampaignRequestBody - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateLoyaltyProgram

      public LoyaltiesUpdateCampaignResponseBody updateLoyaltyProgram(String campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody) throws ApiException
      Update Loyalty Campaign Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the loyalty cards which have not been published or redeemed yet.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesUpdateCampaignRequestBody - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional)
      Returns:
      LoyaltiesUpdateCampaignResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateLoyaltyProgramWithHttpInfo

      public ApiResponse<LoyaltiesUpdateCampaignResponseBody> updateLoyaltyProgramWithHttpInfo(String campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody) throws ApiException
      Update Loyalty Campaign Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the loyalty cards which have not been published or redeemed yet.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesUpdateCampaignRequestBody - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (optional)
      Returns:
      ApiResponse<LoyaltiesUpdateCampaignResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateLoyaltyProgramAsync

      public okhttp3.Call updateLoyaltyProgramAsync(String campaignId, LoyaltiesUpdateCampaignRequestBody loyaltiesUpdateCampaignRequestBody, ApiCallback<LoyaltiesUpdateCampaignResponseBody> _callback) throws ApiException
      Update Loyalty Campaign (asynchronously) Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the loyalty cards which have not been published or redeemed yet.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      loyaltiesUpdateCampaignRequestBody - Specify the new values for the parameters that you would like to update for the given loyalty campaign. (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

    • updateRewardAssignment1Call

      public okhttp3.Call updateRewardAssignment1Call(String campaignId, String assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, ApiCallback _callback) throws ApiException
      Build call for updateRewardAssignment1
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      loyaltiesRewardsUpdateAssignmentRequestBody - Update the points cost for the reward assignment. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateRewardAssignment1

      public LoyaltiesRewardsUpdateAssignmentResponseBody updateRewardAssignment1(String campaignId, String assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody) throws ApiException
      Update Reward Assignment Updates rewards parameters, i.e. the points cost for the specific reward.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      loyaltiesRewardsUpdateAssignmentRequestBody - Update the points cost for the reward assignment. (optional)
      Returns:
      LoyaltiesRewardsUpdateAssignmentResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateRewardAssignment1WithHttpInfo

      public ApiResponse<LoyaltiesRewardsUpdateAssignmentResponseBody> updateRewardAssignment1WithHttpInfo(String campaignId, String assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody) throws ApiException
      Update Reward Assignment Updates rewards parameters, i.e. the points cost for the specific reward.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      loyaltiesRewardsUpdateAssignmentRequestBody - Update the points cost for the reward assignment. (optional)
      Returns:
      ApiResponse<LoyaltiesRewardsUpdateAssignmentResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateRewardAssignment1Async

      public okhttp3.Call updateRewardAssignment1Async(String campaignId, String assignmentId, LoyaltiesRewardsUpdateAssignmentRequestBody loyaltiesRewardsUpdateAssignmentRequestBody, ApiCallback<LoyaltiesRewardsUpdateAssignmentResponseBody> _callback) throws ApiException
      Update Reward Assignment (asynchronously) Updates rewards parameters, i.e. the points cost for the specific reward.
      Parameters:
      campaignId - The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign. (required)
      assignmentId - A unique reward assignment ID. (required)
      loyaltiesRewardsUpdateAssignmentRequestBody - Update the points cost for the reward assignment. (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