voucherify 8.1.0 → 8.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +1 -1
  3. data/ENDPOINTS-COVERAGE.md +55 -55
  4. data/Gemfile.lock +2 -2
  5. data/README.md +5 -0
  6. data/docs/CampaignsApi.md +7 -7
  7. data/docs/ClientSideApi.md +2 -2
  8. data/docs/CustomersApi.md +5 -5
  9. data/docs/ErrorError.md +1 -1
  10. data/docs/ExportParameters.md +2 -2
  11. data/docs/ExportsApi.md +6 -6
  12. data/docs/ExportsCreateRequestBodyParameters.md +2 -2
  13. data/docs/ExportsCreateResponseBodyParameters.md +2 -2
  14. data/docs/ExportsGetResponseBodyParameters.md +2 -2
  15. data/docs/LoyaltiesApi.md +52 -52
  16. data/docs/ManagementApi.md +26 -26
  17. data/docs/MetadataSchemasApi.md +2 -2
  18. data/docs/OrdersApi.md +2 -2
  19. data/docs/ProductCollectionsApi.md +1 -1
  20. data/docs/ProductsApi.md +4 -4
  21. data/docs/PublicationsApi.md +3 -3
  22. data/docs/QualificationsApi.md +1 -1
  23. data/docs/RedemptionRewardResultParametersCoin.md +1 -1
  24. data/docs/RedemptionsApi.md +3 -3
  25. data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -0
  26. data/docs/ReferralsApi.md +4 -4
  27. data/docs/RewardsCreateRequestBodyParametersCoin.md +1 -1
  28. data/docs/RewardsUpdateRequestBodyParametersCoin.md +1 -1
  29. data/docs/SegmentsApi.md +1 -1
  30. data/docs/TemplatesApi.md +7 -7
  31. data/docs/ValidationRulesApi.md +2 -2
  32. data/docs/ValidationsValidateRequestBodyOptions.md +1 -0
  33. data/docs/VouchersApi.md +8 -8
  34. data/lib/VoucherifySdk/api/campaigns_api.rb +14 -14
  35. data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
  36. data/lib/VoucherifySdk/api/customers_api.rb +10 -10
  37. data/lib/VoucherifySdk/api/exports_api.rb +8 -8
  38. data/lib/VoucherifySdk/api/loyalties_api.rb +104 -104
  39. data/lib/VoucherifySdk/api/management_api.rb +52 -52
  40. data/lib/VoucherifySdk/api/metadata_schemas_api.rb +4 -4
  41. data/lib/VoucherifySdk/api/orders_api.rb +4 -4
  42. data/lib/VoucherifySdk/api/product_collections_api.rb +2 -2
  43. data/lib/VoucherifySdk/api/products_api.rb +8 -8
  44. data/lib/VoucherifySdk/api/publications_api.rb +6 -6
  45. data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
  46. data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
  47. data/lib/VoucherifySdk/api/referrals_api.rb +8 -8
  48. data/lib/VoucherifySdk/api/segments_api.rb +2 -2
  49. data/lib/VoucherifySdk/api/templates_api.rb +14 -14
  50. data/lib/VoucherifySdk/api/validation_rules_api.rb +4 -4
  51. data/lib/VoucherifySdk/api/vouchers_api.rb +16 -16
  52. data/lib/VoucherifySdk/models/error_error.rb +2 -2
  53. data/lib/VoucherifySdk/models/export.rb +1 -1
  54. data/lib/VoucherifySdk/models/export_parameters.rb +3 -3
  55. data/lib/VoucherifySdk/models/exports_create_request_body.rb +1 -1
  56. data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +3 -3
  57. data/lib/VoucherifySdk/models/exports_create_response_body.rb +1 -1
  58. data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +3 -3
  59. data/lib/VoucherifySdk/models/exports_get_response_body.rb +1 -1
  60. data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +3 -3
  61. data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb +1 -1
  62. data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +28 -6
  63. data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_coin.rb +1 -1
  64. data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_coin.rb +1 -1
  65. data/lib/VoucherifySdk/models/validations_redeemable_skipped_result_details.rb +1 -1
  66. data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +28 -6
  67. data/lib/VoucherifySdk/version.rb +1 -1
  68. metadata +32 -32
@@ -20,7 +20,7 @@ module VoucherifySdk
20
20
  @api_client = api_client
21
21
  end
22
22
  # Activate Member Pending Points
23
- # Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
23
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
24
24
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
25
25
  # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
26
26
  # @param [Hash] opts the optional parameters
@@ -31,7 +31,7 @@ module VoucherifySdk
31
31
  end
32
32
 
33
33
  # Activate Member Pending Points
34
- # Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
34
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. &lt;Tip&gt; &lt;Badge color green&gt;Configuring pending points&lt;/Badge&gt; Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). &lt;/Tip&gt;
35
35
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
36
36
  # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
37
37
  # @param [Hash] opts the optional parameters
@@ -81,7 +81,7 @@ module VoucherifySdk
81
81
  end
82
82
 
83
83
  # Add Member
84
- # This method assigns a loyalty card to a customer. It selects a [loyalty card](/api-reference/vouchers/get-voucher) 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.
84
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method assigns a loyalty card to a customer. It selects a [loyalty card](/api-reference/vouchers/get-voucher) 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. <Note> <Badge color blue>Auto-update campaign</Badge> In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign. </Note>
85
85
  # @param campaign_id [String] Unique campaign ID of the loyalty program.
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @option opts [LoyaltiesMembersCreateRequestBody] :loyalties_members_create_request_body 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](/api-reference/publications/list-publications) endpoint.
@@ -92,7 +92,7 @@ module VoucherifySdk
92
92
  end
93
93
 
94
94
  # Add Member
95
- # This method assigns a loyalty card to a customer. It selects a [loyalty card](/api-reference/vouchers/get-voucher) 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.
95
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; This method assigns a loyalty card to a customer. It selects a [loyalty card](/api-reference/vouchers/get-voucher) 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. &lt;Note&gt; &lt;Badge color blue&gt;Auto-update campaign&lt;/Badge&gt; In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign. &lt;/Note&gt;
96
96
  # @param campaign_id [String] Unique campaign ID of the loyalty program.
97
97
  # @param [Hash] opts the optional parameters
98
98
  # @option opts [LoyaltiesMembersCreateRequestBody] :loyalties_members_create_request_body 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](/api-reference/publications/list-publications) endpoint.
@@ -147,7 +147,7 @@ module VoucherifySdk
147
147
  end
148
148
 
149
149
  # Adjust Member Pending Points
150
- # Adjusts the pending points with a given ID. You can add or subtract the number of points. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
150
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Adjusts the pending points with a given ID. You can add or subtract the number of points. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
151
151
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
152
152
  # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
153
153
  # @param [Hash] opts the optional parameters
@@ -159,7 +159,7 @@ module VoucherifySdk
159
159
  end
160
160
 
161
161
  # Adjust Member Pending Points
