voucherify 8.0.3 → 8.1.0

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 (699) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +1 -1
  3. data/ENDPOINTS-COVERAGE.md +123 -111
  4. data/Gemfile.lock +19 -17
  5. data/README.md +218 -75
  6. data/VoucherifySdk.gemspec +1 -1
  7. data/__tests__/README.md +18 -0
  8. data/__tests__/lib/campaigns.rb +53 -1
  9. data/__tests__/lib/config.rb +21 -0
  10. data/__tests__/lib/loyalties.rb +2 -2
  11. data/__tests__/lib/utils.rb +27 -1
  12. data/__tests__/spec/02_campaigns_spec.rb +33 -2
  13. data/__tests__/spec/04_publications_spec.rb +16 -3
  14. data/__tests__/spec/07_vouchers_spec.rb +22 -3
  15. data/__tests__/spec/13_management_spec.rb +110 -0
  16. data/__tests__/spec/14_additional_properties_spec.rb +28 -0
  17. data/__tests__/spec/support/get_snapshot_without_uniq_keys.rb +1 -1
  18. data/docs/ApplicableTo.md +18 -2
  19. data/docs/ApplicableToOrderItemUnitsItem.md +2 -1
  20. data/docs/AsyncActionsApi.md +2 -2
  21. data/docs/AsyncActionsListResponseBody.md +1 -0
  22. data/docs/Bundle.md +11 -0
  23. data/docs/BundleIdentifiedItem.md +11 -0
  24. data/docs/BundleMissingItem.md +10 -0
  25. data/docs/Campaign.md +4 -4
  26. data/docs/CampaignBase.md +4 -4
  27. data/docs/CampaignLoyaltyCardExpirationRules.md +6 -4
  28. data/docs/CampaignsApi.md +209 -12
  29. data/docs/CampaignsCreateRequestBody.md +2 -2
  30. data/docs/CampaignsCreateResponseBody.md +4 -4
  31. data/docs/CampaignsGetResponseBody.md +4 -4
  32. data/docs/CampaignsImportVoucherItem.md +1 -1
  33. data/docs/CampaignsSummaryGetResponseBody.md +48 -0
  34. data/docs/CampaignsTransactionsExportCreateRequestBody.md +8 -0
  35. data/docs/CampaignsTransactionsExportCreateRequestBodyParameters.md +10 -0
  36. data/docs/CampaignsTransactionsExportCreateResponseBody.md +16 -0
  37. data/docs/CampaignsTransactionsExportCreateResponseBodyParameters.md +10 -0
  38. data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFilters.md +11 -0
  39. data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId.md +8 -0
  40. data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignIdConditions.md +8 -0
  41. data/docs/CampaignsTransactionsExportCreateResponseBodyResult.md +8 -0
  42. data/docs/CampaignsTransactionsListResponseBody.md +12 -0
  43. data/docs/CampaignsUpdateRequestBody.md +1 -1
  44. data/docs/CampaignsUpdateResponseBody.md +4 -4
  45. data/docs/CampaignsVouchersCreateCombinedResponseBodyGift.md +3 -2
  46. data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +5 -3
  47. data/docs/CampaignsVouchersCreateResponseBodyGift.md +3 -2
  48. data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +5 -3
  49. data/docs/CategoriesApi.md +1 -1
  50. data/docs/ClientQualificationsCheckEligibilityRequestBody.md +2 -1
  51. data/docs/ClientQualificationsCheckEligibilityRequestBodySession.md +8 -0
  52. data/docs/ClientRedemptionsRedeemRequestBodyOptions.md +1 -1
  53. data/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
  54. data/docs/ClientSideApi.md +2 -2
  55. data/docs/ClientValidationsValidateRequestBodyOptions.md +1 -1
  56. data/docs/ClientValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
  57. data/docs/ClientValidationsValidateResponseBody.md +1 -0
  58. data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
  59. data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
  60. data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
  61. data/docs/CustomerSummaryOrders.md +3 -3
  62. data/docs/CustomerSummaryRedemptionsGift.md +2 -2
  63. data/docs/CustomerWithSummaryLoyaltyReferralsAssets.md +2 -1
  64. data/docs/CustomersApi.md +10 -10
  65. data/docs/CustomersCreateResponseBodyAssets.md +2 -1
  66. data/docs/CustomersGetResponseBodyAssets.md +2 -1
  67. data/docs/CustomersUpdateResponseBodyAssets.md +2 -1
  68. data/docs/Discount.md +4 -4
  69. data/docs/DiscountUnitMultipleOneUnit.md +1 -1
  70. data/docs/EarningRule.md +1 -0
  71. data/docs/EarningRuleExpirationRules.md +13 -0
  72. data/docs/EarningRuleLoyalty.md +1 -0
  73. data/docs/EarningRuleLoyaltyCustomEventMetadata.md +1 -0
  74. data/docs/EarningRuleLoyaltyCustomerMetadata.md +1 -0
  75. data/docs/EarningRuleLoyaltyOrderAmount.md +1 -0
  76. data/docs/EarningRuleLoyaltyOrderItemsAmount.md +4 -2
  77. data/docs/EarningRuleLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  78. data/docs/EarningRuleLoyaltyOrderItemsQuantity.md +4 -2
  79. data/docs/EarningRuleLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  80. data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmount.md +4 -2
  81. data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  82. data/docs/EarningRuleLoyaltyOrderMetadata.md +1 -0
  83. data/docs/EarningRuleLoyaltyOrderTotalAmount.md +1 -0
  84. data/docs/ExportCampaignTransactionsFilters.md +10 -0
  85. data/docs/ExportParameters.md +1 -0
  86. data/docs/ExportsApi.md +3 -3
  87. data/docs/ExportsCreateRequestBodyParameters.md +1 -0
  88. data/docs/ExportsCreateResponseBodyParameters.md +1 -0
  89. data/docs/ExportsGetResponseBodyParameters.md +1 -0
  90. data/docs/Gift.md +3 -2
  91. data/docs/InapplicableTo.md +18 -2
  92. data/docs/InapplicableToOrderItemUnitsItem.md +2 -1
  93. data/docs/LoyaltiesApi.md +264 -67
  94. data/docs/LoyaltiesCreateCampaignRequestBody.md +2 -2
  95. data/docs/LoyaltiesCreateCampaignResponseBody.md +1 -1
  96. data/docs/LoyaltiesEarningRulesCreateRequestBodyItem.md +4 -2
  97. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md +1 -0
  98. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventMetadata.md +1 -0
  99. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerMetadata.md +1 -0
  100. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderAmount.md +1 -0
  101. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmount.md +4 -2
  102. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  103. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantity.md +4 -2
  104. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  105. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsSubtotalAmount.md +4 -2
  106. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderMetadata.md +1 -0
  107. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderTotalAmount.md +1 -0
  108. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  109. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemPendingPoints.md +9 -0
  110. data/docs/LoyaltiesEarningRulesCreateResponseBody.md +1 -0
  111. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md +1 -0
  112. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  113. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md +1 -0
  114. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount.md +1 -0
  115. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  116. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  117. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  118. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  119. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  120. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata.md +1 -0
  121. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  122. data/docs/LoyaltiesEarningRulesCreateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  123. data/docs/LoyaltiesEarningRulesDisableResponseBody.md +1 -0
  124. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyalty.md +1 -0
  125. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  126. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md +1 -0
  127. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderAmount.md +1 -0
  128. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  129. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  130. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  131. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  132. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  133. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderMetadata.md +1 -0
  134. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  135. data/docs/LoyaltiesEarningRulesDisableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  136. data/docs/LoyaltiesEarningRulesEnableResponseBody.md +1 -0
  137. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyalty.md +1 -0
  138. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  139. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerMetadata.md +1 -0
  140. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderAmount.md +1 -0
  141. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  142. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  143. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  144. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  145. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  146. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderMetadata.md +1 -0
  147. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  148. data/docs/LoyaltiesEarningRulesEnableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  149. data/docs/LoyaltiesEarningRulesGetResponseBody.md +1 -0
  150. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyalty.md +1 -0
  151. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  152. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerMetadata.md +1 -0
  153. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderAmount.md +1 -0
  154. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  155. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  156. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  157. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  158. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  159. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  160. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderMetadata.md +1 -0
  161. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  162. data/docs/LoyaltiesEarningRulesUpdateRequestBody.md +4 -2
  163. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyalty.md +1 -0
  164. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventMetadata.md +1 -0
  165. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerMetadata.md +1 -0
  166. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderAmount.md +1 -0
  167. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmount.md +4 -2
  168. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  169. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantity.md +4 -2
  170. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  171. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  172. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderMetadata.md +1 -0
  173. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderTotalAmount.md +1 -0
  174. data/docs/LoyaltiesEarningRulesUpdateRequestBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  175. data/docs/LoyaltiesEarningRulesUpdateRequestBodyPendingPoints.md +9 -0
  176. data/docs/LoyaltiesEarningRulesUpdateResponseBody.md +1 -0
  177. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyalty.md +1 -0
  178. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  179. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerMetadata.md +1 -0
  180. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderAmount.md +1 -0
  181. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  182. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  183. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  184. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  185. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  186. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderMetadata.md +1 -0
  187. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  188. data/docs/LoyaltiesEarningRulesUpdateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  189. data/docs/LoyaltiesGetCampaignResponseBody.md +1 -1
  190. data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +5 -3
  191. data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +5 -3
  192. data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +1 -1
  193. data/docs/LoyaltiesMembersPendingPointsBalanceRequestBody.md +8 -0
  194. data/docs/LoyaltiesMembersPendingPointsBalanceResponseBody.md +12 -0
  195. data/docs/LoyaltiesMembersPendingPointsBalanceResponseBodyRelatedObject.md +9 -0
  196. data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +1 -1
  197. data/docs/LoyaltiesMembersRedemptionRedeemRequestBody.md +1 -1
  198. data/docs/LoyaltiesMembersRedemptionRedeemResponseBody.md +1 -0
  199. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
  200. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodySession.md +8 -0
  201. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherGift.md +3 -2
  202. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +5 -3
  203. data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +5 -3
  204. data/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParameters.md +1 -1
  205. data/docs/LoyaltiesRewardAssignmentsRewardGetResponseBody.md +1 -1
  206. data/docs/LoyaltiesTransactionsExportCreateRequestBody.md +8 -0
  207. data/docs/LoyaltiesTransactionsExportCreateRequestBodyParameters.md +10 -0
  208. data/docs/LoyaltiesTransactionsListResponseBody.md +12 -0
  209. data/docs/LoyaltiesUpdateCampaignRequestBody.md +1 -1
  210. data/docs/LoyaltiesUpdateCampaignResponseBody.md +1 -1
  211. data/docs/LoyaltyCampaign.md +1 -1
  212. data/docs/LoyaltyCardTransaction.md +1 -1
  213. data/docs/LoyaltyCardTransactionDetailsBalance.md +1 -0
  214. data/docs/LoyaltyMemberLoyaltyCard.md +5 -3
  215. data/docs/LoyaltyPointsBucket.md +1 -1
  216. data/docs/LoyaltyTiersExpirationAll.md +1 -1
  217. data/docs/ManagementApi.md +22 -22
  218. data/docs/ManagementProjectsStackingRules.md +14 -8
  219. data/docs/ManagementProjectsStackingRulesCreateRequestBody.md +14 -8
  220. data/docs/ManagementProjectsStackingRulesCreateResponseBody.md +14 -8
  221. data/docs/ManagementProjectsStackingRulesGetResponseBody.md +14 -8
  222. data/docs/ManagementProjectsStackingRulesUpdateRequestBody.md +14 -8
  223. data/docs/ManagementProjectsStackingRulesUpdateResponseBody.md +14 -8
  224. data/docs/ManagementProjectsUsersInviteCreateRequestBody.md +1 -1
  225. data/docs/ManagementProjectsUsersUpdateRoleRequestBody.md +1 -1
  226. data/docs/MetadataSchemasApi.md +5 -5
  227. data/docs/Order.md +1 -1
  228. data/docs/OrderCalculatedItem.md +1 -1
  229. data/docs/OrderItem.md +1 -1
  230. data/docs/OrdersApi.md +3 -3
  231. data/docs/OrdersCreateRequestBody.md +1 -1
  232. data/docs/OrdersImportCreateRequestBodyItem.md +2 -2
  233. data/docs/OrdersUpdateRequestBody.md +1 -1
  234. data/docs/ParametersFiltersListCampaignTransactions.md +10 -0
  235. data/docs/ProductCollectionsCreateRequestBody.md +1 -1
  236. data/docs/ProductsApi.md +22 -22
  237. data/docs/ProductsSkusCreateRequestBody.md +1 -1
  238. data/docs/ProductsSkusUpdateRequestBody.md +1 -1
  239. data/docs/PromotionTierCampaign.md +1 -1
  240. data/docs/PromotionsTiersCreateResponseBodyCampaign.md +1 -1
  241. data/docs/PromotionsTiersDisableResponseBodyCampaign.md +1 -1
  242. data/docs/PromotionsTiersEnableResponseBodyCampaign.md +1 -1
  243. data/docs/PromotionsTiersGetResponseBodyCampaign.md +1 -1
  244. data/docs/PromotionsTiersUpdateResponseBodyCampaign.md +1 -1
  245. data/docs/PublicationsApi.md +7 -7
  246. data/docs/QualificationsApi.md +1 -1
  247. data/docs/QualificationsCheckEligibilityRequestBody.md +2 -1
  248. data/docs/QualificationsCheckEligibilityRequestBodySession.md +8 -0
  249. data/docs/QualificationsOption.md +1 -1
  250. data/docs/QualificationsRedeemable.md +1 -1
  251. data/docs/QualificationsRedeemableBase.md +1 -1
  252. data/docs/RedeemableGift.md +3 -2
  253. data/docs/RedeemableLoyaltyCard.md +2 -2
  254. data/docs/RedeemableResult.md +1 -0
  255. data/docs/RedeemableVoucherGift.md +3 -2
  256. data/docs/RedeemableVoucherLoyaltyCard.md +5 -3
  257. data/docs/Redemption.md +1 -0
  258. data/docs/RedemptionEntry.md +1 -0
  259. data/docs/RedemptionEntryPromotionTierCampaign.md +1 -1
  260. data/docs/RedemptionEntryRelatedRedemptionsRollbacksItem.md +1 -0
  261. data/docs/RedemptionEntrySession.md +8 -0
  262. data/docs/RedemptionEntryVoucherGift.md +3 -2
  263. data/docs/RedemptionEntryVoucherLoyaltyCard.md +5 -3
  264. data/docs/RedemptionRelatedRedemptionsRollbacksItem.md +1 -0
  265. data/docs/RedemptionRewardResultParametersCampaign.md +1 -1
  266. data/docs/RedemptionRollback.md +1 -1
  267. data/docs/RedemptionSession.md +8 -0
  268. data/docs/RedemptionVoucherGift.md +3 -2
  269. data/docs/RedemptionVoucherLoyaltyCard.md +5 -3
  270. data/docs/RedemptionsApi.md +3 -3
  271. data/docs/RedemptionsGetResponseBody.md +1 -0
  272. data/docs/RedemptionsGetResponseBodyPromotionTierCampaign.md +1 -1
  273. data/docs/RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
  274. data/docs/RedemptionsGetResponseBodySession.md +8 -0
  275. data/docs/RedemptionsGetResponseBodyVoucherGift.md +3 -2
  276. data/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +5 -3
  277. data/docs/RedemptionsListResponseBodyRedemptionsItem.md +1 -0
  278. data/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md +1 -1
  279. data/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem.md +1 -0
  280. data/docs/RedemptionsListResponseBodyRedemptionsItemSession.md +8 -0
  281. data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherGift.md +3 -2
  282. data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +5 -3
  283. data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -1
  284. data/docs/RedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
  285. data/docs/RedemptionsRollbackCreateResponseBody.md +1 -1
  286. data/docs/ReferralsApi.md +13 -13
  287. data/docs/Reward.md +1 -1
  288. data/docs/RewardsCreateRequestBody.md +1 -1
  289. data/docs/RewardsCreateRequestBodyParametersCampaign.md +1 -1
  290. data/docs/RewardsCreateResponseBody.md +1 -1
  291. data/docs/RewardsUpdateRequestBody.md +1 -1
  292. data/docs/RewardsUpdateRequestBodyParametersCampaign.md +1 -1
  293. data/docs/RewardsUpdateResponseBody.md +1 -1
  294. data/docs/SegmentsApi.md +2 -2
  295. data/docs/SegmentsCreateRequestBody.md +1 -1
  296. data/docs/SegmentsCreateResponseBody.md +4 -3
  297. data/docs/SegmentsGetResponseBody.md +4 -3
  298. data/docs/SimpleLoyaltyCard.md +5 -3
  299. data/docs/SimpleVoucherRedemption.md +1 -0
  300. data/docs/StackingRules.md +15 -11
  301. data/docs/TemplatesApi.md +7 -7
  302. data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +2 -2
  303. data/docs/TrashBinItem.md +1 -1
  304. data/docs/ValidationRule.md +1 -0
  305. data/docs/ValidationRulesApi.md +3 -3
  306. data/docs/ValidationRulesCreateRequestBody.md +1 -0
  307. data/docs/ValidationRulesCreateResponseBody.md +1 -0
  308. data/docs/ValidationRulesGetResponseBody.md +1 -0
  309. data/docs/ValidationRulesUpdateRequestBody.md +1 -0
  310. data/docs/ValidationRulesUpdateResponseBody.md +1 -0
  311. data/docs/ValidationsApi.md +1 -1
  312. data/docs/ValidationsRedeemableInapplicableResult.md +1 -0
  313. data/docs/ValidationsValidateRequestBodyOptions.md +1 -1
  314. data/docs/ValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
  315. data/docs/ValidationsValidateResponseBody.md +1 -0
  316. data/docs/ValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
  317. data/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
  318. data/docs/ValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
  319. data/docs/ValidityHours.md +1 -1
  320. data/docs/VoucherBalance.md +1 -0
  321. data/docs/VoucherGift.md +3 -2
  322. data/docs/VoucherLoyaltyCard.md +5 -3
  323. data/docs/VoucherTransaction.md +1 -1
  324. data/docs/VoucherTransactionDetailsBalance.md +1 -0
  325. data/docs/VoucherTransactionsExportParameters.md +1 -1
  326. data/docs/VoucherTransactionsFilters.md +1 -1
  327. data/docs/VoucherWithCategoriesGift.md +3 -2
  328. data/docs/VoucherWithCategoriesLoyaltyCard.md +5 -3
  329. data/docs/VouchersApi.md +16 -14
  330. data/docs/VouchersBalanceUpdateRequestBody.md +1 -1
  331. data/docs/VouchersBalanceUpdateResponseBody.md +2 -2
  332. data/docs/VouchersCreateRequestBody.md +2 -2
  333. data/docs/VouchersCreateResponseBodyGift.md +3 -2
  334. data/docs/VouchersCreateResponseBodyLoyaltyCard.md +5 -3
  335. data/docs/VouchersCreateWithSpecificCodeRequestBody.md +2 -2
  336. data/docs/VouchersDisableResponseBodyGift.md +3 -2
  337. data/docs/VouchersDisableResponseBodyLoyaltyCard.md +5 -3
  338. data/docs/VouchersEnableResponseBodyGift.md +3 -2
  339. data/docs/VouchersEnableResponseBodyLoyaltyCard.md +5 -3
  340. data/docs/VouchersGetResponseBodyGift.md +3 -2
  341. data/docs/VouchersGetResponseBodyLoyaltyCard.md +5 -3
  342. data/docs/VouchersImportCreateItemRequestBody.md +1 -1
  343. data/docs/VouchersTransactionsExportCreateResponseBodyResult.md +1 -1
  344. data/docs/VouchersUpdateRequestBody.md +2 -2
  345. data/docs/VouchersUpdateResponseBodyGift.md +3 -2
  346. data/docs/VouchersUpdateResponseBodyLoyaltyCard.md +5 -3
  347. data/lib/VoucherifySdk/api/async_actions_api.rb +4 -4
  348. data/lib/VoucherifySdk/api/campaigns_api.rb +220 -18
  349. data/lib/VoucherifySdk/api/categories_api.rb +2 -2
  350. data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
  351. data/lib/VoucherifySdk/api/customers_api.rb +14 -14
  352. data/lib/VoucherifySdk/api/exports_api.rb +6 -6
  353. data/lib/VoucherifySdk/api/loyalties_api.rb +277 -72
  354. data/lib/VoucherifySdk/api/management_api.rb +44 -44
  355. data/lib/VoucherifySdk/api/metadata_schemas_api.rb +6 -6
  356. data/lib/VoucherifySdk/api/orders_api.rb +6 -6
  357. data/lib/VoucherifySdk/api/products_api.rb +30 -30
  358. data/lib/VoucherifySdk/api/publications_api.rb +8 -8
  359. data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
  360. data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
  361. data/lib/VoucherifySdk/api/referrals_api.rb +14 -14
  362. data/lib/VoucherifySdk/api/segments_api.rb +4 -4
  363. data/lib/VoucherifySdk/api/templates_api.rb +14 -14
  364. data/lib/VoucherifySdk/api/validation_rules_api.rb +6 -6
  365. data/lib/VoucherifySdk/api/validations_api.rb +2 -2
  366. data/lib/VoucherifySdk/api/vouchers_api.rb +25 -22
  367. data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
  368. data/lib/VoucherifySdk/models/applicable_to.rb +192 -16
  369. data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +20 -5
  370. data/lib/VoucherifySdk/models/async_actions_list_response_body.rb +16 -5
  371. data/lib/VoucherifySdk/models/bundle.rb +267 -0
  372. data/lib/VoucherifySdk/models/bundle_identified_item.rb +296 -0
  373. data/lib/VoucherifySdk/models/bundle_missing_item.rb +274 -0
  374. data/lib/VoucherifySdk/models/campaign.rb +4 -4
  375. data/lib/VoucherifySdk/models/campaign_base.rb +4 -4
  376. data/lib/VoucherifySdk/models/campaign_loyalty_card_expiration_rules.rb +53 -10
  377. data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +3 -3
  378. data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +4 -4
  379. data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +4 -4
  380. data/lib/VoucherifySdk/models/campaigns_import_voucher_item.rb +1 -1
  381. data/lib/VoucherifySdk/models/campaigns_summary_get_response_body.rb +673 -0
  382. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body.rb +209 -0
  383. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body_parameters.rb +256 -0
  384. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body.rb +334 -0
  385. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters.rb +256 -0
  386. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters.rb +257 -0
  387. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id.rb +209 -0
  388. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id_conditions.rb +221 -0
  389. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_result.rb +210 -0
  390. data/lib/VoucherifySdk/models/campaigns_transactions_list_response_body.rb +286 -0
  391. data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +1 -1
  392. data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +4 -4
  393. data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_gift.rb +14 -3
  394. data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_loyalty_card.rb +30 -8
  395. data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_gift.rb +14 -3
  396. data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_loyalty_card.rb +30 -8
  397. data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb +12 -2
  398. data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body_session.rb +236 -0
  399. data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_options.rb +1 -1
  400. data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
  401. data/lib/VoucherifySdk/models/client_validations_validate_request_body.rb +1 -1
  402. data/lib/VoucherifySdk/models/client_validations_validate_request_body_options.rb +1 -1
  403. data/lib/VoucherifySdk/models/client_validations_validate_request_body_redeemables_item_gift.rb +1 -1
  404. data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +12 -1
  405. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result.rb +11 -1
  406. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_discount.rb +5 -2
  407. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
  408. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
  409. data/lib/VoucherifySdk/models/create_publication_campaign.rb +3 -3
  410. data/lib/VoucherifySdk/models/customer_summary_orders.rb +4 -3
  411. data/lib/VoucherifySdk/models/customer_summary_redemptions_gift.rb +2 -2
  412. data/lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals_assets.rb +18 -7
  413. data/lib/VoucherifySdk/models/customers_create_response_body_assets.rb +18 -7
  414. data/lib/VoucherifySdk/models/customers_get_response_body_assets.rb +18 -7
  415. data/lib/VoucherifySdk/models/customers_update_response_body_assets.rb +18 -7
  416. data/lib/VoucherifySdk/models/discount.rb +5 -2
  417. data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -1
  418. data/lib/VoucherifySdk/models/earning_rule.rb +10 -1
  419. data/lib/VoucherifySdk/models/earning_rule_expiration_rules.rb +313 -0
  420. data/lib/VoucherifySdk/models/earning_rule_loyalty.rb +12 -1
  421. data/lib/VoucherifySdk/models/earning_rule_loyalty_custom_event_metadata.rb +12 -1
  422. data/lib/VoucherifySdk/models/earning_rule_loyalty_customer_metadata.rb +12 -1
  423. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_amount.rb +16 -5
  424. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount.rb +31 -7
  425. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  426. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity.rb +31 -7
  427. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  428. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount.rb +31 -7
  429. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  430. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_metadata.rb +12 -1
  431. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_total_amount.rb +16 -5
  432. data/lib/VoucherifySdk/models/export_campaign_transactions_filters.rb +248 -0
  433. data/lib/VoucherifySdk/models/export_parameters.rb +16 -5
  434. data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +16 -5
  435. data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +16 -5
  436. data/lib/VoucherifySdk/models/exports_get_response_body.rb +0 -1
  437. data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +16 -5
  438. data/lib/VoucherifySdk/models/filter_conditions_date_time.rb +2 -2
  439. data/lib/VoucherifySdk/models/gift.rb +14 -3
  440. data/lib/VoucherifySdk/models/inapplicable_to.rb +192 -16
  441. data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +20 -5
  442. data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +3 -3
  443. data/lib/VoucherifySdk/models/loyalties_create_campaign_response_body.rb +1 -1
  444. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item.rb +22 -3
  445. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb +12 -1
  446. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_custom_event_metadata.rb +12 -1
  447. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_customer_metadata.rb +12 -1
  448. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_amount.rb +16 -5
  449. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount.rb +31 -7
  450. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  451. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity.rb +31 -7
  452. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  453. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_subtotal_amount.rb +31 -7
  454. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_metadata.rb +12 -1
  455. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_total_amount.rb +16 -5
  456. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  457. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_pending_points.rb +257 -0
  458. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body.rb +10 -1
  459. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty.rb +12 -1
  460. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_custom_event_metadata.rb +12 -1
  461. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_customer_metadata.rb +12 -1
  462. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_amount.rb +16 -5
  463. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount.rb +31 -7
  464. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  465. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity.rb +31 -7
  466. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  467. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  468. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_metadata.rb +12 -1
  469. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_total_amount.rb +16 -5
  470. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  471. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +10 -1
  472. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty.rb +12 -1
  473. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_custom_event_metadata.rb +12 -1
  474. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_customer_metadata.rb +12 -1
  475. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_amount.rb +16 -5
  476. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount.rb +31 -7
  477. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  478. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity.rb +31 -7
  479. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  480. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  481. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_metadata.rb +12 -1
  482. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_total_amount.rb +16 -5
  483. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  484. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +10 -1
  485. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty.rb +12 -1
  486. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_custom_event_metadata.rb +12 -1
  487. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_customer_metadata.rb +12 -1
  488. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_amount.rb +16 -5
  489. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount.rb +31 -7
  490. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  491. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity.rb +31 -7
  492. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  493. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  494. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_metadata.rb +12 -1
  495. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_total_amount.rb +16 -5
  496. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  497. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +10 -1
  498. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty.rb +12 -1
  499. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_custom_event_metadata.rb +12 -1
  500. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_customer_metadata.rb +12 -1
  501. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_amount.rb +16 -5
  502. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount.rb +31 -7
  503. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  504. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity.rb +31 -7
  505. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  506. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  507. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  508. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_metadata.rb +12 -1
  509. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_total_amount.rb +16 -5
  510. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body.rb +22 -3
  511. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty.rb +12 -1
  512. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_custom_event_metadata.rb +12 -1
  513. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_customer_metadata.rb +12 -1
  514. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_amount.rb +16 -5
  515. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount.rb +31 -7
  516. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  517. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity.rb +31 -7
  518. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  519. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_subtotal_amount.rb +31 -7
  520. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_metadata.rb +12 -1
  521. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_total_amount.rb +16 -5
  522. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  523. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_pending_points.rb +257 -0
  524. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body.rb +10 -1
  525. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty.rb +12 -1
  526. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_custom_event_metadata.rb +12 -1
  527. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_customer_metadata.rb +12 -1
  528. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_amount.rb +16 -5
  529. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount.rb +31 -7
  530. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  531. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity.rb +31 -7
  532. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  533. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  534. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_metadata.rb +12 -1
  535. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_total_amount.rb +16 -5
  536. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  537. data/lib/VoucherifySdk/models/loyalties_get_campaign_response_body.rb +1 -1
  538. data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +30 -8
  539. data/lib/VoucherifySdk/models/loyalties_members_create_response_body_publish.rb +1 -1
  540. data/lib/VoucherifySdk/models/loyalties_members_get_response_body_loyalty_card.rb +30 -8
  541. data/lib/VoucherifySdk/models/loyalties_members_get_response_body_publish.rb +1 -1
  542. data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body.rb +1 -1
  543. data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_request_body.rb +210 -0
  544. data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body.rb +283 -0
  545. data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body_related_object.rb +247 -0
  546. data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +1 -1
  547. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_request_body.rb +1 -1
  548. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body.rb +11 -1
  549. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_related_redemptions_rollbacks_item.rb +38 -4
  550. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_session.rb +210 -0
  551. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_gift.rb +14 -3
  552. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb +30 -8
  553. data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +30 -8
  554. data/lib/VoucherifySdk/models/loyalties_points_expiration_export_create_request_body_parameters.rb +1 -1
  555. data/lib/VoucherifySdk/models/loyalties_reward_assignments_reward_get_response_body.rb +1 -1
  556. data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body.rb +209 -0
  557. data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body_parameters.rb +256 -0
  558. data/lib/VoucherifySdk/models/loyalties_transactions_list_response_body.rb +286 -0
  559. data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +1 -1
  560. data/lib/VoucherifySdk/models/loyalties_update_campaign_response_body.rb +1 -1
  561. data/lib/VoucherifySdk/models/loyalty_campaign.rb +1 -1
  562. data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +1 -1
  563. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb +12 -1
  564. data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +30 -8
  565. data/lib/VoucherifySdk/models/loyalty_member_publish.rb +1 -1
  566. data/lib/VoucherifySdk/models/loyalty_points_bucket.rb +1 -1
  567. data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all.rb +1 -1
  568. data/lib/VoucherifySdk/models/management_projects_stacking_rules.rb +112 -9
  569. data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_request_body.rb +116 -13
  570. data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_response_body.rb +112 -9
  571. data/lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb +112 -9
  572. data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_request_body.rb +116 -13
  573. data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_response_body.rb +112 -9
  574. data/lib/VoucherifySdk/models/management_projects_users_invite_create_request_body.rb +1 -1
  575. data/lib/VoucherifySdk/models/management_projects_users_update_role_request_body.rb +1 -1
  576. data/lib/VoucherifySdk/models/order.rb +1 -1
  577. data/lib/VoucherifySdk/models/order_calculated_item.rb +1 -1
  578. data/lib/VoucherifySdk/models/order_item.rb +1 -1
  579. data/lib/VoucherifySdk/models/orders_create_request_body.rb +1 -1
  580. data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +15 -15
  581. data/lib/VoucherifySdk/models/orders_update_request_body.rb +1 -1
  582. data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status.rb +2 -1
  583. data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status_conditions.rb +1 -0
  584. data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_category_ids.rb +1 -1
  585. data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_is_referral_code.rb +1 -1
  586. data/lib/VoucherifySdk/models/parameters_filters_list_campaign_transactions.rb +247 -0
  587. data/lib/VoucherifySdk/models/product_collections_create_request_body.rb +2 -4
  588. data/lib/VoucherifySdk/models/products_skus_create_request_body.rb +1 -1
  589. data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +1 -1
  590. data/lib/VoucherifySdk/models/products_skus_list_response_body.rb +1 -1
  591. data/lib/VoucherifySdk/models/products_skus_update_request_body.rb +1 -1
  592. data/lib/VoucherifySdk/models/promotion_tier_campaign.rb +1 -1
  593. data/lib/VoucherifySdk/models/promotions_tiers_create_response_body_campaign.rb +1 -1
  594. data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body_campaign.rb +1 -1
  595. data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body_campaign.rb +1 -1
  596. data/lib/VoucherifySdk/models/promotions_tiers_get_response_body_campaign.rb +1 -1
  597. data/lib/VoucherifySdk/models/promotions_tiers_update_response_body_campaign.rb +1 -1
  598. data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body.rb +12 -2
  599. data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body_session.rb +236 -0
  600. data/lib/VoucherifySdk/models/qualifications_option.rb +1 -1
  601. data/lib/VoucherifySdk/models/qualifications_option_filters_resource_type_conditions.rb +1 -1
  602. data/lib/VoucherifySdk/models/qualifications_redeemable.rb +1 -1
  603. data/lib/VoucherifySdk/models/qualifications_redeemable_base.rb +1 -1
  604. data/lib/VoucherifySdk/models/redeemable_gift.rb +18 -7
  605. data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +2 -2
  606. data/lib/VoucherifySdk/models/redeemable_result.rb +10 -1
  607. data/lib/VoucherifySdk/models/redeemable_voucher_gift.rb +14 -3
  608. data/lib/VoucherifySdk/models/redeemable_voucher_loyalty_card.rb +30 -8
  609. data/lib/VoucherifySdk/models/redeemable_voucher_publish.rb +1 -1
  610. data/lib/VoucherifySdk/models/redemption.rb +11 -1
  611. data/lib/VoucherifySdk/models/redemption_entry.rb +11 -1
  612. data/lib/VoucherifySdk/models/redemption_entry_promotion_tier_campaign.rb +1 -1
  613. data/lib/VoucherifySdk/models/redemption_entry_related_redemptions_rollbacks_item.rb +38 -4
  614. data/lib/VoucherifySdk/models/redemption_entry_session.rb +210 -0
  615. data/lib/VoucherifySdk/models/redemption_entry_voucher_gift.rb +14 -3
  616. data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb +30 -8
  617. data/lib/VoucherifySdk/models/redemption_related_redemptions_rollbacks_item.rb +38 -4
  618. data/lib/VoucherifySdk/models/redemption_reward_result_parameters_campaign.rb +1 -1
  619. data/lib/VoucherifySdk/models/redemption_rollback.rb +15 -15
  620. data/lib/VoucherifySdk/models/redemption_session.rb +210 -0
  621. data/lib/VoucherifySdk/models/redemption_voucher_gift.rb +14 -3
  622. data/lib/VoucherifySdk/models/redemption_voucher_loyalty_card.rb +30 -8
  623. data/lib/VoucherifySdk/models/redemptions_get_response_body.rb +11 -1
  624. data/lib/VoucherifySdk/models/redemptions_get_response_body_promotion_tier_campaign.rb +1 -1
  625. data/lib/VoucherifySdk/models/redemptions_get_response_body_related_redemptions_rollbacks_item.rb +38 -4
  626. data/lib/VoucherifySdk/models/redemptions_get_response_body_session.rb +210 -0
  627. data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_gift.rb +14 -3
  628. data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_loyalty_card.rb +30 -8
  629. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item.rb +11 -1
  630. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_promotion_tier_campaign.rb +1 -1
  631. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions.rb +0 -1
  632. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions_rollbacks_item.rb +38 -4
  633. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_session.rb +210 -0
  634. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_gift.rb +14 -3
  635. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_loyalty_card.rb +30 -8
  636. data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +1 -1
  637. data/lib/VoucherifySdk/models/redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
  638. data/lib/VoucherifySdk/models/redemptions_rollback_create_response_body.rb +15 -15
  639. data/lib/VoucherifySdk/models/reward.rb +1 -1
  640. data/lib/VoucherifySdk/models/rewards_create_request_body.rb +1 -1
  641. data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_campaign.rb +1 -1
  642. data/lib/VoucherifySdk/models/rewards_create_response_body.rb +1 -1
  643. data/lib/VoucherifySdk/models/rewards_update_request_body.rb +1 -1
  644. data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_campaign.rb +1 -1
  645. data/lib/VoucherifySdk/models/rewards_update_response_body.rb +1 -1
  646. data/lib/VoucherifySdk/models/segments_create_request_body.rb +2 -2
  647. data/lib/VoucherifySdk/models/segments_create_response_body.rb +31 -20
  648. data/lib/VoucherifySdk/models/segments_get_response_body.rb +32 -21
  649. data/lib/VoucherifySdk/models/simple_loyalty_card.rb +30 -8
  650. data/lib/VoucherifySdk/models/simple_voucher_redemption.rb +16 -5
  651. data/lib/VoucherifySdk/models/stacking_rules.rb +72 -20
  652. data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +3 -3
  653. data/lib/VoucherifySdk/models/trash_bin_item.rb +1 -1
  654. data/lib/VoucherifySdk/models/validation_rule.rb +11 -1
  655. data/lib/VoucherifySdk/models/validation_rules_create_request_body.rb +11 -1
  656. data/lib/VoucherifySdk/models/validation_rules_create_response_body.rb +11 -1
  657. data/lib/VoucherifySdk/models/validation_rules_get_response_body.rb +11 -1
  658. data/lib/VoucherifySdk/models/validation_rules_update_request_body.rb +11 -1
  659. data/lib/VoucherifySdk/models/validation_rules_update_response_body.rb +11 -1
  660. data/lib/VoucherifySdk/models/validations_redeemable_inapplicable_result.rb +14 -5
  661. data/lib/VoucherifySdk/models/validations_validate_request_body.rb +1 -1
  662. data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +1 -1
  663. data/lib/VoucherifySdk/models/validations_validate_request_body_redeemables_item_gift.rb +1 -1
  664. data/lib/VoucherifySdk/models/validations_validate_response_body.rb +12 -1
  665. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result.rb +11 -1
  666. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_discount.rb +5 -2
  667. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
  668. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
  669. data/lib/VoucherifySdk/models/validity_hours.rb +1 -1
  670. data/lib/VoucherifySdk/models/validity_hours_daily_item.rb +1 -1
  671. data/lib/VoucherifySdk/models/voucher_balance.rb +12 -1
  672. data/lib/VoucherifySdk/models/voucher_gift.rb +14 -3
  673. data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +30 -8
  674. data/lib/VoucherifySdk/models/voucher_transaction.rb +1 -1
  675. data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +12 -1
  676. data/lib/VoucherifySdk/models/voucher_transactions_export_parameters.rb +1 -1
  677. data/lib/VoucherifySdk/models/voucher_transactions_filters.rb +1 -1
  678. data/lib/VoucherifySdk/models/voucher_with_categories_gift.rb +14 -3
  679. data/lib/VoucherifySdk/models/voucher_with_categories_loyalty_card.rb +30 -8
  680. data/lib/VoucherifySdk/models/vouchers_balance_update_request_body.rb +1 -1
  681. data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +2 -2
  682. data/lib/VoucherifySdk/models/vouchers_create_request_body.rb +2 -2
  683. data/lib/VoucherifySdk/models/vouchers_create_response_body_gift.rb +14 -3
  684. data/lib/VoucherifySdk/models/vouchers_create_response_body_loyalty_card.rb +30 -8
  685. data/lib/VoucherifySdk/models/vouchers_create_with_specific_code_request_body.rb +2 -2
  686. data/lib/VoucherifySdk/models/vouchers_disable_response_body_gift.rb +14 -3
  687. data/lib/VoucherifySdk/models/vouchers_disable_response_body_loyalty_card.rb +30 -8
  688. data/lib/VoucherifySdk/models/vouchers_enable_response_body_gift.rb +14 -3
  689. data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +30 -8
  690. data/lib/VoucherifySdk/models/vouchers_get_response_body_gift.rb +14 -3
  691. data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +30 -8
  692. data/lib/VoucherifySdk/models/vouchers_import_create_item_request_body.rb +1 -1
  693. data/lib/VoucherifySdk/models/vouchers_transactions_export_create_response_body_result.rb +1 -1
  694. data/lib/VoucherifySdk/models/vouchers_update_request_body.rb +2 -2
  695. data/lib/VoucherifySdk/models/vouchers_update_response_body_gift.rb +14 -3
  696. data/lib/VoucherifySdk/models/vouchers_update_response_body_loyalty_card.rb +30 -8
  697. data/lib/VoucherifySdk/version.rb +1 -1
  698. data/lib/VoucherifySdk.rb +55 -0
  699. metadata +147 -33