162
- # Adjusts the pending points with a given ID. You can add or subtract the number of points. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
162
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Adjusts the pending points with a given ID. You can add or subtract the number of points. &lt;Tip&gt; &lt;Badge color green&gt;Configuring pending points&lt;/Badge&gt; Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). &lt;/Tip&gt;
163
163
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
164
164
  # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
165
165
  # @param [Hash] opts the optional parameters
@@ -215,7 +215,7 @@ module VoucherifySdk
215
215
  end
216
216
 
217
217
  # Cancel Member Pending Points
218
- # Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
218
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
219
219
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
220
220
  # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
221
221
  # @param [Hash] opts the optional parameters
@@ -226,7 +226,7 @@ module VoucherifySdk
226
226
  end
227
227
 
228
228
  # Cancel Member Pending Points
229
- # Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
229
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. &lt;Tip&gt; &lt;Badge color green&gt;Configuring pending points&lt;/Badge&gt; Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). &lt;/Tip&gt;
230
230
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
231
231
  # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
232
232
  # @param [Hash] opts the optional parameters
@@ -274,7 +274,7 @@ module VoucherifySdk
274
274
  end
275
275
 
276
276
  # Create Earning Rule
277
- # Create earning rules for a loyalty campaign. 🚧 Maximum number of earning rules You can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup.
277
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Create earning rules for a loyalty campaign. <Warning> <Badge color yellow>Maximum number of earning rules</Badge> You can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup. </Warning>
278
278
  # @param campaign_id [String] 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.
279
279
  # @param [Hash] opts the optional parameters
280
280
  # @option opts [Array<LoyaltiesEarningRulesCreateRequestBodyItem>] :loyalties_earning_rules_create_request_body_item 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
@@ -285,7 +285,7 @@ module VoucherifySdk
285
285
  end
286
286
 
287
287
  # Create Earning Rule
288
- # Create earning rules for a loyalty campaign. 🚧 Maximum number of earning rules You can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup.
288
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Create earning rules for a loyalty campaign. &lt;Warning&gt; &lt;Badge color yellow&gt;Maximum number of earning rules&lt;/Badge&gt; You can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup. &lt;/Warning&gt;
289
289
  # @param campaign_id [String] 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.
290
290
  # @param [Hash] opts the optional parameters
291
291
  # @option opts [Array<LoyaltiesEarningRulesCreateRequestBodyItem>] :loyalties_earning_rules_create_request_body_item 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
@@ -340,7 +340,7 @@ module VoucherifySdk
340
340
  end
341
341
 
342
342
  # Create loyalty tiers
343
- # Creates loyalty tiers for desired campaign.
343
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Creates loyalty tiers for desired campaign.
344
344
  # @param campaign_id [String] Unique loyalty campaign ID or name.
345
345
  # @param [Hash] opts the optional parameters
346
346
  # @option opts [Array<LoyaltiesTiersCreateInBulkRequestBodyItem>] :loyalties_tiers_create_in_bulk_request_body_item Provide tier definitions you want to add to existing loyalty campaign.
@@ -351,7 +351,7 @@ module VoucherifySdk
351
351
  end
352
352
 
353
353
  # Create loyalty tiers
354
- # Creates loyalty tiers for desired campaign.
354
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Creates loyalty tiers for desired campaign.
355
355
  # @param campaign_id [String] Unique loyalty campaign ID or name.
356
356
  # @param [Hash] opts the optional parameters
357
357
  # @option opts [Array<LoyaltiesTiersCreateInBulkRequestBodyItem>] :loyalties_tiers_create_in_bulk_request_body_item Provide tier definitions you want to add to existing loyalty campaign.
@@ -406,7 +406,7 @@ module VoucherifySdk
406
406
  end
407
407
 
408
408
  # Create Loyalty Campaign
409
- # Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) 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. 🚧 Asynchronous 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](/api-reference/loyalties/loyalty-campaign-object) description.
409
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. <Note> <Badge color blue>Global uniqueness</Badge> All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. </Note> <Warning> <Badge color yellow>Asynchronous action!</Badge> 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](/api-reference/loyalties/loyalty-campaign-object) description. </Warning>
410
410
  # @param [Hash] opts the optional parameters
411
411
  # @option opts [LoyaltiesCreateCampaignRequestBody] :loyalties_create_campaign_request_body Specify the loyalty campaign details.
412
412
  # @return [LoyaltiesCreateCampaignResponseBody]
@@ -416,7 +416,7 @@ module VoucherifySdk
416
416
  end
417
417
 
418
418
  # Create Loyalty Campaign
419
- # Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) 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. 🚧 Asynchronous 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](/api-reference/loyalties/loyalty-campaign-object) description.
419
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. &lt;Note&gt; &lt;Badge color blue&gt;Global uniqueness&lt;/Badge&gt; All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. &lt;/Note&gt; &lt;Warning&gt; &lt;Badge color yellow&gt;Asynchronous action!&lt;/Badge&gt; 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](/api-reference/loyalties/loyalty-campaign-object) description. &lt;/Warning&gt;
420
420
  # @param [Hash] opts the optional parameters
421
421
  # @option opts [LoyaltiesCreateCampaignRequestBody] :loyalties_create_campaign_request_body Specify the loyalty campaign details.
422
422
  # @return [Array<(LoyaltiesCreateCampaignResponseBody, Integer, Hash)>] LoyaltiesCreateCampaignResponseBody data, response status code and response headers
@@ -470,7 +470,7 @@ module VoucherifySdk
470
470
  end
471
471
 
472
472
  # Export Loyalty Campaign Point Expiration
473
- # Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.
473
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.
474
474
  # @param campaign_id [String] Unique campaign ID or name.
475
475
  # @param [Hash] opts the optional parameters
476
476
  # @option opts [LoyaltiesPointsExpirationExportCreateRequestBody] :loyalties_points_expiration_export_create_request_body Specify the data filters, types of data to return and order in which the results should be returned.
@@ -481,7 +481,7 @@ module VoucherifySdk
481
481
  end
482
482
 
483
483
  # Export Loyalty Campaign Point Expiration
484
- # Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.
484
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.
485
485
  # @param campaign_id [String] Unique campaign ID or name.
486
486
  # @param [Hash] opts the optional parameters
487
487
  # @option opts [LoyaltiesPointsExpirationExportCreateRequestBody] :loyalties_points_expiration_export_create_request_body Specify the data filters, types of data to return and order in which the results should be returned.
@@ -536,7 +536,7 @@ module VoucherifySdk
536
536
  end
537
537
 
538
538
  # Create Loyalty Campaign Reward Assignment
539
- # Add rewards to a loyalty campaign.
539
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Add rewards to a loyalty campaign.
540
540
  # @param campaign_id [String] 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.
541
541
  # @param [Hash] opts the optional parameters
542
542
  # @option opts [Array<LoyaltiesRewardsCreateAssignmentItemRequestBody>] :loyalties_rewards_create_assignment_item_request_body Define the cost of the rewards in loyalty points.
@@ -547,7 +547,7 @@ module VoucherifySdk
547
547
  end
548
548
 
549
549
  # Create Loyalty Campaign Reward Assignment
550
- # Add rewards to a loyalty campaign.
550
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Add rewards to a loyalty campaign.
551
551
  # @param campaign_id [String] 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.
552
552
  # @param [Hash] opts the optional parameters
553
553
  # @option opts [Array<LoyaltiesRewardsCreateAssignmentItemRequestBody>] :loyalties_rewards_create_assignment_item_request_body Define the cost of the rewards in loyalty points.
@@ -602,7 +602,7 @@ module VoucherifySdk
602
602
  end
603
603
 
604
604
  # Delete Earning Rule
605
- # This method deletes an earning rule for a specific loyalty campaign.
605
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method deletes an earning rule for a specific loyalty campaign.
606
606
  # @param campaign_id [String] 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.
607
607
  # @param earning_rule_id [String] A unique earning rule ID.
608
608
  # @param [Hash] opts the optional parameters
@@ -613,7 +613,7 @@ module VoucherifySdk
613
613
  end
614
614
 
615
615
  # Delete Earning Rule
616
- # This method deletes an earning rule for a specific loyalty campaign.
616
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; This method deletes an earning rule for a specific loyalty campaign.
617
617
  # @param campaign_id [String] 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.
618
618
  # @param earning_rule_id [String] A unique earning rule ID.
619
619
  # @param [Hash] opts the optional parameters
@@ -661,7 +661,7 @@ module VoucherifySdk
661
661
  end
662
662
 
663
663
  # Delete Loyalty Campaign
664
- # 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](/api-reference/bin/list-bin-entries).
664
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> 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](/api-reference/bin/list-bin-entries).
665
665
  # @param campaign_id [String] 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.
666
666
  # @param [Hash] opts the optional parameters
667
667
  # @option opts [Boolean] :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.
@@ -672,7 +672,7 @@ module VoucherifySdk
672
672
  end
673
673
 
674
674
  # Delete Loyalty Campaign
675
- # 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](/api-reference/bin/list-bin-entries).
675
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; 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](/api-reference/bin/list-bin-entries).
676
676
  # @param campaign_id [String] 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.
677
677
  # @param [Hash] opts the optional parameters
678
678
  # @option opts [Boolean] :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.
@@ -723,7 +723,7 @@ module VoucherifySdk
723
723
  end
724
724
 
725
725
  # Delete Campaign Reward Assignment
726
- # This method deletes a reward assignment for a particular loyalty campaign.
726
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method deletes a reward assignment for a particular loyalty campaign.
727
727
  # @param campaign_id [String] 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.
728
728
  # @param assignment_id [String] A unique reward assignment ID.
729
729
  # @param [Hash] opts the optional parameters
@@ -734,7 +734,7 @@ module VoucherifySdk
734
734
  end
735
735
 
736
736
  # Delete Campaign Reward Assignment
737
- # This method deletes a reward assignment for a particular loyalty campaign.
737
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; This method deletes a reward assignment for a particular loyalty campaign.
738
738
  # @param campaign_id [String] 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.
739
739
  # @param assignment_id [String] A unique reward assignment ID.
740
740
  # @param [Hash] opts the optional parameters
@@ -782,7 +782,7 @@ module VoucherifySdk
782
782
  end
783
783
 
784
784
  # Disable Earning Rule
785
- # Disable an earning rule.
785
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Disable an earning rule.
786
786
  # @param campaign_id [String] Unique campaign ID or name.
787
787
  # @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
788
788
  # @param [Hash] opts the optional parameters
@@ -793,7 +793,7 @@ module VoucherifySdk
793
793
  end
794
794
 
795
795
  # Disable Earning Rule
796
- # Disable an earning rule.
796
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Disable an earning rule.
797
797
  # @param campaign_id [String] Unique campaign ID or name.
798
798
  # @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
799
799
  # @param [Hash] opts the optional parameters
@@ -843,7 +843,7 @@ module VoucherifySdk
843
843
  end
844
844
 
845
845
  # Enable Earning Rule
846
- # Enable an earning rule.
846
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Enable an earning rule.
847
847
  # @param campaign_id [String] Unique campaign ID or name.
848
848
  # @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
849
849
  # @param [Hash] opts the optional parameters
@@ -854,7 +854,7 @@ module VoucherifySdk
854
854
  end
855
855
 
856
856
  # Enable Earning Rule
857
- # Enable an earning rule.
857
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Enable an earning rule.
858
858
  # @param campaign_id [String] Unique campaign ID or name.
859
859
  # @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
860
860
  # @param [Hash] opts the optional parameters
@@ -904,7 +904,7 @@ module VoucherifySdk
904
904
  end
905
905
 
906
906
  # Export Loyalty Campaign Transactions
907
- # Export transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: 👍 Export Campaign Transactions This method works in the same way the [POST Export Campaign Transactions](/api-reference/campaigns/export-campaign-transactions) does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions.
907
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: <Tip> <Badge color green>Export Campaign Transactions</Badge> This method works in the same way the [POST Export Campaign Transactions](/api-reference/campaigns/export-campaign-transactions) does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions. </Tip>
908
908
  # @param campaign_id [String] You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
909
909
  # @param [Hash] opts the optional parameters
910
910
  # @option opts [LoyaltiesTransactionsExportCreateRequestBody] :loyalties_transactions_export_create_request_body Specify the parameters for the transaction export.
@@ -915,7 +915,7 @@ module VoucherifySdk
915
915
  end
916
916
 
917
917
  # Export Loyalty Campaign Transactions
918
- # Export transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: 👍 Export Campaign Transactions This method works in the same way the [POST Export Campaign Transactions](/api-reference/campaigns/export-campaign-transactions) does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions.
918
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Export transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: &lt;Tip&gt; &lt;Badge color green&gt;Export Campaign Transactions&lt;/Badge&gt; This method works in the same way the [POST Export Campaign Transactions](/api-reference/campaigns/export-campaign-transactions) does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions. &lt;/Tip&gt;
919
919
  # @param campaign_id [String] You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
920
920
  # @param [Hash] opts the optional parameters
921
921
  # @option opts [LoyaltiesTransactionsExportCreateRequestBody] :loyalties_transactions_export_create_request_body Specify the parameters for the transaction export.
@@ -970,7 +970,7 @@ module VoucherifySdk
970
970
  end
971
971
 
972
972
  # Export Loyalty Card Transactions
973
- # Export transactions that are associated with point movements on a loyalty card.
973
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions that are associated with point movements on a loyalty card.
974
974
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
975
975
  # @param [Hash] opts the optional parameters
976
976
  # @option opts [LoyaltiesMembersTransactionsExportCreateRequestBody] :loyalties_members_transactions_export_create_request_body Specify the parameters and filters for the transaction export.
@@ -981,7 +981,7 @@ module VoucherifySdk
981
981
  end
982
982
 
983
983
  # Export Loyalty Card Transactions