@@ -20,7 +20,7 @@ module VoucherifySdk
20
20
  @api_client = api_client
21
21
  end
22
22
  # Activate Member Pending Points
23
- # >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 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, without campaign ID), List campaign pending points. This **POST** method does not require a request body.
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).
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
- # >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 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, without campaign ID), List campaign pending points. This **POST** method does not require a request body.
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).
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,10 +81,10 @@ 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 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
+ # 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.
85
85
  # @param campaign_id [String] Unique campaign ID of the loyalty program.
86
86
  # @param [Hash] opts the optional parameters
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 endpoint.
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.
88
88
  # @return [LoyaltiesMembersCreateResponseBody]
89
89
  def add_member(campaign_id, opts = {})
90
90
  data, _status_code, _headers = add_member_with_http_info(campaign_id, opts)
@@ -92,10 +92,10 @@ 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 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
+ # 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.
96
96
  # @param campaign_id [String] Unique campaign ID of the loyalty program.
97
97
  # @param [Hash] opts the optional parameters
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 endpoint.
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.
99
99
  # @return [Array<(LoyaltiesMembersCreateResponseBody, Integer, Hash)>] LoyaltiesMembersCreateResponseBody data, response status code and response headers
100
100
  private def add_member_with_http_info(campaign_id, opts = {})