984
- # Export transactions that are associated with point movements on a loyalty card.
984
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Export transactions that are associated with point movements on a loyalty card.
985
985
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
986
986
  # @param [Hash] opts the optional parameters
987
987
  # @option opts [LoyaltiesMembersTransactionsExportCreateRequestBody] :loyalties_members_transactions_export_create_request_body Specify the parameters and filters for the transaction export.
@@ -1036,7 +1036,7 @@ module VoucherifySdk
1036
1036
  end
1037
1037
 
1038
1038
  # Export Loyalty Card Transactions with campaign ID
1039
- # Export transactions that are associated with point movements on a loyalty card.
1039
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions that are associated with point movements on a loyalty card.
1040
1040
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
1041
1041
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
1042
1042
  # @param [Hash] opts the optional parameters
@@ -1048,7 +1048,7 @@ module VoucherifySdk
1048
1048
  end
1049
1049
 
1050
1050
  # Export Loyalty Card Transactions with campaign ID
1051
- # Export transactions that are associated with point movements on a loyalty card.
1051
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Export transactions that are associated with point movements on a loyalty card.
1052
1052
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
1053
1053
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
1054
1054
  # @param [Hash] opts the optional parameters
@@ -1104,7 +1104,7 @@ module VoucherifySdk
1104
1104
  end
1105
1105
 
1106
1106
  # Get Earning Rule
1107
- # Retrieves an earning rule assigned to a campaign.
1107
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves an earning rule assigned to a campaign.
1108
1108
  # @param campaign_id [String] 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.
1109
1109
  # @param earning_rule_id [String] A unique earning rule ID.
1110
1110
  # @param [Hash] opts the optional parameters
@@ -1115,7 +1115,7 @@ module VoucherifySdk
1115
1115
  end
1116
1116
 
1117
1117
  # Get Earning Rule
1118
- # Retrieves an earning rule assigned to a campaign.
1118
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieves an earning rule assigned to a campaign.
1119
1119
  # @param campaign_id [String] 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.
1120
1120
  # @param earning_rule_id [String] A unique earning rule ID.
1121
1121
  # @param [Hash] opts the optional parameters
@@ -1165,7 +1165,7 @@ module VoucherifySdk
1165
1165
  end
1166
1166
 
1167
1167
  # Get Loyalty Campaign
1168
- # Retrieve a specific loyalty campaign.
1168
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a specific loyalty campaign.
1169
1169
  # @param campaign_id [String] 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.
1170
1170
  # @param [Hash] opts the optional parameters
1171
1171
  # @return [LoyaltiesGetCampaignResponseBody]
@@ -1175,7 +1175,7 @@ module VoucherifySdk
1175
1175
  end
1176
1176
 
1177
1177
  # Get Loyalty Campaign
1178
- # Retrieve a specific loyalty campaign.
1178
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve a specific loyalty campaign.
1179
1179
  # @param campaign_id [String] 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.
1180
1180
  # @param [Hash] opts the optional parameters
1181
1181
  # @return [Array<(LoyaltiesGetCampaignResponseBody, Integer, Hash)>] LoyaltiesGetCampaignResponseBody data, response status code and response headers
@@ -1224,7 +1224,7 @@ module VoucherifySdk
1224
1224
  end
1225
1225
 
1226
1226
  # Get Loyalty Tier
1227
- # Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
1227
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
1228
1228
  # @param campaign_id [String] Unique loyalty campaign ID or name.
1229
1229
  # @param loyalty_tier_id [String] Unique loyalty tier ID.
1230
1230
  # @param [Hash] opts the optional parameters
@@ -1235,7 +1235,7 @@ module VoucherifySdk
1235
1235
  end
1236
1236
 
1237
1237
  # Get Loyalty Tier
1238
- # Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
1238
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
1239
1239
  # @param campaign_id [String] Unique loyalty campaign ID or name.
1240
1240
  # @param loyalty_tier_id [String] Unique loyalty tier ID.
1241
1241
  # @param [Hash] opts the optional parameters
@@ -1285,7 +1285,7 @@ module VoucherifySdk
1285
1285
  end
1286
1286
 
1287
1287
  # Get Member
1288
- # Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-member-with-campaign-id). The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter.
1288
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve loyalty card with the given member ID (i.e. voucher code). <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-member-with-campaign-id). The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter. </Note>
1289
1289
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
1290
1290
  # @param [Hash] opts the optional parameters
1291
1291
  # @return [LoyaltiesMembersGetResponseBody]
@@ -1295,7 +1295,7 @@ module VoucherifySdk
1295
1295
  end
1296
1296
 
1297
1297
  # Get Member
1298
- # Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-member-with-campaign-id). The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter.
1298
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve loyalty card with the given member ID (i.e. voucher code). &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-member-with-campaign-id). The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter. &lt;/Note&gt;
1299
1299
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
1300
1300
  # @param [Hash] opts the optional parameters
1301
1301
  # @return [Array<(LoyaltiesMembersGetResponseBody, Integer, Hash)>] LoyaltiesMembersGetResponseBody data, response status code and response headers
@@ -1344,7 +1344,7 @@ module VoucherifySdk
1344
1344
  end
1345
1345
 
1346
1346
  # Get Member with campaign ID
1347
- # Retrieves the loyalty card with the given member ID (i.e. voucher code).
1347
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the loyalty card with the given member ID (i.e. voucher code).
1348
1348
  # @param campaign_id [String] Unique campaign ID.
1349
1349
  # @param member_id [String] Unique code that identifies the loyalty card.
1350
1350
  # @param [Hash] opts the optional parameters
@@ -1355,7 +1355,7 @@ module VoucherifySdk
1355
1355
  end
1356
1356
 
1357
1357
  # Get Member with campaign ID
1358
- # Retrieves the loyalty card with the given member ID (i.e. voucher code).
1358
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieves the loyalty card with the given member ID (i.e. voucher code).
1359
1359
  # @param campaign_id [String] Unique campaign ID.
1360
1360
  # @param member_id [String] Unique code that identifies the loyalty card.
1361
1361
  # @param [Hash] opts the optional parameters
@@ -1405,7 +1405,7 @@ module VoucherifySdk
1405
1405
  end
1406
1406
 
1407
1407
  # Get Campaign Reward Assignments
1408
- # Retrieve specific reward assignment.
1408
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve specific reward assignment.
1409
1409
  # @param campaign_id [String] 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.
1410
1410
  # @param assignment_id [String] Unique reward assignment ID.
1411
1411
  # @param [Hash] opts the optional parameters
@@ -1416,7 +1416,7 @@ module VoucherifySdk
1416
1416
  end
1417
1417
 
1418
1418
  # Get Campaign Reward Assignments
1419
- # Retrieve specific reward assignment.
1419
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve specific reward assignment.
1420
1420
  # @param campaign_id [String] 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.
1421
1421
  # @param assignment_id [String] Unique reward assignment ID.
1422
1422
  # @param [Hash] opts the optional parameters
@@ -1466,7 +1466,7 @@ module VoucherifySdk
1466
1466
  end
1467
1467
 
1468
1468
  # Get Campaign Reward Assignment
1469
- # Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments).
1469
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve specific reward assignment. <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments). </Note>
1470
1470
  # @param campaign_id [String] 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.
1471
1471
  # @param assignment_id [String] A unique reward assignment ID.
1472
1472
  # @param [Hash] opts the optional parameters
@@ -1477,7 +1477,7 @@ module VoucherifySdk
1477
1477
  end
1478
1478
 
1479
1479
  # Get Campaign Reward Assignment
1480
- # Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments).
1480
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve specific reward assignment. &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments). &lt;/Note&gt;
1481
1481
  # @param campaign_id [String] 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.
1482
1482
  # @param assignment_id [String] A unique reward assignment ID.
1483
1483
  # @param [Hash] opts the optional parameters
@@ -1527,7 +1527,7 @@ module VoucherifySdk
1527
1527
  end
1528
1528
 
1529
1529
  # Get Reward Details
1530
- # Get reward details in the context of a loyalty campaign and reward assignment ID.
1530
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Get reward details in the context of a loyalty campaign and reward assignment ID.
1531
1531
  # @param campaign_id [String] 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.
1532
1532
  # @param assignment_id [String] Unique reward assignment ID.
1533
1533
  # @param [Hash] opts the optional parameters
@@ -1538,7 +1538,7 @@ module VoucherifySdk
1538
1538
  end
1539
1539
 
1540
1540
  # Get Reward Details
1541
- # Get reward details in the context of a loyalty campaign and reward assignment ID.
1541
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Get reward details in the context of a loyalty campaign and reward assignment ID.
1542
1542
  # @param campaign_id [String] 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.
1543
1543
  # @param assignment_id [String] Unique reward assignment ID.
1544
1544
  # @param [Hash] opts the optional parameters
@@ -1588,7 +1588,7 @@ module VoucherifySdk
1588
1588
  end
1589
1589
 
1590
1590
  # List Campaign Pending Points
1591
- # Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
1591
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
1592
1592
  # @param campaign_id [String] Unique campaign ID.
1593
1593
  # @param [Hash] opts the optional parameters
1594
1594
  # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
@@ -1601,7 +1601,7 @@ module VoucherifySdk
1601
1601
  end
1602
1602
 
1603
1603
  # List Campaign Pending Points
1604
- # Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
1604
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. &lt;Tip&gt; &lt;Badge color green&gt;Configuring pending points&lt;/Badge&gt; Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). &lt;/Tip&gt;
1605
1605
  # @param campaign_id [String] Unique campaign ID.
1606
1606
  # @param [Hash] opts the optional parameters
1607
1607
  # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
@@ -1656,7 +1656,7 @@ module VoucherifySdk
1656
1656
  end
1657
1657
 
1658
1658
  # List Earning Rules
1659
- # Returns a list of all earning rules within a given campaign.
1659
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of all earning rules within a given campaign.
1660
1660
  # @param campaign_id [String] 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.
1661
1661
  # @param [Hash] opts the optional parameters
1662
1662
  # @option opts [Integer] :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.
@@ -1669,7 +1669,7 @@ module VoucherifySdk
1669
1669
  end
1670
1670
 
1671
1671
  # List Earning Rules
1672
- # Returns a list of all earning rules within a given campaign.
1672
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Returns a list of all earning rules within a given campaign.
1673
1673
  # @param campaign_id [String] 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.
1674
1674
  # @param [Hash] opts the optional parameters
1675
1675
  # @option opts [Integer] :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.
@@ -1724,7 +1724,7 @@ module VoucherifySdk
1724
1724
  end
1725
1725
 
1726
1726
  # List Loyalty Campaign Transactions
1727
- # Retrieves all transactions for the campaign with the given campaign ID or campaign name.
1727
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves all transactions for the campaign with the given campaign ID or campaign name.
1728
1728
  # @param campaign_id [String] You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
1729
1729
  # @param [Hash] opts the optional parameters
1730
1730
  # @option opts [Integer] :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.
@@ -1738,7 +1738,7 @@ module VoucherifySdk
1738
1738
  end
1739
1739
 
1740
1740
  # List Loyalty Campaign Transactions
1741
- # Retrieves all transactions for the campaign with the given campaign ID or campaign name.
1741
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieves all transactions for the campaign with the given campaign ID or campaign name.
1742
1742
  # @param campaign_id [String] You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
1743
1743
  # @param [Hash] opts the optional parameters
1744
1744
  # @option opts [Integer] :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.
@@ -1795,7 +1795,7 @@ module VoucherifySdk
1795
1795
  end
1796
1796
 
1797
1797
  # List Loyalty Card Transactions
1798
- # Retrieve transaction data related to point movements for a specific loyalty card.
1798
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve transaction data related to point movements for a specific loyalty card.
1799
1799
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
1800
1800
  # @param [Hash] opts the optional parameters
1801
1801
  # @option opts [Integer] :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.
@@ -1808,7 +1808,7 @@ module VoucherifySdk
1808
1808
  end
1809
1809
 
1810
1810
  # List Loyalty Card Transactions
1811
- # Retrieve transaction data related to point movements for a specific loyalty card.
1811
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve transaction data related to point movements for a specific loyalty card.
1812
1812
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
1813
1813
  # @param [Hash] opts the optional parameters
1814
1814
  # @option opts [Integer] :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.
@@ -1863,7 +1863,7 @@ module VoucherifySdk
1863
1863
  end
1864
1864
 
1865
1865
  # List Loyalty Card Transactions with campaign ID
1866
- # Retrieve transaction data related to point movements for a specific loyalty card.
1866
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve transaction data related to point movements for a specific loyalty card.
1867
1867
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
1868
1868
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
1869
1869
  # @param [Hash] opts the optional parameters
@@ -1877,7 +1877,7 @@ module VoucherifySdk
1877
1877
  end
1878
1878
 
1879
1879
  # List Loyalty Card Transactions with campaign ID
1880
- # Retrieve transaction data related to point movements for a specific loyalty card.
1880
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve transaction data related to point movements for a specific loyalty card.
1881
1881
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
1882
1882
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
1883
1883
  # @param [Hash] opts the optional parameters
@@ -1933,7 +1933,7 @@ module VoucherifySdk
1933
1933
  end
1934
1934
 
1935
1935
  # List Loyalty Campaigns
1936
- # Returns a list of your loyalty campaigns.
1936
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of your loyalty campaigns.
1937
1937
  # @param [Hash] opts the optional parameters
1938
1938
  # @option opts [Integer] :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.
1939
1939
  # @option opts [Integer] :page Which page of results to return. The lowest value is 1.
@@ -1945,7 +1945,7 @@ module VoucherifySdk
1945
1945
  end
1946
1946
 
1947
1947
  # List Loyalty Campaigns
1948
- # Returns a list of your loyalty campaigns.
1948
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Returns a list of your loyalty campaigns.
1949
1949
  # @param [Hash] opts the optional parameters