101
101
  if @api_client.config.debugging
@@ -146,8 +146,76 @@ module VoucherifySdk
146
146
  return data, status_code, headers
147
147
  end
148
148
 
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).
151
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
152
+ # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
153
+ # @param [Hash] opts the optional parameters
154
+ # @option opts [LoyaltiesMembersPendingPointsBalanceRequestBody] :loyalties_members_pending_points_balance_request_body Define the number of pending points to be added or subtracted.
155
+ # @return [LoyaltiesMembersPendingPointsBalanceResponseBody]
156
+ def adjust_member_pending_points(member_id, pending_points_id, opts = {})
157
+ data, _status_code, _headers = adjust_member_pending_points_with_http_info(member_id, pending_points_id, opts)
158
+ data
159
+ end
160
+
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).
163
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
164
+ # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
165
+ # @param [Hash] opts the optional parameters
166
+ # @option opts [LoyaltiesMembersPendingPointsBalanceRequestBody] :loyalties_members_pending_points_balance_request_body Define the number of pending points to be added or subtracted.
167
+ # @return [Array<(LoyaltiesMembersPendingPointsBalanceResponseBody, Integer, Hash)>] LoyaltiesMembersPendingPointsBalanceResponseBody data, response status code and response headers
168
+ private def adjust_member_pending_points_with_http_info(member_id, pending_points_id, opts = {})
169
+ if @api_client.config.debugging
170
+ @api_client.config.logger.debug 'Calling API: LoyaltiesApi.adjust_member_pending_points ...'
171
+ end
172
+ # resource path
173
+ local_var_path = '/v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance'.sub('{' + 'memberId' + '}', CGI.escape(member_id.to_s)).sub('{' + 'pendingPointsId' + '}', CGI.escape(pending_points_id.to_s))
174
+
175
+ # query parameters
176
+ query_params = opts[:query_params] || {}
177
+
178
+ # header parameters
179
+ header_params = opts[:header_params] || {}
180
+ # HTTP header 'Accept' (if needed)
181
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
182
+ # HTTP header 'Content-Type'
183
+ content_type = @api_client.select_header_content_type(['application/json'])
184
+ if !content_type.nil?
185
+ header_params['Content-Type'] = content_type
186
+ end
187
+
188
+ # form parameters
189
+ form_params = opts[:form_params] || {}
190
+
191
+ # http body (model)
192
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'loyalties_members_pending_points_balance_request_body'])
193
+
194
+ # return_type
195
+ return_type = opts[:debug_return_type] || 'LoyaltiesMembersPendingPointsBalanceResponseBody'
196
+
197
+ # auth_names
198
+ auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
199
+
200
+ new_options = opts.merge(
201
+ :operation => :"LoyaltiesApi.adjust_member_pending_points",
202
+ :header_params => header_params,
203
+ :query_params => query_params,
204
+ :form_params => form_params,
205
+ :body => post_body,
206
+ :auth_names => auth_names,
207
+ :return_type => return_type
208
+ )
209
+
210
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
211
+ if @api_client.config.debugging
212
+ @api_client.config.logger.debug "API called: LoyaltiesApi#adjust_member_pending_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
213
+ end
214
+ return data, status_code, headers
215
+ end
216
+
149
217
  # Cancel Member Pending Points