1950
1950
  # @option opts [Integer] :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.
1951
1951
  # @option opts [Integer] :page Which page of results to return. The lowest value is 1.
@@ -1999,7 +1999,7 @@ module VoucherifySdk
1999
1999
  end
2000
2000
 
2001
2001
  # List Loyalty Tier Earning Rules
2002
- # Retrieve available earning rules for a given tier and the calculation method for earning points.
2002
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve available earning rules for a given tier and the calculation method for earning points.
2003
2003
  # @param campaign_id [String] Unique campaign ID or name.
2004
2004
  # @param loyalty_tier_id [String] Unique loyalty tier ID.
2005
2005
  # @param [Hash] opts the optional parameters
@@ -2012,7 +2012,7 @@ module VoucherifySdk
2012
2012
  end
2013
2013
 
2014
2014
  # List Loyalty Tier Earning Rules
2015
- # Retrieve available earning rules for a given tier and the calculation method for earning points.
2015
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve available earning rules for a given tier and the calculation method for earning points.
2016
2016
  # @param campaign_id [String] Unique campaign ID or name.
2017
2017
  # @param loyalty_tier_id [String] Unique loyalty tier ID.
2018
2018
  # @param [Hash] opts the optional parameters
@@ -2066,7 +2066,7 @@ module VoucherifySdk
2066
2066
  end
2067
2067
 
2068
2068
  # List Loyalty Tier Rewards
2069
- # Get available rewards for a given tier.
2069
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Get available rewards for a given tier.
2070
2070
  # @param campaign_id [String] Unique campaign ID or name.
2071
2071
  # @param loyalty_tier_id [String] Unique loyalty tier ID.
2072
2072
  # @param [Hash] opts the optional parameters
@@ -2077,7 +2077,7 @@ module VoucherifySdk
2077
2077
  end
2078
2078
 
2079
2079
  # List Loyalty Tier Rewards
2080
- # Get available rewards for a given tier.
2080
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Get available rewards for a given tier.
2081
2081
  # @param campaign_id [String] Unique campaign ID or name.
2082
2082
  # @param loyalty_tier_id [String] Unique loyalty tier ID.
2083
2083
  # @param [Hash] opts the optional parameters
@@ -2127,7 +2127,7 @@ module VoucherifySdk
2127
2127
  end
2128
2128
 
2129
2129
  # List Loyalty Tiers
2130
- # Retrieve a list of loyalty tiers which were added to the loyalty program.
2130
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a list of loyalty tiers which were added to the loyalty program.
2131
2131
  # @param campaign_id [String] Unique loyalty campaign ID or name.
2132
2132
  # @param [Hash] opts the optional parameters
2133
2133
  # @option opts [Integer] :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.
@@ -2139,7 +2139,7 @@ module VoucherifySdk
2139
2139
  end
2140
2140
 
2141
2141
  # List Loyalty Tiers
2142
- # Retrieve a list of loyalty tiers which were added to the loyalty program.
2142
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve a list of loyalty tiers which were added to the loyalty program.
2143
2143
  # @param campaign_id [String] Unique loyalty campaign ID or name.
2144
2144
  # @param [Hash] opts the optional parameters
2145
2145
  # @option opts [Integer] :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.
@@ -2192,7 +2192,7 @@ module VoucherifySdk
2192
2192
  end
2193
2193
 
2194
2194
  # List Member Activity
2195
- # 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-activity-with-campaign-id). 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.
2195
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-activity-with-campaign-id). The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. </Note> Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2196
2196
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2197
2197
  # @param [Hash] opts the optional parameters
2198
2198
  # @option opts [Integer] :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.
@@ -2205,7 +2205,7 @@ module VoucherifySdk
2205
2205
  end
2206
2206
 
2207
2207
  # List Member Activity
2208
- # 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-activity-with-campaign-id). 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.
2208
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-activity-with-campaign-id). The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. &lt;/Note&gt; Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2209
2209
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2210
2210
  # @param [Hash] opts the optional parameters
2211
2211
  # @option opts [Integer] :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.
@@ -2260,7 +2260,7 @@ module VoucherifySdk
2260
2260
  end
2261
2261
 
2262
2262
  # List Member Activity with campaign ID
2263
- # Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2263
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2264
2264
  # @param campaign_id [String] Unique campaign ID.
2265
2265
  # @param member_id [String] A code that identifies the loyalty card.
2266
2266
  # @param [Hash] opts the optional parameters
@@ -2274,7 +2274,7 @@ module VoucherifySdk
2274
2274
  end
2275
2275
 
2276
2276
  # List Member Activity with campaign ID
2277
- # Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2277
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2278
2278
  # @param campaign_id [String] Unique campaign ID.
2279
2279
  # @param member_id [String] A code that identifies the loyalty card.
2280
2280
  # @param [Hash] opts the optional parameters
@@ -2330,7 +2330,7 @@ module VoucherifySdk
2330
2330
  end
2331
2331
 
2332
2332
  # List Member's Loyalty Tiers
2333
- # Retrieve member tiers using the loyalty card ID.
2333
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve member tiers using the loyalty card ID.
2334
2334
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2335
2335
  # @param [Hash] opts the optional parameters
2336
2336
  # @return [LoyaltiesMembersTiersListResponseBody]
@@ -2340,7 +2340,7 @@ module VoucherifySdk
2340
2340
  end
2341
2341
 
2342
2342
  # List Member&#39;s Loyalty Tiers
2343
- # Retrieve member tiers using the loyalty card ID.
2343
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Retrieve member tiers using the loyalty card ID.
2344
2344
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2345
2345
  # @param [Hash] opts the optional parameters
2346
2346
  # @return [Array<(LoyaltiesMembersTiersListResponseBody, Integer, Hash)>] LoyaltiesMembersTiersListResponseBody data, response status code and response headers
@@ -2389,7 +2389,7 @@ module VoucherifySdk
2389
2389
  end
2390
2390
 
2391
2391
  # List Member Pending Points
2392
- # 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
2392
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. </Note> Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
2393
2393
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2394
2394
  # @param [Hash] opts the optional parameters
2395
2395
  # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
@@ -2402,7 +2402,7 @@ module VoucherifySdk
2402
2402
  end
2403
2403
 
2404
2404
  # List Member Pending Points
2405
- # 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
2405
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. &lt;/Note&gt; Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. &lt;Tip&gt; &lt;Badge color green&gt;Configuring pending points&lt;/Badge&gt; Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). &lt;/Tip&gt;
2406
2406
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2407
2407
  # @param [Hash] opts the optional parameters
2408
2408
  # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
@@ -2457,7 +2457,7 @@ module VoucherifySdk
2457
2457
  end
2458
2458
 
2459
2459
  # List Member Pending Points with campaign ID
2460
- # Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
2460
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip>
2461
2461
  # @param campaign_id [String] Unique campaign ID.
2462
2462
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2463
2463
  # @param [Hash] opts the optional parameters
@@ -2471,7 +2471,7 @@ module VoucherifySdk
2471
2471
  end