150
- # >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 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, without campaign ID), List campaign pending points. This **POST** method does not require a request body and it returns an empty, 204, response.
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).
151
219
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
152
220
  # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
153
221
  # @param [Hash] opts the optional parameters
@@ -158,7 +226,7 @@ module VoucherifySdk
158
226
  end
159
227
 
160
228
  # Cancel Member Pending Points
161
- # &gt;🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 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, without campaign ID), List campaign pending points. This **POST** method does not require a request body and it returns an empty, 204, response.
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).
162
230
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
163
231
  # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
164
232
  # @param [Hash] opts the optional parameters
@@ -206,7 +274,7 @@ module VoucherifySdk
206
274
  end
207
275
 
208
276
  # Create Earning Rule
209
- # Create earning rules for a loyalty campaign.
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.
210
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.
211
279
  # @param [Hash] opts the optional parameters
212
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
@@ -217,7 +285,7 @@ module VoucherifySdk
217
285
  end
218
286
 
219
287
  # Create Earning Rule
220
- # Create earning rules for a loyalty campaign.
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.
221
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.
222
290
  # @param [Hash] opts the optional parameters
223
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
@@ -338,7 +406,7 @@ module VoucherifySdk
338
406
  end
339
407
 
340
408
  # Create Loyalty Campaign
341
- # Creates a batch of loyalty cards aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. 📘 Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asyncronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the loyalty campaign object description.
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.
342
410
  # @param [Hash] opts the optional parameters
343
411
  # @option opts [LoyaltiesCreateCampaignRequestBody] :loyalties_create_campaign_request_body Specify the loyalty campaign details.
344
412
  # @return [LoyaltiesCreateCampaignResponseBody]
@@ -348,7 +416,7 @@ module VoucherifySdk
348
416
  end
349
417
 
350
418
  # Create Loyalty Campaign
351
- # Creates a batch of loyalty cards aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. 📘 Global uniqueness All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. 🚧 Asyncronous action! This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the loyalty campaign object description.
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.
352
420
  # @param [Hash] opts the optional parameters
353
421
  # @option opts [LoyaltiesCreateCampaignRequestBody] :loyalties_create_campaign_request_body Specify the loyalty campaign details.
354
422
  # @return [Array<(LoyaltiesCreateCampaignResponseBody, Integer, Hash)>] LoyaltiesCreateCampaignResponseBody data, response status code and response headers
@@ -402,7 +470,7 @@ module VoucherifySdk
402
470
  end
403
471
 
404
472
  # Export Loyalty Campaign Point Expiration
405
- # Schedule the generation of a points expiration CSV file for a particular campaign.
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.
406
474
  # @param campaign_id [String] Unique campaign ID or name.