2472
2472
 
2473
2473
  # List Member Pending Points with campaign ID
2474
- # Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
2474
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. &lt;Tip&gt; &lt;Badge color green&gt;Configuring pending points&lt;/Badge&gt; Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). &lt;/Tip&gt;
2475
2475
  # @param campaign_id [String] Unique campaign ID.
2476
2476
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2477
2477
  # @param [Hash] opts the optional parameters
@@ -2527,7 +2527,7 @@ module VoucherifySdk
2527
2527
  end
2528
2528
 
2529
2529
  # List Member Rewards
2530
- # 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.
2530
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> 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.
2531
2531
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2532
2532
  # @param [Hash] opts the optional parameters
2533
2533
  # @option opts [Boolean] :affordable_only 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.
@@ -2538,7 +2538,7 @@ module VoucherifySdk
2538
2538
  end
2539
2539
 
2540
2540
  # List Member Rewards
2541
- # 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.
2541
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; 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.
2542
2542
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2543
2543
  # @param [Hash] opts the optional parameters
2544
2544
  # @option opts [Boolean] :affordable_only 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.
@@ -2589,7 +2589,7 @@ module VoucherifySdk
2589
2589
  end
2590
2590
 
2591
2591
  # List Members
2592
- # Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
2592
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
2593
2593
  # @param campaign_id [String] Unique campaign ID of the loyalty program.
2594
2594
  # @param [Hash] opts the optional parameters
2595
2595
  # @option opts [Integer] :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.
@@ -2607,7 +2607,7 @@ module VoucherifySdk
2607
2607
  end
2608
2608
 
2609
2609
  # List Members
2610
- # Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
2610
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
2611
2611
  # @param campaign_id [String] Unique campaign ID of the loyalty program.
2612
2612
  # @param [Hash] opts the optional parameters
2613
2613
  # @option opts [Integer] :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.
@@ -2672,7 +2672,7 @@ module VoucherifySdk
2672
2672
  end
2673
2673
 
2674
2674
  # List Loyalty Card Point Expiration
2675
- # 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](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets.
2675
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> 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](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets.
2676
2676
  # @param campaign_id [String] 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.
2677
2677
  # @param member_id [String] Loyalty card code.
2678
2678
  # @param [Hash] opts the optional parameters
@@ -2685,7 +2685,7 @@ module VoucherifySdk
2685
2685
  end
2686
2686
 
2687
2687
  # List Loyalty Card Point Expiration
2688
- # 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](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets.
2688
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; 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](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets.
2689
2689
  # @param campaign_id [String] 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.
2690
2690
  # @param member_id [String] Loyalty card code.
2691
2691
  # @param [Hash] opts the optional parameters
@@ -2739,7 +2739,7 @@ module VoucherifySdk
2739
2739
  end
2740
2740
 
2741
2741
  # List Reward Assignments with campaign ID
2742
- # Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-campaign-rewards). The URL was re-designed to be more contextual to the type of data returned in the response.
2742
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns reward assignments from a given loyalty campaign. <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-campaign-rewards). The URL was re-designed to be more contextual to the type of data returned in the response. </Note>
2743
2743
  # @param campaign_id [String] 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.
2744
2744
  # @param [Hash] opts the optional parameters
2745
2745
  # @option opts [Integer] :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.
@@ -2752,7 +2752,7 @@ module VoucherifySdk
2752
2752
  end
2753
2753
 
2754
2754
  # List Reward Assignments with campaign ID
2755
- # Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-campaign-rewards). The URL was re-designed to be more contextual to the type of data returned in the response.
2755
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Returns reward assignments from a given loyalty campaign. &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-campaign-rewards). The URL was re-designed to be more contextual to the type of data returned in the response. &lt;/Note&gt;
2756
2756
  # @param campaign_id [String] 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.
2757
2757
  # @param [Hash] opts the optional parameters
2758
2758
  # @option opts [Integer] :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.
@@ -2807,7 +2807,7 @@ module VoucherifySdk
2807
2807
  end
2808
2808
 
2809
2809
  # List Campaign Rewards
2810
- # Returns active rewards from a given loyalty campaign.
2810
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns active rewards from a given loyalty campaign.
2811
2811
  # @param campaign_id [String] 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.
2812
2812
  # @param [Hash] opts the optional parameters
2813
2813
  # @option opts [Integer] :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.
@@ -2820,7 +2820,7 @@ module VoucherifySdk
2820
2820
  end
2821
2821
 
2822
2822
  # List Campaign Rewards
2823
- # Returns active rewards from a given loyalty campaign.
2823
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Returns active rewards from a given loyalty campaign.
2824
2824
  # @param campaign_id [String] 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.
2825
2825
  # @param [Hash] opts the optional parameters
2826
2826
  # @option opts [Integer] :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.
@@ -2875,7 +2875,7 @@ module VoucherifySdk
2875
2875
  end
2876
2876
 
2877
2877
  # Redeem Reward
2878
- # 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/redeem-reward-with-campaign-id). The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter.
2878
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/redeem-reward-with-campaign-id). The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter. </Note>
2879
2879
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2880
2880
  # @param [Hash] opts the optional parameters
2881
2881
  # @option opts [LoyaltiesMembersRedemptionRedeemRequestBody] :loyalties_members_redemption_redeem_request_body 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.
@@ -2886,7 +2886,7 @@ module VoucherifySdk
2886
2886
  end
2887
2887
 
2888
2888
  # Redeem Reward
2889
- # 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/redeem-reward-with-campaign-id). The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter.
2889
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to this [endpoint](/api-reference/loyalties/redeem-reward-with-campaign-id). The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter. &lt;/Note&gt;
2890
2890
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2891
2891
  # @param [Hash] opts the optional parameters
2892
2892
  # @option opts [LoyaltiesMembersRedemptionRedeemRequestBody] :loyalties_members_redemption_redeem_request_body 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.
@@ -2941,7 +2941,7 @@ module VoucherifySdk
2941
2941
  end
2942
2942
 
2943
2943
  # Redeem Reward with campaign ID
2944
- # 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.
2944
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> 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.
2945
2945
  # @param campaign_id [String] Unique campaign ID.
2946
2946
  # @param member_id [String] A code that identifies the loyalty card.
2947
2947
  # @param [Hash] opts the optional parameters
@@ -2953,7 +2953,7 @@ module VoucherifySdk
2953
2953
  end
2954
2954
 
2955
2955
  # Redeem Reward with campaign ID
2956
- # 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.
2956
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; 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.
2957
2957
  # @param campaign_id [String] Unique campaign ID.
2958
2958
  # @param member_id [String] A code that identifies the loyalty card.
2959
2959
  # @param [Hash] opts the optional parameters
@@ -3009,7 +3009,7 @@ module VoucherifySdk
3009
3009
  end
3010
3010
 
3011
3011
  # Transfer Loyalty Points
3012
- # Transfer points between different loyalty cards which have holders. Provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Transfer works only for loyalty cards that have holders, meaning the cards were published to customers. The transferred points expire according to the target program expiration rules.
3012
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Transfer points between different loyalty cards which have holders. Provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Transfer works only for loyalty cards that have holders, meaning the cards were published to customers. The transferred points expire according to the target program expiration rules.
3013
3013
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
3014
3014
  # @param member_id [String] A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
3015
3015
  # @param [Hash] opts the optional parameters
@@ -3021,7 +3021,7 @@ module VoucherifySdk
3021
3021
  end
3022
3022
 
3023
3023
  # Transfer Loyalty Points
3024
- # Transfer points between different loyalty cards which have holders. Provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Transfer works only for loyalty cards that have holders, meaning the cards were published to customers. The transferred points expire according to the target program expiration rules.
3024
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Transfer points between different loyalty cards which have holders. Provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Transfer works only for loyalty cards that have holders, meaning the cards were published to customers. The transferred points expire according to the target program expiration rules.
3025
3025
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
3026
3026
  # @param member_id [String] A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
3027
3027
  # @param [Hash] opts the optional parameters
@@ -3077,7 +3077,7 @@ module VoucherifySdk
3077
3077
  end
3078
3078
 
3079
3079
  # Update Earning Rule
3080
- # Update an earning rule definition.
3080
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Update an earning rule definition.
3081
3081
  # @param campaign_id [String] 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.
3082
3082
  # @param earning_rule_id [String] A unique earning rule ID.
3083
3083
  # @param [Hash] opts the optional parameters
@@ -3089,7 +3089,7 @@ module VoucherifySdk
3089
3089
  end
3090
3090
 
3091
3091
  # Update Earning Rule
3092
- # Update an earning rule definition.
3092
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Update an earning rule definition.
3093
3093
  # @param campaign_id [String] 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.
3094
3094
  # @param earning_rule_id [String] A unique earning rule ID.
3095
3095
  # @param [Hash] opts the optional parameters
@@ -3145,7 +3145,7 @@ module VoucherifySdk
3145
3145
  end
3146
3146
 
3147
3147
  # Adjust Loyalty Card Balance
3148
- # This method gives adds or removes balance to an existing loyalty card that is assigned to a holder. 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](/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id). 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.
3148
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method gives adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. <Warning> <Badge color yellow>Async Action</Badge> 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. </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id). 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. </Note>
3149
3149
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
3150
3150
  # @param [Hash] opts the optional parameters
3151
3151
  # @option opts [LoyaltiesMembersBalanceUpdateRequestBody] :loyalties_members_balance_update_request_body Specify the point adjustment along with the expiration mechanism.
@@ -3156,7 +3156,7 @@ module VoucherifySdk
3156
3156
  end
3157
3157
 
3158
3158
  # Adjust Loyalty Card Balance
3159
- # This method gives adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. &gt;🚧 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](/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id). 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.
3159
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; This method gives adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. &lt;Warning&gt; &lt;Badge color yellow&gt;Async Action&lt;/Badge&gt; 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. &lt;/Warning&gt; &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to this [endpoint](/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id). 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. &lt;/Note&gt;
3160
3160
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
3161
3161
  # @param [Hash] opts the optional parameters
3162
3162
  # @option opts [LoyaltiesMembersBalanceUpdateRequestBody] :loyalties_members_balance_update_request_body Specify the point adjustment along with the expiration mechanism.
@@ -3211,7 +3211,7 @@ module VoucherifySdk
3211
3211
  end
3212
3212
 
3213
3213
  # Adjust Loyalty Card Balance with campaign ID
3214
- # This method adds or removes balance to an existing loyalty card that is assigned to a holder. 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.
3214
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. <Warning> <Badge color yellow>Async Action</Badge> 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. </Warning>
3215
3215
  # @param campaign_id [String] Unique campaign ID.
3216
3216
  # @param member_id [String] A code that identifies the loyalty card.
3217
3217
  # @param [Hash] opts the optional parameters
@@ -3223,7 +3223,7 @@ module VoucherifySdk
3223
3223
  end
3224
3224
 
3225
3225
  # Adjust Loyalty Card Balance with campaign ID
3226
- # This method adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. &gt;🚧 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.
3226
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; This method adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. &lt;Warning&gt; &lt;Badge color yellow&gt;Async Action&lt;/Badge&gt; 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. &lt;/Warning&gt;
3227
3227
  # @param campaign_id [String] Unique campaign ID.
3228
3228
  # @param member_id [String] A code that identifies the loyalty card.
3229
3229
  # @param [Hash] opts the optional parameters
@@ -3279,7 +3279,7 @@ module VoucherifySdk
3279
3279
  end
3280
3280
 
3281
3281
  # Update Loyalty Campaign
3282
- # 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](/api-reference/loyalties/get-member) which have not been published or redeemed yet.
3282
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> 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](/api-reference/loyalties/get-member) which have not been published or redeemed yet.
3283
3283
  # @param campaign_id [String] 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.
3284
3284
  # @param [Hash] opts the optional parameters
3285
3285
  # @option opts [LoyaltiesUpdateCampaignRequestBody] :loyalties_update_campaign_request_body Specify the new values for the parameters that you would like to update for the given loyalty campaign.
@@ -3290,7 +3290,7 @@ module VoucherifySdk
3290
3290
  end
3291
3291
 
3292
3292
  # Update Loyalty Campaign
3293
- # 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](/api-reference/loyalties/get-member) which have not been published or redeemed yet.
3293
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; 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](/api-reference/loyalties/get-member) which have not been published or redeemed yet.
3294
3294
  # @param campaign_id [String] 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.
3295
3295
  # @param [Hash] opts the optional parameters
3296
3296
  # @option opts [LoyaltiesUpdateCampaignRequestBody] :loyalties_update_campaign_request_body Specify the new values for the parameters that you would like to update for the given loyalty campaign.
@@ -3345,7 +3345,7 @@ module VoucherifySdk
3345
3345
  end
3346
3346
 
3347
3347
  # Update Campaign Reward Assignment
3348
- # Updates rewards parameters, i.e. the points cost for the specific reward.
3348
+ # <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Updates rewards parameters, i.e. the points cost for the specific reward.
3349
3349
  # @param campaign_id [String] 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.
3350
3350
  # @param assignment_id [String] A unique reward assignment ID.
3351
3351
  # @param [Hash] opts the optional parameters
@@ -3357,7 +3357,7 @@ module VoucherifySdk
3357
3357
  end
3358
3358
 
3359
3359
  # Update Campaign Reward Assignment
3360
- # Updates rewards parameters, i.e. the points cost for the specific reward.
3360
+ # &lt;Warning&gt; &lt;Badge color yellow&gt;Legacy loyalty API&lt;/Badge&gt; This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). &lt;/Warning&gt; Updates rewards parameters, i.e. the points cost for the specific reward.
3361
3361
  # @param campaign_id [String] 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.
3362
3362
  # @param assignment_id [String] A unique reward assignment ID.
3363
3363
  # @param [Hash] opts the optional parameters