407
475
  # @param [Hash] opts the optional parameters
408
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.
@@ -413,7 +481,7 @@ module VoucherifySdk
413
481
  end
414
482
 
415
483
  # Export Loyalty Campaign Point Expiration
416
- # Schedule the generation of a points expiration CSV file for a particular campaign.
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.
417
485
  # @param campaign_id [String] Unique campaign ID or name.
418
486
  # @param [Hash] opts the optional parameters
419
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.
@@ -467,7 +535,7 @@ module VoucherifySdk
467
535
  return data, status_code, headers
468
536
  end
469
537
 
470
- # Create Reward Assignment
538
+ # Create Loyalty Campaign Reward Assignment
471
539
  # Add rewards to a loyalty campaign.
472
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.
473
541
  # @param [Hash] opts the optional parameters
@@ -478,7 +546,7 @@ module VoucherifySdk
478
546
  data
479
547
  end
480
548
 
481
- # Create Reward Assignment
549
+ # Create Loyalty Campaign Reward Assignment
482
550
  # Add rewards to a loyalty campaign.
483
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.
484
552
  # @param [Hash] opts the optional parameters
@@ -593,7 +661,7 @@ module VoucherifySdk
593
661
  end
594
662
 
595
663
  # Delete Loyalty Campaign
596
- # 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.
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).
597
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.
598
666
  # @param [Hash] opts the optional parameters
599
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.
@@ -604,7 +672,7 @@ module VoucherifySdk
604
672
  end
605
673
 
606
674
  # Delete Loyalty Campaign
607
- # 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.
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).
608
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.
609
677
  # @param [Hash] opts the optional parameters
610
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.
@@ -654,7 +722,7 @@ module VoucherifySdk
654
722
  return data, status_code, headers
655
723
  end
656
724
 
657
- # Delete Reward Assignment
725
+ # Delete Campaign Reward Assignment
658
726
  # This method deletes a reward assignment for a particular loyalty campaign.
659
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.
660
728
  # @param assignment_id [String] A unique reward assignment ID.
@@ -665,7 +733,7 @@ module VoucherifySdk
665
733
  nil
666
734
  end
667
735
 
668
- # Delete Reward Assignment
736
+ # Delete Campaign Reward Assignment
669
737
  # This method deletes a reward assignment for a particular loyalty campaign.
670
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.
671
739
  # @param assignment_id [String] A unique reward assignment ID.
@@ -835,6 +903,72 @@ module VoucherifySdk
835
903
  return data, status_code, headers
836
904
  end
837
905
 
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.
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
+ # @param [Hash] opts the optional parameters
910
+ # @option opts [LoyaltiesTransactionsExportCreateRequestBody] :loyalties_transactions_export_create_request_body Specify the parameters for the transaction export.
911
+ # @return [CampaignsTransactionsExportCreateResponseBody]
912
+ def export_loyalty_campaign_transactions(campaign_id, opts = {})
913
+ data, _status_code, _headers = export_loyalty_campaign_transactions_with_http_info(campaign_id, opts)
914
+ data
915
+ end
916
+
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.
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
+ # @param [Hash] opts the optional parameters
921
+ # @option opts [LoyaltiesTransactionsExportCreateRequestBody] :loyalties_transactions_export_create_request_body Specify the parameters for the transaction export.
922
+ # @return [Array<(CampaignsTransactionsExportCreateResponseBody, Integer, Hash)>] CampaignsTransactionsExportCreateResponseBody data, response status code and response headers
923
+ private def export_loyalty_campaign_transactions_with_http_info(campaign_id, opts = {})
924
+ if @api_client.config.debugging
925
+ @api_client.config.logger.debug 'Calling API: LoyaltiesApi.export_loyalty_campaign_transactions ...'
926
+ end
927
+ # resource path
928
+ local_var_path = '/v1/loyalties/{campaignId}/transactions/export'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
929
+
930
+ # query parameters
931
+ query_params = opts[:query_params] || {}
932
+
933
+ # header parameters
934
+ header_params = opts[:header_params] || {}
935
+ # HTTP header 'Accept' (if needed)
936
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
937
+ # HTTP header 'Content-Type'
938
+ content_type = @api_client.select_header_content_type(['application/json'])
939
+ if !content_type.nil?
940
+ header_params['Content-Type'] = content_type
941
+ end
942
+
943
+ # form parameters
944
+ form_params = opts[:form_params] || {}
945
+
946
+ # http body (model)
947
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'loyalties_transactions_export_create_request_body'])
948
+
949
+ # return_type
950
+ return_type = opts[:debug_return_type] || 'CampaignsTransactionsExportCreateResponseBody'
951
+
952
+ # auth_names
953
+ auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
954
+
955
+ new_options = opts.merge(
956
+ :operation => :"LoyaltiesApi.export_loyalty_campaign_transactions",
957
+ :header_params => header_params,
958
+ :query_params => query_params,
959
+ :form_params => form_params,
960
+ :body => post_body,
961
+ :auth_names => auth_names,
962
+ :return_type => return_type
963
+ )
964
+
965
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
966
+ if @api_client.config.debugging
967
+ @api_client.config.logger.debug "API called: LoyaltiesApi#export_loyalty_campaign_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
968
+ end
969
+ return data, status_code, headers
970
+ end
971
+
838
972
  # Export Loyalty Card Transactions
839
973
  # Export transactions that are associated with point movements on a loyalty card.
840
974
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
@@ -901,7 +1035,7 @@ module VoucherifySdk
901
1035
  return data, status_code, headers
902
1036
  end
903
1037
 
904
- # Export Loyalty Card Transactions
1038
+ # Export Loyalty Card Transactions with campaign ID
905
1039
  # Export transactions that are associated with point movements on a loyalty card.
906
1040
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
907
1041
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
@@ -913,7 +1047,7 @@ module VoucherifySdk
913
1047
  data
914
1048
  end
915
1049
 
916
- # Export Loyalty Card Transactions
1050
+ # Export Loyalty Card Transactions with campaign ID
917
1051
  # Export transactions that are associated with point movements on a loyalty card.
918
1052
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
919
1053
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
@@ -1151,7 +1285,7 @@ module VoucherifySdk
1151
1285
  end
1152
1286
 
1153
1287
  # Get Member
1154
- # Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter.
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.
1155
1289
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
1156
1290
  # @param [Hash] opts the optional parameters
1157
1291
  # @return [LoyaltiesMembersGetResponseBody]
@@ -1161,7 +1295,7 @@ module VoucherifySdk
1161
1295
  end
1162
1296
 
1163
1297
  # Get Member
1164
- # Retrieve loyalty card with the given member ID (i.e. voucher code). 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter.
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.
1165
1299
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
1166
1300
  # @param [Hash] opts the optional parameters
1167
1301
  # @return [Array<(LoyaltiesMembersGetResponseBody, Integer, Hash)>] LoyaltiesMembersGetResponseBody data, response status code and response headers
@@ -1209,7 +1343,7 @@ module VoucherifySdk
1209
1343
  return data, status_code, headers
1210
1344
  end
1211
1345
 
1212
- # Get Member
1346
+ # Get Member with campaign ID
1213
1347
  # Retrieves the loyalty card with the given member ID (i.e. voucher code).
1214
1348
  # @param campaign_id [String] Unique campaign ID.
1215
1349
  # @param member_id [String] Unique code that identifies the loyalty card.
@@ -1220,7 +1354,7 @@ module VoucherifySdk
1220
1354
  data
1221
1355
  end
1222
1356
 
1223
- # Get Member
1357
+ # Get Member with campaign ID
1224
1358
  # Retrieves the loyalty card with the given member ID (i.e. voucher code).
1225
1359
  # @param campaign_id [String] Unique campaign ID.
1226
1360
  # @param member_id [String] Unique code that identifies the loyalty card.
@@ -1270,7 +1404,7 @@ module VoucherifySdk
1270
1404
  return data, status_code, headers
1271
1405
  end
1272
1406
 
1273
- # Get Reward Assignment
1407
+ # Get Campaign Reward Assignments
1274
1408
  # Retrieve specific reward assignment.
1275
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.
1276
1410
  # @param assignment_id [String] Unique reward assignment ID.
@@ -1281,7 +1415,7 @@ module VoucherifySdk
1281
1415
  data
1282
1416
  end
1283
1417
 
1284
- # Get Reward Assignment
1418
+ # Get Campaign Reward Assignments
1285
1419
  # Retrieve specific reward assignment.
1286
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.
1287
1421
  # @param assignment_id [String] Unique reward assignment ID.
@@ -1331,8 +1465,8 @@ module VoucherifySdk
1331
1465
  return data, status_code, headers
1332
1466
  end
1333
1467
 
1334
- # Get Reward Assignment
1335
- # Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this endpoint.
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).
1336
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.
1337
1471
  # @param assignment_id [String] A unique reward assignment ID.
1338
1472
  # @param [Hash] opts the optional parameters
@@ -1342,8 +1476,8 @@ module VoucherifySdk
1342
1476
  data
1343
1477
  end
1344
1478
 
1345
- # Get Reward Assignment
1346
- # Retrieve specific reward assignment. 📘 Alternative endpoint This endpoint is an alternative to this endpoint.
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).
1347
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.
1348
1482
  # @param assignment_id [String] A unique reward assignment ID.
1349
1483
  # @param [Hash] opts the optional parameters
@@ -1454,7 +1588,7 @@ module VoucherifySdk
1454
1588
  end
1455
1589
 
1456
1590
  # List Campaign Pending Points
1457
- # >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 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.
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).
1458
1592
  # @param campaign_id [String] Unique campaign ID.
1459
1593
  # @param [Hash] opts the optional parameters
1460
1594
  # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
@@ -1467,7 +1601,7 @@ module VoucherifySdk
1467
1601
  end
1468
1602
 
1469
1603
  # List Campaign Pending Points
1470
- # &gt;🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 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.
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).
1471
1605
  # @param campaign_id [String] Unique campaign ID.
1472
1606
  # @param [Hash] opts the optional parameters
1473
1607
  # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
@@ -1589,6 +1723,77 @@ module VoucherifySdk
1589
1723
  return data, status_code, headers
1590
1724
  end
1591
1725
 
1726
+ # List Loyalty Campaign Transactions
1727
+ # Retrieves all transactions for the campaign with the given campaign ID or campaign name.
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
+ # @param [Hash] opts the optional parameters
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.
1731
+ # @option opts [ParameterOrderListTransactions] :order Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
1732
+ # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.
1733
+ # @option opts [ParametersFiltersListCampaignTransactions] :filters Filters for listing responses. The id filter denotes the unique transaction identifier.
1734
+ # @return [LoyaltiesTransactionsListResponseBody]
1735
+ def list_loyalty_campaign_transactions(campaign_id, opts = {})
1736
+ data, _status_code, _headers = list_loyalty_campaign_transactions_with_http_info(campaign_id, opts)
1737
+ data
1738
+ end
1739
+
1740
+ # List Loyalty Campaign Transactions
1741
+ # Retrieves all transactions for the campaign with the given campaign ID or campaign name.
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
+ # @param [Hash] opts the optional parameters
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.
1745
+ # @option opts [ParameterOrderListTransactions] :order Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
1746
+ # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.
1747
+ # @option opts [ParametersFiltersListCampaignTransactions] :filters Filters for listing responses. The id filter denotes the unique transaction identifier.
1748
+ # @return [Array<(LoyaltiesTransactionsListResponseBody, Integer, Hash)>] LoyaltiesTransactionsListResponseBody data, response status code and response headers
1749
+ private def list_loyalty_campaign_transactions_with_http_info(campaign_id, opts = {})
1750
+ if @api_client.config.debugging
1751
+ @api_client.config.logger.debug 'Calling API: LoyaltiesApi.list_loyalty_campaign_transactions ...'
1752
+ end
1753
+ # resource path
1754
+ local_var_path = '/v1/loyalties/{campaignId}/transactions'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
1755
+
1756
+ # query parameters
1757
+ query_params = opts[:query_params] || {}
1758
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1759
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1760
+ query_params[:'starting_after_id'] = opts[:'starting_after_id'] if !opts[:'starting_after_id'].nil?
1761
+ query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?
1762
+
1763
+ # header parameters
1764
+ header_params = opts[:header_params] || {}
1765
+ # HTTP header 'Accept' (if needed)
1766
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1767
+
1768
+ # form parameters
1769
+ form_params = opts[:form_params] || {}
1770
+
1771
+ # http body (model)
1772
+ post_body = opts[:debug_body]
1773
+
1774
+ # return_type
1775
+ return_type = opts[:debug_return_type] || 'LoyaltiesTransactionsListResponseBody'
1776
+
1777
+ # auth_names
1778
+ auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
1779
+
1780
+ new_options = opts.merge(
1781
+ :operation => :"LoyaltiesApi.list_loyalty_campaign_transactions",
1782
+ :header_params => header_params,
1783
+ :query_params => query_params,
1784
+ :form_params => form_params,
1785
+ :body => post_body,
1786
+ :auth_names => auth_names,
1787
+ :return_type => return_type
1788
+ )
1789
+
1790
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1791
+ if @api_client.config.debugging
1792
+ @api_client.config.logger.debug "API called: LoyaltiesApi#list_loyalty_campaign_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1793
+ end
1794
+ return data, status_code, headers
1795
+ end
1796
+
1592
1797
  # List Loyalty Card Transactions
1593
1798
  # Retrieve transaction data related to point movements for a specific loyalty card.
1594
1799
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
@@ -1657,7 +1862,7 @@ module VoucherifySdk
1657
1862
  return data, status_code, headers
1658
1863
  end
1659
1864
 
1660
- # List Loyalty Card Transactions
1865
+ # List Loyalty Card Transactions with campaign ID
1661
1866
  # Retrieve transaction data related to point movements for a specific loyalty card.
1662
1867
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
1663
1868
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
@@ -1671,7 +1876,7 @@ module VoucherifySdk
1671
1876
  data
1672
1877
  end
1673
1878
 
1674
- # List Loyalty Card Transactions
1879
+ # List Loyalty Card Transactions with campaign ID
1675
1880
  # Retrieve transaction data related to point movements for a specific loyalty card.
1676
1881
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
1677
1882
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
@@ -1987,7 +2192,7 @@ module VoucherifySdk
1987
2192
  end
1988
2193
 
1989
2194
  # List Member Activity
1990
- # 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
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.
1991
2196
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
1992
2197
  # @param [Hash] opts the optional parameters
1993
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.
@@ -2000,7 +2205,7 @@ module VoucherifySdk
2000
2205
  end
2001
2206
 
2002
2207
  # List Member Activity
2003
- # 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
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.
2004
2209
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2005
2210
  # @param [Hash] opts the optional parameters
2006
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.
@@ -2054,7 +2259,7 @@ module VoucherifySdk
2054
2259
  return data, status_code, headers
2055
2260
  end
2056
2261
 
2057
- # List Member Activity
2262
+ # List Member Activity with campaign ID
2058
2263
  # Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2059
2264
  # @param campaign_id [String] Unique campaign ID.
2060
2265
  # @param member_id [String] A code that identifies the loyalty card.
@@ -2068,7 +2273,7 @@ module VoucherifySdk
2068
2273
  data
2069
2274
  end
2070
2275
 
2071
- # List Member Activity
2276
+ # List Member Activity with campaign ID
2072
2277
  # Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
2073
2278
  # @param campaign_id [String] Unique campaign ID.
2074
2279
  # @param member_id [String] A code that identifies the loyalty card.
@@ -2184,7 +2389,7 @@ module VoucherifySdk
2184
2389
  end
2185
2390
 
2186
2391
  # List Member Pending Points
2187
- # >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. 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.
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).
2188
2393
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2189
2394
  # @param [Hash] opts the optional parameters
2190
2395
  # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
@@ -2197,7 +2402,7 @@ module VoucherifySdk
2197
2402
  end
2198
2403
 
2199
2404
  # List Member Pending Points
2200
- # &gt;🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. 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.
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).
2201
2406
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2202
2407
  # @param [Hash] opts the optional parameters
2203
2408
  # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
@@ -2251,8 +2456,8 @@ module VoucherifySdk
2251
2456
  return data, status_code, headers
2252
2457
  end
2253
2458
 
2254
- # List Member Pending Points
2255
- # >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 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.
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).
2256
2461
  # @param campaign_id [String] Unique campaign ID.
2257
2462
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2258
2463
  # @param [Hash] opts the optional parameters
@@ -2265,8 +2470,8 @@ module VoucherifySdk
2265
2470
  data
2266
2471
  end
2267
2472
 
2268
- # List Member Pending Points
2269
- # &gt;🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 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.
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).
2270
2475
  # @param campaign_id [String] Unique campaign ID.
2271
2476
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2272
2477
  # @param [Hash] opts the optional parameters
@@ -2467,7 +2672,7 @@ module VoucherifySdk
2467
2672
  end
2468
2673
 
2469
2674
  # List Loyalty Card Point Expiration
2470
- # Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.
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.
2471
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.
2472
2677
  # @param member_id [String] Loyalty card code.
2473
2678
  # @param [Hash] opts the optional parameters
@@ -2480,7 +2685,7 @@ module VoucherifySdk
2480
2685
  end
2481
2686
 
2482
2687
  # List Loyalty Card Point Expiration
2483
- # Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.
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.
2484
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.
2485
2690
  # @param member_id [String] Loyalty card code.
2486
2691
  # @param [Hash] opts the optional parameters
@@ -2533,8 +2738,8 @@ module VoucherifySdk
2533
2738
  return data, status_code, headers
2534
2739
  end
2535
2740
 
2536
- # List Reward Assignments
2537
- # Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to be more contextual to the type of data returned in the response.
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.
2538
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.
2539
2744
  # @param [Hash] opts the optional parameters
2540
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.
@@ -2546,8 +2751,8 @@ module VoucherifySdk
2546
2751
  data
2547
2752
  end
2548
2753
 
2549
- # List Reward Assignments
2550
- # Returns reward assignments from a given loyalty campaign. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to be more contextual to the type of data returned in the response.
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.
2551
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.
2552
2757
  # @param [Hash] opts the optional parameters
2553
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.
@@ -2601,7 +2806,7 @@ module VoucherifySdk
2601
2806
  return data, status_code, headers
2602
2807
  end
2603
2808
 
2604
- # List Reward Assignments
2809
+ # List Campaign Rewards
2605
2810
  # Returns active rewards from a given loyalty campaign.
2606
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.
2607
2812
  # @param [Hash] opts the optional parameters
@@ -2614,7 +2819,7 @@ module VoucherifySdk
2614
2819
  data
2615
2820
  end
2616
2821
 
2617
- # List Reward Assignments
2822
+ # List Campaign Rewards
2618
2823
  # Returns active rewards from a given loyalty campaign.
2619
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.
2620
2825
  # @param [Hash] opts the optional parameters
@@ -2670,7 +2875,7 @@ module VoucherifySdk
2670
2875
  end
2671
2876
 
2672
2877
  # Redeem Reward
2673
- # 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter.
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.
2674
2879
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2675
2880
  # @param [Hash] opts the optional parameters
2676
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.
@@ -2681,7 +2886,7 @@ module VoucherifySdk
2681
2886
  end
2682
2887
 
2683
2888
  # Redeem Reward
2684
- # 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter.
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.
2685
2890
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2686
2891
  # @param [Hash] opts the optional parameters
2687
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.
@@ -2735,7 +2940,7 @@ module VoucherifySdk
2735
2940
  return data, status_code, headers
2736
2941
  end
2737
2942
 
2738
- # Redeem Reward
2943
+ # Redeem Reward with campaign ID
2739
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.
2740
2945
  # @param campaign_id [String] Unique campaign ID.
2741
2946
  # @param member_id [String] A code that identifies the loyalty card.
@@ -2747,7 +2952,7 @@ module VoucherifySdk
2747
2952
  data
2748
2953
  end
2749
2954
 
2750
- # Redeem Reward
2955
+ # Redeem Reward with campaign ID
2751
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.
2752
2957
  # @param campaign_id [String] Unique campaign ID.
2753
2958
  # @param member_id [String] A code that identifies the loyalty card.
@@ -2804,7 +3009,7 @@ module VoucherifySdk
2804
3009
  end
2805
3010
 
2806
3011
  # Transfer Loyalty Points
2807
- # Transfer points between different loyalty cards. You need to provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters in the URL. In the request body, you provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.
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.
2808
3013
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
2809
3014
  # @param member_id [String] A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
2810
3015
  # @param [Hash] opts the optional parameters
@@ -2816,7 +3021,7 @@ module VoucherifySdk
2816
3021
  end
2817
3022
 
2818
3023
  # Transfer Loyalty Points
2819
- # Transfer points between different loyalty cards. You need to provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters in the URL. In the request body, you provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.
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.
2820
3025
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
2821
3026
  # @param member_id [String] A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
2822
3027
  # @param [Hash] opts the optional parameters
@@ -2939,8 +3144,8 @@ module VoucherifySdk
2939
3144
  return data, status_code, headers
2940
3145
  end
2941
3146
 
2942
- # Add or Remove Loyalty Card Balance
2943
- # This method gives adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter.
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.
2944
3149
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2945
3150
  # @param [Hash] opts the optional parameters
2946
3151
  # @option opts [LoyaltiesMembersBalanceUpdateRequestBody] :loyalties_members_balance_update_request_body Specify the point adjustment along with the expiration mechanism.
@@ -2950,8 +3155,8 @@ module VoucherifySdk
2950
3155
  data
2951
3156
  end
2952
3157
 
2953
- # Add or Remove Loyalty Card Balance
2954
- # This method gives adds or removes balance to an existing loyalty card. 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. 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.
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.
2955
3160
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2956
3161
  # @param [Hash] opts the optional parameters
2957
3162
  # @option opts [LoyaltiesMembersBalanceUpdateRequestBody] :loyalties_members_balance_update_request_body Specify the point adjustment along with the expiration mechanism.
@@ -3005,8 +3210,8 @@ module VoucherifySdk
3005
3210
  return data, status_code, headers
3006
3211
  end
3007
3212
 
3008
- # Add or Remove Loyalty Card Balance
3009
- # This method adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. >🚧 Async Action This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls.
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.
3010
3215
  # @param campaign_id [String] Unique campaign ID.
3011
3216
  # @param member_id [String] A code that identifies the loyalty card.
3012
3217
  # @param [Hash] opts the optional parameters
@@ -3017,8 +3222,8 @@ module VoucherifySdk
3017
3222
  data
3018
3223
  end
3019
3224
 
3020
- # Add or Remove Loyalty Card Balance
3021
- # This method adds or removes balance to an existing loyalty card. 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.
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.
3022
3227
  # @param campaign_id [String] Unique campaign ID.
3023
3228
  # @param member_id [String] A code that identifies the loyalty card.
3024
3229
  # @param [Hash] opts the optional parameters
@@ -3074,7 +3279,7 @@ module VoucherifySdk
3074
3279
  end
3075
3280
 
3076
3281
  # Update Loyalty Campaign
3077
- # Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the loyalty cards which have not been published or redeemed yet.
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.
3078
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.
3079
3284
  # @param [Hash] opts the optional parameters
3080
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.
@@ -3085,7 +3290,7 @@ module VoucherifySdk
3085
3290
  end
3086
3291
 
3087
3292
  # Update Loyalty Campaign
3088
- # Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the loyalty cards which have not been published or redeemed yet.
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.
3089
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.
3090
3295
  # @param [Hash] opts the optional parameters
3091
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.
@@ -3139,7 +3344,7 @@ module VoucherifySdk
3139
3344
  return data, status_code, headers
3140
3345
  end
3141
3346
 
3142
- # Update Reward Assignment
3347
+ # Update Campaign Reward Assignment
3143
3348
  # Updates rewards parameters, i.e. the points cost for the specific reward.
3144
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.
3145
3350
  # @param assignment_id [String] A unique reward assignment ID.
@@ -3151,7 +3356,7 @@ module VoucherifySdk
3151
3356
  data
3152
3357
  end
3153
3358
 
3154
- # Update Reward Assignment
3359
+ # Update Campaign Reward Assignment
3155
3360
  # Updates rewards parameters, i.e. the points cost for the specific reward.
3156
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.
3157
3362
  # @param assignment_id [String] A unique reward assignment ID.