voucherify 8.0.2 → 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 (799) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +1 -1
  3. data/ENDPOINTS-COVERAGE.md +123 -106
  4. data/Gemfile.lock +20 -16
  5. data/README.md +260 -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/12_validation_rules_spec.rb +1 -15
  16. data/__tests__/spec/13_management_spec.rb +110 -0
  17. data/__tests__/spec/14_additional_properties_spec.rb +28 -0
  18. data/__tests__/spec/support/get_snapshot_without_uniq_keys.rb +1 -1
  19. data/docs/AccessSettings.md +9 -0
  20. data/docs/AccessSettingsAssign.md +10 -0
  21. data/docs/AccessSettingsUnassign.md +10 -0
  22. data/docs/ApplicableTo.md +21 -4
  23. data/docs/ApplicableToOrderItemUnitsItem.md +10 -0
  24. data/docs/ApplicationDetailsItem.md +14 -0
  25. data/docs/AreaStoreCampaignAssignment.md +1 -0
  26. data/docs/AsyncActionsApi.md +2 -2
  27. data/docs/AsyncActionsListResponseBody.md +1 -0
  28. data/docs/BinApi.md +4 -4
  29. data/docs/Bundle.md +11 -0
  30. data/docs/BundleIdentifiedItem.md +11 -0
  31. data/docs/BundleMissingItem.md +10 -0
  32. data/docs/Campaign.md +5 -5
  33. data/docs/CampaignBase.md +5 -4
  34. data/docs/CampaignLoyaltyCardExpirationRules.md +6 -4
  35. data/docs/CampaignsApi.md +209 -12
  36. data/docs/CampaignsCreateRequestBody.md +3 -2
  37. data/docs/CampaignsCreateResponseBody.md +5 -5
  38. data/docs/CampaignsGetResponseBody.md +5 -5
  39. data/docs/CampaignsImportVoucherItem.md +1 -1
  40. data/docs/CampaignsSummaryGetResponseBody.md +48 -0
  41. data/docs/CampaignsTransactionsExportCreateRequestBody.md +8 -0
  42. data/docs/CampaignsTransactionsExportCreateRequestBodyParameters.md +10 -0
  43. data/docs/CampaignsTransactionsExportCreateResponseBody.md +16 -0
  44. data/docs/CampaignsTransactionsExportCreateResponseBodyParameters.md +10 -0
  45. data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFilters.md +11 -0
  46. data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignId.md +8 -0
  47. data/docs/CampaignsTransactionsExportCreateResponseBodyParametersFiltersCampaignIdConditions.md +8 -0
  48. data/docs/CampaignsTransactionsExportCreateResponseBodyResult.md +8 -0
  49. data/docs/CampaignsTransactionsListResponseBody.md +12 -0
  50. data/docs/CampaignsUpdateRequestBody.md +2 -1
  51. data/docs/CampaignsUpdateResponseBody.md +5 -5
  52. data/docs/CampaignsVouchersCreateCombinedResponseBodyGift.md +3 -2
  53. data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +5 -2
  54. data/docs/CampaignsVouchersCreateResponseBodyGift.md +3 -2
  55. data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +5 -2
  56. data/docs/CategoriesApi.md +1 -1
  57. data/docs/ClientQualificationsCheckEligibilityRequestBody.md +2 -1
  58. data/docs/ClientQualificationsCheckEligibilityRequestBodySession.md +8 -0
  59. data/docs/ClientRedemptionsRedeemRequestBodyOptions.md +1 -1
  60. data/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
  61. data/docs/ClientSideApi.md +2 -2
  62. data/docs/ClientValidationsValidateRequestBodyOptions.md +1 -1
  63. data/docs/ClientValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
  64. data/docs/ClientValidationsValidateResponseBody.md +1 -0
  65. data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
  66. data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
  67. data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
  68. data/docs/CustomerLoyalty.md +1 -1
  69. data/docs/CustomerSummaryOrders.md +3 -3
  70. data/docs/CustomerSummaryRedemptionsGift.md +2 -2
  71. data/docs/CustomerWithSummaryLoyaltyReferralsAssets.md +2 -1
  72. data/docs/CustomersApi.md +10 -10
  73. data/docs/CustomersCreateResponseBodyAssets.md +2 -1
  74. data/docs/CustomersGetResponseBodyAssets.md +2 -1
  75. data/docs/CustomersUpdateResponseBodyAssets.md +2 -1
  76. data/docs/Discount.md +4 -4
  77. data/docs/DiscountUnitMultipleOneUnit.md +1 -1
  78. data/docs/EarningRule.md +2 -0
  79. data/docs/EarningRuleExpirationRules.md +13 -0
  80. data/docs/EarningRuleLoyalty.md +1 -0
  81. data/docs/EarningRuleLoyaltyCustomEventMetadata.md +1 -0
  82. data/docs/EarningRuleLoyaltyCustomerMetadata.md +1 -0
  83. data/docs/EarningRuleLoyaltyOrderAmount.md +1 -0
  84. data/docs/EarningRuleLoyaltyOrderItemsAmount.md +4 -2
  85. data/docs/EarningRuleLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  86. data/docs/EarningRuleLoyaltyOrderItemsQuantity.md +4 -2
  87. data/docs/EarningRuleLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  88. data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmount.md +4 -2
  89. data/docs/EarningRuleLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  90. data/docs/EarningRuleLoyaltyOrderMetadata.md +1 -0
  91. data/docs/EarningRuleLoyaltyOrderTotalAmount.md +1 -0
  92. data/docs/EarningRulePendingPoints.md +9 -0
  93. data/docs/EventSource.md +10 -0
  94. data/docs/EventSourceApiKey.md +9 -0
  95. data/docs/EventSourceUser.md +8 -0
  96. data/docs/ExportCampaignTransactionsFilters.md +10 -0
  97. data/docs/ExportParameters.md +1 -0
  98. data/docs/ExportsApi.md +3 -3
  99. data/docs/ExportsCreateRequestBodyParameters.md +1 -0
  100. data/docs/ExportsCreateResponseBodyParameters.md +1 -0
  101. data/docs/ExportsGetResponseBodyParameters.md +1 -0
  102. data/docs/Gift.md +3 -2
  103. data/docs/InapplicableTo.md +21 -4
  104. data/docs/InapplicableToOrderItemUnitsItem.md +10 -0
  105. data/docs/LoyaltiesApi.md +590 -69
  106. data/docs/LoyaltiesCreateCampaignRequestBody.md +3 -2
  107. data/docs/LoyaltiesCreateCampaignResponseBody.md +1 -1
  108. data/docs/LoyaltiesEarningRulesCreateRequestBodyItem.md +4 -2
  109. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyalty.md +1 -0
  110. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventMetadata.md +1 -0
  111. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerMetadata.md +1 -0
  112. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderAmount.md +1 -0
  113. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmount.md +4 -2
  114. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  115. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantity.md +4 -2
  116. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  117. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsSubtotalAmount.md +4 -2
  118. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderMetadata.md +1 -0
  119. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderTotalAmount.md +1 -0
  120. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  121. data/docs/LoyaltiesEarningRulesCreateRequestBodyItemPendingPoints.md +9 -0
  122. data/docs/LoyaltiesEarningRulesCreateResponseBody.md +2 -0
  123. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyalty.md +1 -0
  124. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  125. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerMetadata.md +1 -0
  126. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderAmount.md +1 -0
  127. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  128. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  129. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  130. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  131. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  132. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderMetadata.md +1 -0
  133. data/docs/LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  134. data/docs/LoyaltiesEarningRulesCreateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  135. data/docs/LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md +9 -0
  136. data/docs/LoyaltiesEarningRulesDisableResponseBody.md +2 -0
  137. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyalty.md +1 -0
  138. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  139. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerMetadata.md +1 -0
  140. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderAmount.md +1 -0
  141. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  142. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  143. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  144. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  145. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  146. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderMetadata.md +1 -0
  147. data/docs/LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  148. data/docs/LoyaltiesEarningRulesDisableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  149. data/docs/LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md +9 -0
  150. data/docs/LoyaltiesEarningRulesEnableResponseBody.md +2 -0
  151. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyalty.md +1 -0
  152. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  153. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerMetadata.md +1 -0
  154. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderAmount.md +1 -0
  155. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  156. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  157. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  158. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  159. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  160. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderMetadata.md +1 -0
  161. data/docs/LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  162. data/docs/LoyaltiesEarningRulesEnableResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  163. data/docs/LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md +9 -0
  164. data/docs/LoyaltiesEarningRulesGetResponseBody.md +2 -0
  165. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyalty.md +1 -0
  166. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  167. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerMetadata.md +1 -0
  168. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderAmount.md +1 -0
  169. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  170. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  171. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  172. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  173. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  174. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  175. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderMetadata.md +1 -0
  176. data/docs/LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  177. data/docs/LoyaltiesEarningRulesGetResponseBodyPendingPoints.md +9 -0
  178. data/docs/LoyaltiesEarningRulesUpdateRequestBody.md +4 -2
  179. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyalty.md +1 -0
  180. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventMetadata.md +1 -0
  181. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerMetadata.md +1 -0
  182. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderAmount.md +1 -0
  183. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmount.md +4 -2
  184. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  185. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantity.md +4 -2
  186. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  187. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  188. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderMetadata.md +1 -0
  189. data/docs/LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderTotalAmount.md +1 -0
  190. data/docs/LoyaltiesEarningRulesUpdateRequestBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  191. data/docs/LoyaltiesEarningRulesUpdateRequestBodyPendingPoints.md +9 -0
  192. data/docs/LoyaltiesEarningRulesUpdateResponseBody.md +2 -0
  193. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyalty.md +1 -0
  194. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventMetadata.md +1 -0
  195. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerMetadata.md +1 -0
  196. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderAmount.md +1 -0
  197. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmount.md +4 -2
  198. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsAmountApplicableToItem.md +9 -0
  199. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantity.md +4 -2
  200. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsQuantityApplicableToItem.md +9 -0
  201. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsSubtotalAmount.md +4 -2
  202. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderMetadata.md +1 -0
  203. data/docs/LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderTotalAmount.md +1 -0
  204. data/docs/LoyaltiesEarningRulesUpdateResponseBodyOrderItemsSubtotalAmountApplicableToItem.md +9 -0
  205. data/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md +9 -0
  206. data/docs/LoyaltiesGetCampaignResponseBody.md +1 -1
  207. data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +5 -2
  208. data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +5 -2
  209. data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +14 -0
  210. data/docs/LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md +9 -0
  211. data/docs/LoyaltiesMembersPendingPointsBalanceRequestBody.md +8 -0
  212. data/docs/LoyaltiesMembersPendingPointsBalanceResponseBody.md +12 -0
  213. data/docs/LoyaltiesMembersPendingPointsBalanceResponseBodyRelatedObject.md +9 -0
  214. data/docs/LoyaltiesMembersPendingPointsListResponseBody.md +12 -0
  215. data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +1 -1
  216. data/docs/LoyaltiesMembersRedemptionRedeemRequestBody.md +1 -1
  217. data/docs/LoyaltiesMembersRedemptionRedeemResponseBody.md +1 -0
  218. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
  219. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodySession.md +8 -0
  220. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherGift.md +3 -2
  221. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +5 -2
  222. data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +5 -2
  223. data/docs/LoyaltiesPendingPointsListResponseBody.md +12 -0
  224. data/docs/LoyaltiesPointsExpirationExportCreateRequestBodyParameters.md +1 -1
  225. data/docs/LoyaltiesRewardAssignmentsRewardGetResponseBody.md +1 -1
  226. data/docs/LoyaltiesTransactionsExportCreateRequestBody.md +8 -0
  227. data/docs/LoyaltiesTransactionsExportCreateRequestBodyParameters.md +10 -0
  228. data/docs/LoyaltiesTransactionsListResponseBody.md +12 -0
  229. data/docs/LoyaltiesUpdateCampaignRequestBody.md +2 -1
  230. data/docs/LoyaltiesUpdateCampaignResponseBody.md +1 -1
  231. data/docs/LoyaltyCampaign.md +1 -1
  232. data/docs/LoyaltyCardTransaction.md +1 -1
  233. data/docs/LoyaltyCardTransactionDetails.md +2 -0
  234. data/docs/LoyaltyCardTransactionDetailsBalance.md +1 -0
  235. data/docs/LoyaltyCardTransactionDetailsEarningRule.md +1 -1
  236. data/docs/LoyaltyCardTransactionDetailsHolderLoyaltyTier.md +9 -0
  237. data/docs/LoyaltyCardTransactionDetailsLoyaltyTier.md +2 -2
  238. data/docs/LoyaltyMemberLoyaltyCard.md +5 -2
  239. data/docs/LoyaltyPendingPoints.md +17 -0
  240. data/docs/LoyaltyPendingPointsDetails.md +12 -0
  241. data/docs/LoyaltyPendingPointsDetailsEarningRule.md +9 -0
  242. data/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md +8 -0
  243. data/docs/LoyaltyPendingPointsDetailsEvent.md +14 -0
  244. data/docs/LoyaltyPendingPointsDetailsHolderLoyaltyTier.md +9 -0
  245. data/docs/LoyaltyPendingPointsDetailsLoyaltyTier.md +9 -0
  246. data/docs/LoyaltyPendingPointsDetailsOrder.md +9 -0
  247. data/docs/LoyaltyPointsBucket.md +1 -1
  248. data/docs/LoyaltyTierExpiration.md +1 -1
  249. data/docs/LoyaltyTiersExpirationAll.md +1 -1
  250. data/docs/ManagementApi.md +22 -22
  251. data/docs/ManagementProjectsStackingRules.md +14 -8
  252. data/docs/ManagementProjectsStackingRulesCreateRequestBody.md +14 -8
  253. data/docs/ManagementProjectsStackingRulesCreateResponseBody.md +14 -8
  254. data/docs/ManagementProjectsStackingRulesGetResponseBody.md +14 -8
  255. data/docs/ManagementProjectsStackingRulesUpdateRequestBody.md +14 -8
  256. data/docs/ManagementProjectsStackingRulesUpdateResponseBody.md +14 -8
  257. data/docs/ManagementProjectsUsersInviteCreateRequestBody.md +1 -1
  258. data/docs/ManagementProjectsUsersUpdateRoleRequestBody.md +1 -1
  259. data/docs/MetadataSchemasApi.md +5 -5
  260. data/docs/Order.md +3 -3
  261. data/docs/OrderCalculated.md +11 -11
  262. data/docs/OrderCalculatedItem.md +2 -1
  263. data/docs/OrderItem.md +1 -1
  264. data/docs/OrderRedemptionsEntry.md +1 -1
  265. data/docs/OrdersApi.md +3 -3
  266. data/docs/OrdersCreateRequestBody.md +3 -3
  267. data/docs/OrdersCreateResponseBody.md +11 -11
  268. data/docs/OrdersGetResponseBody.md +11 -11
  269. data/docs/OrdersImportCreateRequestBodyItem.md +4 -4
  270. data/docs/OrdersUpdateRequestBody.md +3 -3
  271. data/docs/OrdersUpdateResponseBody.md +11 -11
  272. data/docs/ParameterOrderListPendingPoints.md +7 -0
  273. data/docs/ParametersFiltersListCampaignTransactions.md +10 -0
  274. data/docs/ProductCollectionsCreateRequestBody.md +1 -1
  275. data/docs/ProductsApi.md +22 -22
  276. data/docs/ProductsSkusCreateRequestBody.md +1 -1
  277. data/docs/ProductsSkusUpdateRequestBody.md +1 -1
  278. data/docs/PromotionTierCampaign.md +1 -1
  279. data/docs/PromotionsTiersCreateResponseBodyCampaign.md +1 -1
  280. data/docs/PromotionsTiersDisableResponseBodyCampaign.md +1 -1
  281. data/docs/PromotionsTiersEnableResponseBodyCampaign.md +1 -1
  282. data/docs/PromotionsTiersGetResponseBodyCampaign.md +1 -1
  283. data/docs/PromotionsTiersUpdateResponseBodyCampaign.md +1 -1
  284. data/docs/PublicationsApi.md +7 -7
  285. data/docs/QualificationsApi.md +1 -1
  286. data/docs/QualificationsCheckEligibilityRequestBody.md +2 -1
  287. data/docs/QualificationsCheckEligibilityRequestBodySession.md +8 -0
  288. data/docs/QualificationsOption.md +1 -1
  289. data/docs/QualificationsRedeemable.md +1 -1
  290. data/docs/QualificationsRedeemableBase.md +1 -1
  291. data/docs/RedeemableGift.md +3 -2
  292. data/docs/RedeemableLoyaltyCard.md +2 -2
  293. data/docs/RedeemableResult.md +1 -0
  294. data/docs/RedeemableVoucherGift.md +3 -2
  295. data/docs/RedeemableVoucherLoyaltyCard.md +5 -2
  296. data/docs/Redemption.md +1 -0
  297. data/docs/RedemptionEntry.md +1 -0
  298. data/docs/RedemptionEntryOrder.md +11 -11
  299. data/docs/RedemptionEntryPromotionTierCampaign.md +1 -1
  300. data/docs/RedemptionEntryRelatedRedemptionsRollbacksItem.md +1 -0
  301. data/docs/RedemptionEntrySession.md +8 -0
  302. data/docs/RedemptionEntryVoucherGift.md +3 -2
  303. data/docs/RedemptionEntryVoucherLoyaltyCard.md +5 -2
  304. data/docs/RedemptionRelatedRedemptionsRollbacksItem.md +1 -0
  305. data/docs/RedemptionRewardResultParametersCampaign.md +1 -1
  306. data/docs/RedemptionRollback.md +1 -1
  307. data/docs/RedemptionSession.md +8 -0
  308. data/docs/RedemptionVoucherGift.md +3 -2
  309. data/docs/RedemptionVoucherLoyaltyCard.md +5 -2
  310. data/docs/RedemptionsApi.md +3 -3
  311. data/docs/RedemptionsGetResponseBody.md +1 -0
  312. data/docs/RedemptionsGetResponseBodyOrder.md +11 -11
  313. data/docs/RedemptionsGetResponseBodyPromotionTierCampaign.md +1 -1
  314. data/docs/RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem.md +1 -0
  315. data/docs/RedemptionsGetResponseBodySession.md +8 -0
  316. data/docs/RedemptionsGetResponseBodyVoucherGift.md +3 -2
  317. data/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +5 -2
  318. data/docs/RedemptionsListResponseBodyRedemptionsItem.md +1 -0
  319. data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +11 -11
  320. data/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md +1 -1
  321. data/docs/RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem.md +1 -0
  322. data/docs/RedemptionsListResponseBodyRedemptionsItemSession.md +8 -0
  323. data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherGift.md +3 -2
  324. data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +5 -2
  325. data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -1
  326. data/docs/RedemptionsRedeemRequestBodyRedeemablesItemGift.md +1 -1
  327. data/docs/RedemptionsRollbackCreateResponseBody.md +1 -1
  328. data/docs/ReferralsApi.md +13 -13
  329. data/docs/Reward.md +1 -1
  330. data/docs/RewardsCreateRequestBody.md +1 -1
  331. data/docs/RewardsCreateRequestBodyParametersCampaign.md +1 -1
  332. data/docs/RewardsCreateResponseBody.md +1 -1
  333. data/docs/RewardsUpdateRequestBody.md +1 -1
  334. data/docs/RewardsUpdateRequestBodyParametersCampaign.md +1 -1
  335. data/docs/RewardsUpdateResponseBody.md +1 -1
  336. data/docs/SegmentsApi.md +2 -2
  337. data/docs/SegmentsCreateRequestBody.md +1 -1
  338. data/docs/SegmentsCreateResponseBody.md +4 -3
  339. data/docs/SegmentsGetResponseBody.md +4 -3
  340. data/docs/SimpleLoyaltyCard.md +5 -2
  341. data/docs/SimpleVoucherRedemption.md +1 -0
  342. data/docs/StackingRules.md +15 -11
  343. data/docs/TemplatesApi.md +7 -7
  344. data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +3 -2
  345. data/docs/TrashBinItem.md +1 -1
  346. data/docs/ValidationRule.md +1 -0
  347. data/docs/ValidationRulesApi.md +3 -3
  348. data/docs/ValidationRulesCreateRequestBody.md +1 -0
  349. data/docs/ValidationRulesCreateResponseBody.md +1 -0
  350. data/docs/ValidationRulesGetResponseBody.md +1 -0
  351. data/docs/ValidationRulesUpdateRequestBody.md +1 -0
  352. data/docs/ValidationRulesUpdateResponseBody.md +1 -0
  353. data/docs/ValidationsApi.md +1 -1
  354. data/docs/ValidationsRedeemableInapplicableResult.md +1 -0
  355. data/docs/ValidationsValidateRequestBodyOptions.md +1 -1
  356. data/docs/ValidationsValidateRequestBodyRedeemablesItemGift.md +1 -1
  357. data/docs/ValidationsValidateResponseBody.md +1 -0
  358. data/docs/ValidationsValidateResponseBodyRedeemablesItemResult.md +1 -0
  359. data/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +4 -4
  360. data/docs/ValidationsValidateResponseBodyRedeemablesItemResultGift.md +2 -1
  361. data/docs/ValidityHours.md +1 -1
  362. data/docs/VoucherBalance.md +1 -0
  363. data/docs/VoucherGift.md +3 -2
  364. data/docs/VoucherLoyaltyCard.md +5 -2
  365. data/docs/VoucherTransaction.md +1 -1
  366. data/docs/VoucherTransactionDetails.md +2 -0
  367. data/docs/VoucherTransactionDetailsBalance.md +1 -0
  368. data/docs/VoucherTransactionDetailsCustomEvent.md +2 -2
  369. data/docs/VoucherTransactionDetailsEarningRule.md +1 -1
  370. data/docs/VoucherTransactionDetailsEventSchema.md +2 -2
  371. data/docs/VoucherTransactionDetailsHolderLoyaltyTier.md +9 -0
  372. data/docs/VoucherTransactionDetailsLoyaltyTier.md +2 -2
  373. data/docs/VoucherTransactionDetailsRollback.md +1 -1
  374. data/docs/VoucherTransactionDetailsSegment.md +2 -2
  375. data/docs/VoucherTransactionsExportParameters.md +1 -1
  376. data/docs/VoucherTransactionsFilters.md +1 -1
  377. data/docs/VoucherWithCategoriesGift.md +3 -2
  378. data/docs/VoucherWithCategoriesLoyaltyCard.md +5 -2
  379. data/docs/VouchersApi.md +16 -14
  380. data/docs/VouchersBalanceUpdateRequestBody.md +1 -1
  381. data/docs/VouchersBalanceUpdateResponseBody.md +2 -2
  382. data/docs/VouchersCreateRequestBody.md +2 -2
  383. data/docs/VouchersCreateResponseBodyGift.md +3 -2
  384. data/docs/VouchersCreateResponseBodyLoyaltyCard.md +5 -2
  385. data/docs/VouchersCreateWithSpecificCodeRequestBody.md +2 -2
  386. data/docs/VouchersDisableResponseBodyGift.md +3 -2
  387. data/docs/VouchersDisableResponseBodyLoyaltyCard.md +5 -2
  388. data/docs/VouchersEnableResponseBodyGift.md +3 -2
  389. data/docs/VouchersEnableResponseBodyLoyaltyCard.md +5 -2
  390. data/docs/VouchersGetResponseBodyGift.md +3 -2
  391. data/docs/VouchersGetResponseBodyLoyaltyCard.md +5 -2
  392. data/docs/VouchersImportCreateItemRequestBody.md +1 -1
  393. data/docs/VouchersTransactionsExportCreateResponseBodyResult.md +1 -1
  394. data/docs/VouchersUpdateRequestBody.md +2 -2
  395. data/docs/VouchersUpdateResponseBodyGift.md +3 -2
  396. data/docs/VouchersUpdateResponseBodyLoyaltyCard.md +5 -2
  397. data/lib/VoucherifySdk/api/async_actions_api.rb +4 -4
  398. data/lib/VoucherifySdk/api/bin_api.rb +4 -4
  399. data/lib/VoucherifySdk/api/campaigns_api.rb +220 -18
  400. data/lib/VoucherifySdk/api/categories_api.rb +2 -2
  401. data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
  402. data/lib/VoucherifySdk/api/customers_api.rb +14 -14
  403. data/lib/VoucherifySdk/api/exports_api.rb +6 -6
  404. data/lib/VoucherifySdk/api/loyalties_api.rb +599 -68
  405. data/lib/VoucherifySdk/api/management_api.rb +44 -44
  406. data/lib/VoucherifySdk/api/metadata_schemas_api.rb +6 -6
  407. data/lib/VoucherifySdk/api/orders_api.rb +6 -6
  408. data/lib/VoucherifySdk/api/products_api.rb +30 -30
  409. data/lib/VoucherifySdk/api/publications_api.rb +8 -8
  410. data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
  411. data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
  412. data/lib/VoucherifySdk/api/referrals_api.rb +14 -14
  413. data/lib/VoucherifySdk/api/segments_api.rb +4 -4
  414. data/lib/VoucherifySdk/api/templates_api.rb +14 -14
  415. data/lib/VoucherifySdk/api/validation_rules_api.rb +6 -6
  416. data/lib/VoucherifySdk/api/validations_api.rb +2 -2
  417. data/lib/VoucherifySdk/api/vouchers_api.rb +25 -22
  418. data/lib/VoucherifySdk/models/access_settings.rb +219 -0
  419. data/lib/VoucherifySdk/models/access_settings_assign.rb +238 -0
  420. data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
  421. data/lib/VoucherifySdk/models/access_settings_unassign.rb +238 -0
  422. data/lib/VoucherifySdk/models/applicable_to.rb +207 -18
  423. data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +235 -0
  424. data/lib/VoucherifySdk/models/application_details_item.rb +284 -0
  425. data/lib/VoucherifySdk/models/area_store_campaign_assignment.rb +12 -1
  426. data/lib/VoucherifySdk/models/async_actions_list_response_body.rb +16 -5
  427. data/lib/VoucherifySdk/models/bundle.rb +267 -0
  428. data/lib/VoucherifySdk/models/bundle_identified_item.rb +296 -0
  429. data/lib/VoucherifySdk/models/bundle_missing_item.rb +274 -0
  430. data/lib/VoucherifySdk/models/campaign.rb +17 -17
  431. data/lib/VoucherifySdk/models/campaign_base.rb +17 -8
  432. data/lib/VoucherifySdk/models/campaign_loyalty_card_expiration_rules.rb +53 -10
  433. data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +13 -4
  434. data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +17 -17
  435. data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +17 -17
  436. data/lib/VoucherifySdk/models/campaigns_import_voucher_item.rb +1 -1
  437. data/lib/VoucherifySdk/models/campaigns_summary_get_response_body.rb +673 -0
  438. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body.rb +209 -0
  439. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_request_body_parameters.rb +256 -0
  440. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body.rb +334 -0
  441. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters.rb +256 -0
  442. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters.rb +257 -0
  443. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id.rb +209 -0
  444. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_parameters_filters_campaign_id_conditions.rb +221 -0
  445. data/lib/VoucherifySdk/models/campaigns_transactions_export_create_response_body_result.rb +210 -0
  446. data/lib/VoucherifySdk/models/campaigns_transactions_list_response_body.rb +286 -0
  447. data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +11 -2
  448. data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +17 -17
  449. data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_gift.rb +14 -3
  450. data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_loyalty_card.rb +40 -7
  451. data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_gift.rb +14 -3
  452. data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_loyalty_card.rb +40 -7
  453. data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb +12 -2
  454. data/lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body_session.rb +236 -0
  455. data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_options.rb +1 -1
  456. data/lib/VoucherifySdk/models/client_redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
  457. data/lib/VoucherifySdk/models/client_validations_validate_request_body.rb +1 -1
  458. data/lib/VoucherifySdk/models/client_validations_validate_request_body_options.rb +1 -1
  459. data/lib/VoucherifySdk/models/client_validations_validate_request_body_redeemables_item_gift.rb +1 -1
  460. data/lib/VoucherifySdk/models/client_validations_validate_response_body.rb +12 -1
  461. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result.rb +11 -1
  462. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_discount.rb +5 -1
  463. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
  464. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
  465. data/lib/VoucherifySdk/models/create_publication_campaign.rb +3 -3
  466. data/lib/VoucherifySdk/models/customer_loyalty.rb +1 -1
  467. data/lib/VoucherifySdk/models/customer_summary_orders.rb +4 -3
  468. data/lib/VoucherifySdk/models/customer_summary_redemptions_gift.rb +2 -2
  469. data/lib/VoucherifySdk/models/customer_with_summary_loyalty_referrals_assets.rb +18 -7
  470. data/lib/VoucherifySdk/models/customers_create_response_body_assets.rb +18 -7
  471. data/lib/VoucherifySdk/models/customers_get_response_body_assets.rb +18 -7
  472. data/lib/VoucherifySdk/models/customers_update_response_body_assets.rb +18 -7
  473. data/lib/VoucherifySdk/models/discount.rb +5 -1
  474. data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -0
  475. data/lib/VoucherifySdk/models/earning_rule.rb +20 -1
  476. data/lib/VoucherifySdk/models/earning_rule_expiration_rules.rb +313 -0
  477. data/lib/VoucherifySdk/models/earning_rule_loyalty.rb +12 -1
  478. data/lib/VoucherifySdk/models/earning_rule_loyalty_custom_event_metadata.rb +12 -1
  479. data/lib/VoucherifySdk/models/earning_rule_loyalty_customer_metadata.rb +12 -1
  480. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_amount.rb +16 -5
  481. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount.rb +31 -7
  482. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  483. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity.rb +31 -7
  484. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  485. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount.rb +31 -7
  486. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  487. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_metadata.rb +12 -1
  488. data/lib/VoucherifySdk/models/earning_rule_loyalty_order_total_amount.rb +16 -5
  489. data/lib/VoucherifySdk/models/earning_rule_pending_points.rb +257 -0
  490. data/lib/VoucherifySdk/models/event_source.rb +254 -0
  491. data/lib/VoucherifySdk/models/event_source_api_key.rb +221 -0
  492. data/lib/VoucherifySdk/models/event_source_user.rb +210 -0
  493. data/lib/VoucherifySdk/models/export_campaign_transactions_filters.rb +248 -0
  494. data/lib/VoucherifySdk/models/export_parameters.rb +16 -5
  495. data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +16 -5
  496. data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +16 -5
  497. data/lib/VoucherifySdk/models/exports_get_response_body.rb +0 -1
  498. data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +16 -5
  499. data/lib/VoucherifySdk/models/filter_conditions_date_time.rb +2 -2
  500. data/lib/VoucherifySdk/models/gift.rb +14 -3
  501. data/lib/VoucherifySdk/models/inapplicable_to.rb +207 -18
  502. data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +235 -0
  503. data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +13 -4
  504. data/lib/VoucherifySdk/models/loyalties_create_campaign_response_body.rb +1 -1
  505. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item.rb +22 -3
  506. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb +12 -1
  507. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_custom_event_metadata.rb +12 -1
  508. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_customer_metadata.rb +12 -1
  509. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_amount.rb +16 -5
  510. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount.rb +31 -7
  511. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  512. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity.rb +31 -7
  513. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  514. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_items_subtotal_amount.rb +31 -7
  515. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_metadata.rb +12 -1
  516. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty_order_total_amount.rb +16 -5
  517. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  518. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_pending_points.rb +257 -0
  519. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body.rb +20 -1
  520. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty.rb +12 -1
  521. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_custom_event_metadata.rb +12 -1
  522. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_customer_metadata.rb +12 -1
  523. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_amount.rb +16 -5
  524. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount.rb +31 -7
  525. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  526. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity.rb +31 -7
  527. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  528. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  529. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_metadata.rb +12 -1
  530. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_loyalty_order_total_amount.rb +16 -5
  531. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  532. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_pending_points.rb +257 -0
  533. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +20 -1
  534. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty.rb +12 -1
  535. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_custom_event_metadata.rb +12 -1
  536. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_customer_metadata.rb +12 -1
  537. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_amount.rb +16 -5
  538. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount.rb +31 -7
  539. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  540. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity.rb +31 -7
  541. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  542. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  543. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_metadata.rb +12 -1
  544. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_loyalty_order_total_amount.rb +16 -5
  545. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  546. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_pending_points.rb +257 -0
  547. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +20 -1
  548. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty.rb +12 -1
  549. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_custom_event_metadata.rb +12 -1
  550. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_customer_metadata.rb +12 -1
  551. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_amount.rb +16 -5
  552. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount.rb +31 -7
  553. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  554. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity.rb +31 -7
  555. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  556. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  557. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_metadata.rb +12 -1
  558. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_loyalty_order_total_amount.rb +16 -5
  559. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  560. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_pending_points.rb +257 -0
  561. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +20 -1
  562. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty.rb +12 -1
  563. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_custom_event_metadata.rb +12 -1
  564. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_customer_metadata.rb +12 -1
  565. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_amount.rb +16 -5
  566. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount.rb +31 -7
  567. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  568. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity.rb +31 -7
  569. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  570. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  571. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  572. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_metadata.rb +12 -1
  573. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_loyalty_order_total_amount.rb +16 -5
  574. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_pending_points.rb +257 -0
  575. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body.rb +22 -3
  576. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty.rb +12 -1
  577. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_custom_event_metadata.rb +12 -1
  578. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_customer_metadata.rb +12 -1
  579. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_amount.rb +16 -5
  580. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount.rb +31 -7
  581. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  582. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity.rb +31 -7
  583. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  584. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_items_subtotal_amount.rb +31 -7
  585. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_metadata.rb +12 -1
  586. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_loyalty_order_total_amount.rb +16 -5
  587. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  588. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_request_body_pending_points.rb +257 -0
  589. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body.rb +20 -1
  590. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty.rb +12 -1
  591. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_custom_event_metadata.rb +12 -1
  592. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_customer_metadata.rb +12 -1
  593. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_amount.rb +16 -5
  594. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount.rb +31 -7
  595. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_amount_applicable_to_item.rb +242 -0
  596. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity.rb +31 -7
  597. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_quantity_applicable_to_item.rb +242 -0
  598. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_items_subtotal_amount.rb +31 -7
  599. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_metadata.rb +12 -1
  600. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_loyalty_order_total_amount.rb +16 -5
  601. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_order_items_subtotal_amount_applicable_to_item.rb +242 -0
  602. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_pending_points.rb +257 -0
  603. data/lib/VoucherifySdk/models/loyalties_get_campaign_response_body.rb +1 -1
  604. data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +40 -7
  605. data/lib/VoucherifySdk/models/loyalties_members_create_response_body_publish.rb +1 -1
  606. data/lib/VoucherifySdk/models/loyalties_members_get_response_body_loyalty_card.rb +40 -7
  607. data/lib/VoucherifySdk/models/loyalties_members_get_response_body_publish.rb +1 -1
  608. data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body.rb +309 -0
  609. data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body_related_object.rb +247 -0
  610. data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_request_body.rb +210 -0
  611. data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body.rb +283 -0
  612. data/lib/VoucherifySdk/models/loyalties_members_pending_points_balance_response_body_related_object.rb +247 -0
  613. data/lib/VoucherifySdk/models/loyalties_members_pending_points_list_response_body.rb +286 -0
  614. data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +1 -1
  615. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_request_body.rb +1 -1
  616. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body.rb +11 -1
  617. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_related_redemptions_rollbacks_item.rb +38 -4
  618. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_session.rb +210 -0
  619. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_gift.rb +14 -3
  620. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb +40 -7
  621. data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +40 -7
  622. data/lib/VoucherifySdk/models/loyalties_pending_points_list_response_body.rb +286 -0
  623. data/lib/VoucherifySdk/models/loyalties_points_expiration_export_create_request_body_parameters.rb +1 -1
  624. data/lib/VoucherifySdk/models/loyalties_reward_assignments_reward_get_response_body.rb +1 -1
  625. data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body.rb +209 -0
  626. data/lib/VoucherifySdk/models/loyalties_transactions_export_create_request_body_parameters.rb +256 -0
  627. data/lib/VoucherifySdk/models/loyalties_transactions_list_response_body.rb +286 -0
  628. data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +11 -2
  629. data/lib/VoucherifySdk/models/loyalties_update_campaign_response_body.rb +1 -1
  630. data/lib/VoucherifySdk/models/loyalty_campaign.rb +1 -1
  631. data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +1 -1
  632. data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb +20 -1
  633. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb +12 -1
  634. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_earning_rule.rb +1 -1
  635. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_holder_loyalty_tier.rb +221 -0
  636. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_loyalty_tier.rb +3 -1
  637. data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb +2 -1
  638. data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +40 -7
  639. data/lib/VoucherifySdk/models/loyalty_member_publish.rb +1 -1
  640. data/lib/VoucherifySdk/models/loyalty_pending_points.rb +314 -0
  641. data/lib/VoucherifySdk/models/loyalty_pending_points_details.rb +249 -0
  642. data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule.rb +220 -0
  643. data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule_source.rb +210 -0
  644. data/lib/VoucherifySdk/models/loyalty_pending_points_details_event.rb +302 -0
  645. data/lib/VoucherifySdk/models/loyalty_pending_points_details_holder_loyalty_tier.rb +221 -0
  646. data/lib/VoucherifySdk/models/loyalty_pending_points_details_loyalty_tier.rb +221 -0
  647. data/lib/VoucherifySdk/models/loyalty_pending_points_details_order.rb +221 -0
  648. data/lib/VoucherifySdk/models/loyalty_points_bucket.rb +1 -1
  649. data/lib/VoucherifySdk/models/loyalty_tier_expiration.rb +1 -1
  650. data/lib/VoucherifySdk/models/loyalty_tiers_expiration_all.rb +1 -1
  651. data/lib/VoucherifySdk/models/management_projects_stacking_rules.rb +112 -9
  652. data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_request_body.rb +116 -13
  653. data/lib/VoucherifySdk/models/management_projects_stacking_rules_create_response_body.rb +112 -9
  654. data/lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb +112 -9
  655. data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_request_body.rb +116 -13
  656. data/lib/VoucherifySdk/models/management_projects_stacking_rules_update_response_body.rb +112 -9
  657. data/lib/VoucherifySdk/models/management_projects_users_invite_create_request_body.rb +1 -1
  658. data/lib/VoucherifySdk/models/management_projects_users_update_role_request_body.rb +1 -1
  659. data/lib/VoucherifySdk/models/order.rb +3 -3
  660. data/lib/VoucherifySdk/models/order_calculated.rb +28 -28
  661. data/lib/VoucherifySdk/models/order_calculated_item.rb +18 -6
  662. data/lib/VoucherifySdk/models/order_item.rb +1 -1
  663. data/lib/VoucherifySdk/models/order_redemptions_entry.rb +1 -1
  664. data/lib/VoucherifySdk/models/orders_create_request_body.rb +3 -3
  665. data/lib/VoucherifySdk/models/orders_create_response_body.rb +28 -28
  666. data/lib/VoucherifySdk/models/orders_get_response_body.rb +28 -28
  667. data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +17 -17
  668. data/lib/VoucherifySdk/models/orders_update_request_body.rb +3 -3
  669. data/lib/VoucherifySdk/models/orders_update_response_body.rb +28 -28
  670. data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status.rb +2 -1
  671. data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_campaign_status_conditions.rb +1 -0
  672. data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_category_ids.rb +1 -1
  673. data/lib/VoucherifySdk/models/parameter_filters_list_campaigns_is_referral_code.rb +1 -1
  674. data/lib/VoucherifySdk/models/parameter_order_list_pending_points.rb +40 -0
  675. data/lib/VoucherifySdk/models/parameters_filters_list_campaign_transactions.rb +247 -0
  676. data/lib/VoucherifySdk/models/product_collections_create_request_body.rb +2 -4
  677. data/lib/VoucherifySdk/models/products_skus_create_request_body.rb +1 -1
  678. data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +1 -1
  679. data/lib/VoucherifySdk/models/products_skus_list_response_body.rb +1 -1
  680. data/lib/VoucherifySdk/models/products_skus_update_request_body.rb +1 -1
  681. data/lib/VoucherifySdk/models/promotion_tier_campaign.rb +1 -1
  682. data/lib/VoucherifySdk/models/promotions_tiers_create_response_body_campaign.rb +1 -1
  683. data/lib/VoucherifySdk/models/promotions_tiers_disable_response_body_campaign.rb +1 -1
  684. data/lib/VoucherifySdk/models/promotions_tiers_enable_response_body_campaign.rb +1 -1
  685. data/lib/VoucherifySdk/models/promotions_tiers_get_response_body_campaign.rb +1 -1
  686. data/lib/VoucherifySdk/models/promotions_tiers_update_response_body_campaign.rb +1 -1
  687. data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body.rb +12 -2
  688. data/lib/VoucherifySdk/models/qualifications_check_eligibility_request_body_session.rb +236 -0
  689. data/lib/VoucherifySdk/models/qualifications_option.rb +4 -4
  690. data/lib/VoucherifySdk/models/qualifications_option_filters_resource_type_conditions.rb +1 -1
  691. data/lib/VoucherifySdk/models/qualifications_redeemable.rb +1 -1
  692. data/lib/VoucherifySdk/models/qualifications_redeemable_base.rb +1 -1
  693. data/lib/VoucherifySdk/models/redeemable_gift.rb +18 -7
  694. data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +2 -2
  695. data/lib/VoucherifySdk/models/redeemable_result.rb +10 -1
  696. data/lib/VoucherifySdk/models/redeemable_voucher_gift.rb +14 -3
  697. data/lib/VoucherifySdk/models/redeemable_voucher_loyalty_card.rb +40 -7
  698. data/lib/VoucherifySdk/models/redeemable_voucher_publish.rb +1 -1
  699. data/lib/VoucherifySdk/models/redemption.rb +11 -1
  700. data/lib/VoucherifySdk/models/redemption_entry.rb +11 -1
  701. data/lib/VoucherifySdk/models/redemption_entry_order.rb +28 -28
  702. data/lib/VoucherifySdk/models/redemption_entry_promotion_tier_campaign.rb +1 -1
  703. data/lib/VoucherifySdk/models/redemption_entry_related_redemptions_rollbacks_item.rb +38 -4
  704. data/lib/VoucherifySdk/models/redemption_entry_session.rb +210 -0
  705. data/lib/VoucherifySdk/models/redemption_entry_voucher_gift.rb +14 -3
  706. data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb +40 -7
  707. data/lib/VoucherifySdk/models/redemption_related_redemptions_rollbacks_item.rb +38 -4
  708. data/lib/VoucherifySdk/models/redemption_reward_result_parameters_campaign.rb +1 -1
  709. data/lib/VoucherifySdk/models/redemption_rollback.rb +15 -15
  710. data/lib/VoucherifySdk/models/redemption_session.rb +210 -0
  711. data/lib/VoucherifySdk/models/redemption_voucher_gift.rb +14 -3
  712. data/lib/VoucherifySdk/models/redemption_voucher_loyalty_card.rb +40 -7
  713. data/lib/VoucherifySdk/models/redemptions_get_response_body.rb +11 -1
  714. data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +28 -28
  715. data/lib/VoucherifySdk/models/redemptions_get_response_body_promotion_tier_campaign.rb +1 -1
  716. data/lib/VoucherifySdk/models/redemptions_get_response_body_related_redemptions_rollbacks_item.rb +38 -4
  717. data/lib/VoucherifySdk/models/redemptions_get_response_body_session.rb +210 -0
  718. data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_gift.rb +14 -3
  719. data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_loyalty_card.rb +40 -7
  720. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item.rb +11 -1
  721. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +27 -28
  722. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_promotion_tier_campaign.rb +1 -1
  723. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions.rb +0 -1
  724. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_related_redemptions_rollbacks_item.rb +38 -4
  725. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_session.rb +210 -0
  726. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_gift.rb +14 -3
  727. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_loyalty_card.rb +40 -7
  728. data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +1 -1
  729. data/lib/VoucherifySdk/models/redemptions_redeem_request_body_redeemables_item_gift.rb +1 -1
  730. data/lib/VoucherifySdk/models/redemptions_rollback_create_response_body.rb +15 -15
  731. data/lib/VoucherifySdk/models/reward.rb +1 -1
  732. data/lib/VoucherifySdk/models/rewards_create_request_body.rb +1 -1
  733. data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_campaign.rb +1 -1
  734. data/lib/VoucherifySdk/models/rewards_create_response_body.rb +1 -1
  735. data/lib/VoucherifySdk/models/rewards_update_request_body.rb +1 -1
  736. data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_campaign.rb +1 -1
  737. data/lib/VoucherifySdk/models/rewards_update_response_body.rb +1 -1
  738. data/lib/VoucherifySdk/models/segments_create_request_body.rb +2 -2
  739. data/lib/VoucherifySdk/models/segments_create_response_body.rb +31 -20
  740. data/lib/VoucherifySdk/models/segments_get_response_body.rb +32 -21
  741. data/lib/VoucherifySdk/models/simple_loyalty_card.rb +40 -7
  742. data/lib/VoucherifySdk/models/simple_voucher_redemption.rb +16 -5
  743. data/lib/VoucherifySdk/models/stacking_rules.rb +72 -20
  744. data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +13 -4
  745. data/lib/VoucherifySdk/models/trash_bin_item.rb +1 -1
  746. data/lib/VoucherifySdk/models/validation_rule.rb +11 -1
  747. data/lib/VoucherifySdk/models/validation_rules_create_request_body.rb +11 -1
  748. data/lib/VoucherifySdk/models/validation_rules_create_response_body.rb +11 -1
  749. data/lib/VoucherifySdk/models/validation_rules_get_response_body.rb +11 -1
  750. data/lib/VoucherifySdk/models/validation_rules_update_request_body.rb +11 -1
  751. data/lib/VoucherifySdk/models/validation_rules_update_response_body.rb +11 -1
  752. data/lib/VoucherifySdk/models/validations_redeemable_inapplicable_result.rb +14 -5
  753. data/lib/VoucherifySdk/models/validations_validate_request_body.rb +1 -1
  754. data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +1 -1
  755. data/lib/VoucherifySdk/models/validations_validate_request_body_redeemables_item_gift.rb +1 -1
  756. data/lib/VoucherifySdk/models/validations_validate_response_body.rb +12 -1
  757. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result.rb +11 -1
  758. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_discount.rb +5 -1
  759. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_gift.rb +14 -3
  760. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_loyalty_card.rb +1 -0
  761. data/lib/VoucherifySdk/models/validity_hours.rb +1 -1
  762. data/lib/VoucherifySdk/models/validity_hours_daily_item.rb +1 -1
  763. data/lib/VoucherifySdk/models/voucher_balance.rb +12 -1
  764. data/lib/VoucherifySdk/models/voucher_gift.rb +14 -3
  765. data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +40 -7
  766. data/lib/VoucherifySdk/models/voucher_transaction.rb +2 -2
  767. data/lib/VoucherifySdk/models/voucher_transaction_details.rb +20 -1
  768. data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +12 -1
  769. data/lib/VoucherifySdk/models/voucher_transaction_details_custom_event.rb +2 -2
  770. data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb +1 -1
  771. data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb +2 -2
  772. data/lib/VoucherifySdk/models/voucher_transaction_details_holder_loyalty_tier.rb +221 -0
  773. data/lib/VoucherifySdk/models/voucher_transaction_details_loyalty_tier.rb +3 -1
  774. data/lib/VoucherifySdk/models/voucher_transaction_details_rollback.rb +1 -1
  775. data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb +2 -0
  776. data/lib/VoucherifySdk/models/voucher_transactions_export_parameters.rb +1 -1
  777. data/lib/VoucherifySdk/models/voucher_transactions_filters.rb +1 -1
  778. data/lib/VoucherifySdk/models/voucher_with_categories_gift.rb +14 -3
  779. data/lib/VoucherifySdk/models/voucher_with_categories_loyalty_card.rb +40 -7
  780. data/lib/VoucherifySdk/models/vouchers_balance_update_request_body.rb +1 -1
  781. data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +2 -2
  782. data/lib/VoucherifySdk/models/vouchers_create_request_body.rb +2 -2
  783. data/lib/VoucherifySdk/models/vouchers_create_response_body_gift.rb +14 -3
  784. data/lib/VoucherifySdk/models/vouchers_create_response_body_loyalty_card.rb +40 -7
  785. data/lib/VoucherifySdk/models/vouchers_create_with_specific_code_request_body.rb +2 -2
  786. data/lib/VoucherifySdk/models/vouchers_disable_response_body_gift.rb +14 -3
  787. data/lib/VoucherifySdk/models/vouchers_disable_response_body_loyalty_card.rb +40 -7
  788. data/lib/VoucherifySdk/models/vouchers_enable_response_body_gift.rb +14 -3
  789. data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +40 -7
  790. data/lib/VoucherifySdk/models/vouchers_get_response_body_gift.rb +14 -3
  791. data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +40 -7
  792. data/lib/VoucherifySdk/models/vouchers_import_create_item_request_body.rb +1 -1
  793. data/lib/VoucherifySdk/models/vouchers_transactions_export_create_response_body_result.rb +1 -1
  794. data/lib/VoucherifySdk/models/vouchers_update_request_body.rb +2 -2
  795. data/lib/VoucherifySdk/models/vouchers_update_response_body_gift.rb +14 -3
  796. data/lib/VoucherifySdk/models/vouchers_update_response_body_loyalty_card.rb +40 -7
  797. data/lib/VoucherifySdk/version.rb +1 -1
  798. data/lib/VoucherifySdk.rb +85 -0
  799. metadata +210 -36
@@ -19,11 +19,72 @@ module VoucherifySdk
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Activate Member Pending Points
23
+ # Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
24
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
25
+ # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [LoyaltiesMembersPendingPointsActivateResponseBody]
28
+ def activate_member_pending_points(member_id, pending_points_id, opts = {})
29
+ data, _status_code, _headers = activate_member_pending_points_with_http_info(member_id, pending_points_id, opts)
30
+ data
31
+ end
32
+
33
+ # Activate Member Pending Points
34
+ # Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
35
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
36
+ # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(LoyaltiesMembersPendingPointsActivateResponseBody, Integer, Hash)>] LoyaltiesMembersPendingPointsActivateResponseBody data, response status code and response headers
39
+ private def activate_member_pending_points_with_http_info(member_id, pending_points_id, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: LoyaltiesApi.activate_member_pending_points ...'
42
+ end
43
+ # resource path
44
+ local_var_path = '/v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate'.sub('{' + 'memberId' + '}', CGI.escape(member_id.to_s)).sub('{' + 'pendingPointsId' + '}', CGI.escape(pending_points_id.to_s))
45
+
46
+ # query parameters
47
+ query_params = opts[:query_params] || {}
48
+
49
+ # header parameters
50
+ header_params = opts[:header_params] || {}
51
+ # HTTP header 'Accept' (if needed)
52
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
53
+
54
+ # form parameters
55
+ form_params = opts[:form_params] || {}
56
+
57
+ # http body (model)
58
+ post_body = opts[:debug_body]
59
+
60
+ # return_type
61
+ return_type = opts[:debug_return_type] || 'LoyaltiesMembersPendingPointsActivateResponseBody'
62
+
63
+ # auth_names
64
+ auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
65
+
66
+ new_options = opts.merge(
67
+ :operation => :"LoyaltiesApi.activate_member_pending_points",
68
+ :header_params => header_params,
69
+ :query_params => query_params,
70
+ :form_params => form_params,
71
+ :body => post_body,
72
+ :auth_names => auth_names,
73
+ :return_type => return_type
74
+ )
75
+
76
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug "API called: LoyaltiesApi#activate_member_pending_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
+ end
80
+ return data, status_code, headers
81
+ end
82
+
22
83
  # Add Member
23
- # 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.
24
85
  # @param campaign_id [String] Unique campaign ID of the loyalty program.
25
86
  # @param [Hash] opts the optional parameters
26
- # @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.
27
88
  # @return [LoyaltiesMembersCreateResponseBody]
28
89
  def add_member(campaign_id, opts = {})
29
90
  data, _status_code, _headers = add_member_with_http_info(campaign_id, opts)
@@ -31,10 +92,10 @@ module VoucherifySdk
31
92
  end
32
93
 
33
94
  # Add Member
34
- # 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.
35
96
  # @param campaign_id [String] Unique campaign ID of the loyalty program.
36
97
  # @param [Hash] opts the optional parameters
37
- # @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.
38
99
  # @return [Array<(LoyaltiesMembersCreateResponseBody, Integer, Hash)>] LoyaltiesMembersCreateResponseBody data, response status code and response headers
39
100
  private def add_member_with_http_info(campaign_id, opts = {})
40
101
  if @api_client.config.debugging
@@ -85,8 +146,135 @@ module VoucherifySdk
85
146
  return data, status_code, headers
86
147
  end
87
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
+
217
+ # Cancel Member Pending Points
218
+ # Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
219
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
220
+ # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
221
+ # @param [Hash] opts the optional parameters
222
+ # @return [nil]
223
+ def cancel_member_pending_points(member_id, pending_points_id, opts = {})
224
+ cancel_member_pending_points_with_http_info(member_id, pending_points_id, opts)
225
+ nil
226
+ end
227
+
228
+ # Cancel Member Pending Points
229
+ # Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
230
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
231
+ # @param pending_points_id [String] Unique pending point identifier, assigned by Voucherify.
232
+ # @param [Hash] opts the optional parameters
233
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
234
+ private def cancel_member_pending_points_with_http_info(member_id, pending_points_id, opts = {})
235
+ if @api_client.config.debugging
236
+ @api_client.config.logger.debug 'Calling API: LoyaltiesApi.cancel_member_pending_points ...'
237
+ end
238
+ # resource path
239
+ local_var_path = '/v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel'.sub('{' + 'memberId' + '}', CGI.escape(member_id.to_s)).sub('{' + 'pendingPointsId' + '}', CGI.escape(pending_points_id.to_s))
240
+
241
+ # query parameters
242
+ query_params = opts[:query_params] || {}
243
+
244
+ # header parameters
245
+ header_params = opts[:header_params] || {}
246
+
247
+ # form parameters
248
+ form_params = opts[:form_params] || {}
249
+
250
+ # http body (model)
251
+ post_body = opts[:debug_body]
252
+
253
+ # return_type
254
+ return_type = opts[:debug_return_type]
255
+
256
+ # auth_names
257
+ auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
258
+
259
+ new_options = opts.merge(
260
+ :operation => :"LoyaltiesApi.cancel_member_pending_points",
261
+ :header_params => header_params,
262
+ :query_params => query_params,
263
+ :form_params => form_params,
264
+ :body => post_body,
265
+ :auth_names => auth_names,
266
+ :return_type => return_type
267
+ )
268
+
269
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
270
+ if @api_client.config.debugging
271
+ @api_client.config.logger.debug "API called: LoyaltiesApi#cancel_member_pending_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
272
+ end
273
+ return data, status_code, headers
274
+ end
275
+
88
276
  # Create Earning Rule
89
- # 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.
90
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.
91
279
  # @param [Hash] opts the optional parameters
92
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
@@ -97,7 +285,7 @@ module VoucherifySdk
97
285
  end
98
286
 
99
287
  # Create Earning Rule
100
- # 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.
101
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.
102
290
  # @param [Hash] opts the optional parameters
103
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
@@ -218,7 +406,7 @@ module VoucherifySdk
218
406
  end
219
407
 
220
408
  # Create Loyalty Campaign
221
- # 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.
222
410
  # @param [Hash] opts the optional parameters
223
411
  # @option opts [LoyaltiesCreateCampaignRequestBody] :loyalties_create_campaign_request_body Specify the loyalty campaign details.
224
412
  # @return [LoyaltiesCreateCampaignResponseBody]
@@ -228,7 +416,7 @@ module VoucherifySdk
228
416
  end
229
417
 
230
418
  # Create Loyalty Campaign
231
- # 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.
232
420
  # @param [Hash] opts the optional parameters
233
421
  # @option opts [LoyaltiesCreateCampaignRequestBody] :loyalties_create_campaign_request_body Specify the loyalty campaign details.
234
422
  # @return [Array<(LoyaltiesCreateCampaignResponseBody, Integer, Hash)>] LoyaltiesCreateCampaignResponseBody data, response status code and response headers
@@ -281,8 +469,8 @@ module VoucherifySdk
281
469
  return data, status_code, headers
282
470
  end
283
471
 
284
- # Create Points Expiration Export
285
- # Schedule the generation of a points expiration CSV file for a particular campaign.
472
+ # Export Loyalty Campaign Point Expiration
473
+ # Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.
286
474
  # @param campaign_id [String] Unique campaign ID or name.
287
475
  # @param [Hash] opts the optional parameters
288
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.
@@ -292,8 +480,8 @@ module VoucherifySdk
292
480
  data
293
481
  end
294
482
 
295
- # Create Points Expiration Export
296
- # Schedule the generation of a points expiration CSV file for a particular campaign.
483
+ # Export Loyalty Campaign Point Expiration
484
+ # Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status.
297
485
  # @param campaign_id [String] Unique campaign ID or name.
298
486
  # @param [Hash] opts the optional parameters
299
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.
@@ -347,7 +535,7 @@ module VoucherifySdk
347
535
  return data, status_code, headers
348
536
  end
349
537
 
350
- # Create Reward Assignment
538
+ # Create Loyalty Campaign Reward Assignment
351
539
  # Add rewards to a loyalty campaign.
352
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.
353
541
  # @param [Hash] opts the optional parameters
@@ -358,7 +546,7 @@ module VoucherifySdk
358
546
  data
359
547
  end
360
548
 
361
- # Create Reward Assignment
549
+ # Create Loyalty Campaign Reward Assignment
362
550
  # Add rewards to a loyalty campaign.
363
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.
364
552
  # @param [Hash] opts the optional parameters
@@ -473,7 +661,7 @@ module VoucherifySdk
473
661
  end
474
662
 
475
663
  # Delete Loyalty Campaign
476
- # 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).
477
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.
478
666
  # @param [Hash] opts the optional parameters
479
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.
@@ -484,7 +672,7 @@ module VoucherifySdk
484
672
  end
485
673
 
486
674
  # Delete Loyalty Campaign
487
- # 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).
488
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.
489
677
  # @param [Hash] opts the optional parameters
490
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.
@@ -534,7 +722,7 @@ module VoucherifySdk
534
722
  return data, status_code, headers
535
723
  end
536
724
 
537
- # Delete Reward Assignment
725
+ # Delete Campaign Reward Assignment
538
726
  # This method deletes a reward assignment for a particular loyalty campaign.
539
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.
540
728
  # @param assignment_id [String] A unique reward assignment ID.
@@ -545,7 +733,7 @@ module VoucherifySdk
545
733
  nil
546
734
  end
547
735
 
548
- # Delete Reward Assignment
736
+ # Delete Campaign Reward Assignment
549
737
  # This method deletes a reward assignment for a particular loyalty campaign.
550
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.
551
739
  # @param assignment_id [String] A unique reward assignment ID.
@@ -596,7 +784,7 @@ module VoucherifySdk
596
784
  # Disable Earning Rule
597
785
  # Disable an earning rule.
598
786
  # @param campaign_id [String] Unique campaign ID or name.
599
- # @param earning_rule_id [String] Unique earning rule ID.
787
+ # @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
600
788
  # @param [Hash] opts the optional parameters
601
789
  # @return [LoyaltiesEarningRulesDisableResponseBody]
602
790
  def disable_earning_rule(campaign_id, earning_rule_id, opts = {})
@@ -607,7 +795,7 @@ module VoucherifySdk
607
795
  # Disable Earning Rule
608
796
  # Disable an earning rule.
609
797
  # @param campaign_id [String] Unique campaign ID or name.
610
- # @param earning_rule_id [String] Unique earning rule ID.
798
+ # @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
611
799
  # @param [Hash] opts the optional parameters
612
800
  # @return [Array<(LoyaltiesEarningRulesDisableResponseBody, Integer, Hash)>] LoyaltiesEarningRulesDisableResponseBody data, response status code and response headers
613
801
  private def disable_earning_rule_with_http_info(campaign_id, earning_rule_id, opts = {})
@@ -657,7 +845,7 @@ module VoucherifySdk
657
845
  # Enable Earning Rule
658
846
  # Enable an earning rule.
659
847
  # @param campaign_id [String] Unique campaign ID or name.
660
- # @param earning_rule_id [String] Unique earning rule ID.
848
+ # @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
661
849
  # @param [Hash] opts the optional parameters
662
850
  # @return [LoyaltiesEarningRulesEnableResponseBody]
663
851
  def enable_earning_rule(campaign_id, earning_rule_id, opts = {})
@@ -668,7 +856,7 @@ module VoucherifySdk
668
856
  # Enable Earning Rule
669
857
  # Enable an earning rule.
670
858
  # @param campaign_id [String] Unique campaign ID or name.
671
- # @param earning_rule_id [String] Unique earning rule ID.
859
+ # @param earning_rule_id [String] Unique identifier of an earning rule, assigned by Voucherify.
672
860
  # @param [Hash] opts the optional parameters
673
861
  # @return [Array<(LoyaltiesEarningRulesEnableResponseBody, Integer, Hash)>] LoyaltiesEarningRulesEnableResponseBody data, response status code and response headers
674
862
  private def enable_earning_rule_with_http_info(campaign_id, earning_rule_id, opts = {})
@@ -715,6 +903,72 @@ module VoucherifySdk
715
903
  return data, status_code, headers
716
904
  end
717
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
+
718
972
  # Export Loyalty Card Transactions
719
973
  # Export transactions that are associated with point movements on a loyalty card.
720
974
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
@@ -781,7 +1035,7 @@ module VoucherifySdk
781
1035
  return data, status_code, headers
782
1036
  end
783
1037
 
784
- # Export Loyalty Card Transactions
1038
+ # Export Loyalty Card Transactions with campaign ID
785
1039
  # Export transactions that are associated with point movements on a loyalty card.
786
1040
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
787
1041
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
@@ -793,7 +1047,7 @@ module VoucherifySdk
793
1047
  data
794
1048
  end
795
1049
 
796
- # Export Loyalty Card Transactions
1050
+ # Export Loyalty Card Transactions with campaign ID
797
1051
  # Export transactions that are associated with point movements on a loyalty card.
798
1052
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
799
1053
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to export transaction data for.
@@ -1031,7 +1285,7 @@ module VoucherifySdk
1031
1285
  end
1032
1286
 
1033
1287
  # Get Member
1034
- # 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.
1035
1289
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
1036
1290
  # @param [Hash] opts the optional parameters
1037
1291
  # @return [LoyaltiesMembersGetResponseBody]
@@ -1041,7 +1295,7 @@ module VoucherifySdk
1041
1295
  end
1042
1296
 
1043
1297
  # Get Member
1044
- # 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.
1045
1299
  # @param member_id [String] Unique loyalty card code assigned to a particular customer.
1046
1300
  # @param [Hash] opts the optional parameters
1047
1301
  # @return [Array<(LoyaltiesMembersGetResponseBody, Integer, Hash)>] LoyaltiesMembersGetResponseBody data, response status code and response headers
@@ -1089,7 +1343,7 @@ module VoucherifySdk
1089
1343
  return data, status_code, headers
1090
1344
  end
1091
1345
 
1092
- # Get Member
1346
+ # Get Member with campaign ID
1093
1347
  # Retrieves the loyalty card with the given member ID (i.e. voucher code).
1094
1348
  # @param campaign_id [String] Unique campaign ID.
1095
1349
  # @param member_id [String] Unique code that identifies the loyalty card.
@@ -1100,7 +1354,7 @@ module VoucherifySdk
1100
1354
  data
1101
1355
  end
1102
1356
 
1103
- # Get Member
1357
+ # Get Member with campaign ID
1104
1358
  # Retrieves the loyalty card with the given member ID (i.e. voucher code).
1105
1359
  # @param campaign_id [String] Unique campaign ID.
1106
1360
  # @param member_id [String] Unique code that identifies the loyalty card.
@@ -1150,7 +1404,7 @@ module VoucherifySdk
1150
1404
  return data, status_code, headers
1151
1405
  end
1152
1406
 
1153
- # Get Reward Assignment
1407
+ # Get Campaign Reward Assignments
1154
1408
  # Retrieve specific reward assignment.
1155
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.
1156
1410
  # @param assignment_id [String] Unique reward assignment ID.
@@ -1161,7 +1415,7 @@ module VoucherifySdk
1161
1415
  data
1162
1416
  end
1163
1417
 
1164
- # Get Reward Assignment
1418
+ # Get Campaign Reward Assignments
1165
1419
  # Retrieve specific reward assignment.
1166
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.
1167
1421
  # @param assignment_id [String] Unique reward assignment ID.
@@ -1211,8 +1465,8 @@ module VoucherifySdk
1211
1465
  return data, status_code, headers
1212
1466
  end
1213
1467
 
1214
- # Get Reward Assignment
1215
- # 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).
1216
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.
1217
1471
  # @param assignment_id [String] A unique reward assignment ID.
1218
1472
  # @param [Hash] opts the optional parameters
@@ -1222,8 +1476,8 @@ module VoucherifySdk
1222
1476
  data
1223
1477
  end
1224
1478
 
1225
- # Get Reward Assignment
1226
- # 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).
1227
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.
1228
1482
  # @param assignment_id [String] A unique reward assignment ID.
1229
1483
  # @param [Hash] opts the optional parameters
@@ -1333,6 +1587,74 @@ module VoucherifySdk
1333
1587
  return data, status_code, headers
1334
1588
  end
1335
1589
 
1590
+ # List Campaign Pending Points
1591
+ # Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
1592
+ # @param campaign_id [String] Unique campaign ID.
1593
+ # @param [Hash] opts the optional parameters
1594
+ # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
1595
+ # @option opts [ParameterOrderListPendingPoints] :order Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
1596
+ # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
1597
+ # @return [LoyaltiesPendingPointsListResponseBody]
1598
+ def list_campaign_pending_points(campaign_id, opts = {})
1599
+ data, _status_code, _headers = list_campaign_pending_points_with_http_info(campaign_id, opts)
1600
+ data
1601
+ end
1602
+
1603
+ # List Campaign Pending Points
1604
+ # Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
1605
+ # @param campaign_id [String] Unique campaign ID.
1606
+ # @param [Hash] opts the optional parameters
1607
+ # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
1608
+ # @option opts [ParameterOrderListPendingPoints] :order Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
1609
+ # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
1610
+ # @return [Array<(LoyaltiesPendingPointsListResponseBody, Integer, Hash)>] LoyaltiesPendingPointsListResponseBody data, response status code and response headers
1611
+ private def list_campaign_pending_points_with_http_info(campaign_id, opts = {})
1612
+ if @api_client.config.debugging
1613
+ @api_client.config.logger.debug 'Calling API: LoyaltiesApi.list_campaign_pending_points ...'
1614
+ end
1615
+ # resource path
1616
+ local_var_path = '/v1/loyalties/{campaignId}/pending-points'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
1617
+
1618
+ # query parameters
1619
+ query_params = opts[:query_params] || {}
1620
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1621
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1622
+ query_params[:'starting_after_id'] = opts[:'starting_after_id'] if !opts[:'starting_after_id'].nil?
1623
+
1624
+ # header parameters
1625
+ header_params = opts[:header_params] || {}
1626
+ # HTTP header 'Accept' (if needed)
1627
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1628
+
1629
+ # form parameters
1630
+ form_params = opts[:form_params] || {}
1631
+
1632
+ # http body (model)
1633
+ post_body = opts[:debug_body]
1634
+
1635
+ # return_type
1636
+ return_type = opts[:debug_return_type] || 'LoyaltiesPendingPointsListResponseBody'
1637
+
1638
+ # auth_names
1639
+ auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
1640
+
1641
+ new_options = opts.merge(
1642
+ :operation => :"LoyaltiesApi.list_campaign_pending_points",
1643
+ :header_params => header_params,
1644
+ :query_params => query_params,
1645
+ :form_params => form_params,
1646
+ :body => post_body,
1647
+ :auth_names => auth_names,
1648
+ :return_type => return_type
1649
+ )
1650
+
1651
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1652
+ if @api_client.config.debugging
1653
+ @api_client.config.logger.debug "API called: LoyaltiesApi#list_campaign_pending_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1654
+ end
1655
+ return data, status_code, headers
1656
+ end
1657
+
1336
1658
  # List Earning Rules
1337
1659
  # Returns a list of all earning rules within a given campaign.
1338
1660
  # @param campaign_id [String] The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.
@@ -1401,6 +1723,77 @@ module VoucherifySdk
1401
1723
  return data, status_code, headers
1402
1724
  end
1403
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
+
1404
1797
  # List Loyalty Card Transactions
1405
1798
  # Retrieve transaction data related to point movements for a specific loyalty card.
1406
1799
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
@@ -1469,7 +1862,7 @@ module VoucherifySdk
1469
1862
  return data, status_code, headers
1470
1863
  end
1471
1864
 
1472
- # List Loyalty Card Transactions
1865
+ # List Loyalty Card Transactions with campaign ID
1473
1866
  # Retrieve transaction data related to point movements for a specific loyalty card.
1474
1867
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
1475
1868
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
@@ -1483,7 +1876,7 @@ module VoucherifySdk
1483
1876
  data
1484
1877
  end
1485
1878
 
1486
- # List Loyalty Card Transactions
1879
+ # List Loyalty Card Transactions with campaign ID
1487
1880
  # Retrieve transaction data related to point movements for a specific loyalty card.
1488
1881
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
1489
1882
  # @param member_id [String] A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
@@ -1799,7 +2192,7 @@ module VoucherifySdk
1799
2192
  end
1800
2193
 
1801
2194
  # List Member Activity
1802
- # 📘 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.
1803
2196
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
1804
2197
  # @param [Hash] opts the optional parameters
1805
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.
@@ -1812,7 +2205,7 @@ module VoucherifySdk
1812
2205
  end
1813
2206
 
1814
2207
  # List Member Activity
1815
- # 📘 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.
1816
2209
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
1817
2210
  # @param [Hash] opts the optional parameters
1818
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.
@@ -1866,7 +2259,7 @@ module VoucherifySdk
1866
2259
  return data, status_code, headers
1867
2260
  end
1868
2261
 
1869
- # List Member Activity
2262
+ # List Member Activity with campaign ID
1870
2263
  # Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
1871
2264
  # @param campaign_id [String] Unique campaign ID.
1872
2265
  # @param member_id [String] A code that identifies the loyalty card.
@@ -1880,7 +2273,7 @@ module VoucherifySdk
1880
2273
  data
1881
2274
  end
1882
2275
 
1883
- # List Member Activity
2276
+ # List Member Activity with campaign ID
1884
2277
  # Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
1885
2278
  # @param campaign_id [String] Unique campaign ID.
1886
2279
  # @param member_id [String] A code that identifies the loyalty card.
@@ -1995,6 +2388,144 @@ module VoucherifySdk
1995
2388
  return data, status_code, headers
1996
2389
  end
1997
2390
 
2391
+ # List Member Pending Points
2392
+ # 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
2393
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2394
+ # @param [Hash] opts the optional parameters
2395
+ # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
2396
+ # @option opts [ParameterOrderListPendingPoints] :order Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
2397
+ # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
2398
+ # @return [LoyaltiesMembersPendingPointsListResponseBody]
2399
+ def list_member_pending_points(member_id, opts = {})
2400
+ data, _status_code, _headers = list_member_pending_points_with_http_info(member_id, opts)
2401
+ data
2402
+ end
2403
+
2404
+ # List Member Pending Points
2405
+ # 📘 Alternative endpoint This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. 👍 Configuring pending points Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).
2406
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2407
+ # @param [Hash] opts the optional parameters
2408
+ # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
2409
+ # @option opts [ParameterOrderListPendingPoints] :order Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
2410
+ # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
2411
+ # @return [Array<(LoyaltiesMembersPendingPointsListResponseBody, Integer, Hash)>] LoyaltiesMembersPendingPointsListResponseBody data, response status code and response headers
2412
+ private def list_member_pending_points_with_http_info(member_id, opts = {})
2413
+ if @api_client.config.debugging
2414
+ @api_client.config.logger.debug 'Calling API: LoyaltiesApi.list_member_pending_points ...'
2415
+ end
2416
+ # resource path
2417
+ local_var_path = '/v1/loyalties/members/{memberId}/pending-points'.sub('{' + 'memberId' + '}', CGI.escape(member_id.to_s))
2418
+
2419
+ # query parameters
2420
+ query_params = opts[:query_params] || {}
2421
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
2422
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
2423
+ query_params[:'starting_after_id'] = opts[:'starting_after_id'] if !opts[:'starting_after_id'].nil?
2424
+
2425
+ # header parameters
2426
+ header_params = opts[:header_params] || {}
2427
+ # HTTP header 'Accept' (if needed)
2428
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2429
+
2430
+ # form parameters
2431
+ form_params = opts[:form_params] || {}
2432
+
2433
+ # http body (model)
2434
+ post_body = opts[:debug_body]
2435
+
2436
+ # return_type
2437
+ return_type = opts[:debug_return_type] || 'LoyaltiesMembersPendingPointsListResponseBody'
2438
+
2439
+ # auth_names
2440
+ auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
2441
+
2442
+ new_options = opts.merge(
2443
+ :operation => :"LoyaltiesApi.list_member_pending_points",
2444
+ :header_params => header_params,
2445
+ :query_params => query_params,
2446
+ :form_params => form_params,
2447
+ :body => post_body,
2448
+ :auth_names => auth_names,
2449
+ :return_type => return_type
2450
+ )
2451
+
2452
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2453
+ if @api_client.config.debugging
2454
+ @api_client.config.logger.debug "API called: LoyaltiesApi#list_member_pending_points\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2455
+ end
2456
+ return data, status_code, headers
2457
+ end
2458
+
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).
2461
+ # @param campaign_id [String] Unique campaign ID.
2462
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2463
+ # @param [Hash] opts the optional parameters
2464
+ # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
2465
+ # @option opts [ParameterOrderListPendingPoints] :order Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
2466
+ # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
2467
+ # @return [LoyaltiesMembersPendingPointsListResponseBody]
2468
+ def list_member_pending_points1(campaign_id, member_id, opts = {})
2469
+ data, _status_code, _headers = list_member_pending_points1_with_http_info(campaign_id, member_id, opts)
2470
+ data
2471
+ end
2472
+
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).
2475
+ # @param campaign_id [String] Unique campaign ID.
2476
+ # @param member_id [String] Unique loyalty card code assigned to a particular customer.
2477
+ # @param [Hash] opts the optional parameters
2478
+ # @option opts [Integer] :limit Limit the number of the pending point entries that the API returns in the response.
2479
+ # @option opts [ParameterOrderListPendingPoints] :order Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
2480
+ # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
2481
+ # @return [Array<(LoyaltiesMembersPendingPointsListResponseBody, Integer, Hash)>] LoyaltiesMembersPendingPointsListResponseBody data, response status code and response headers
2482
+ private def list_member_pending_points1_with_http_info(campaign_id, member_id, opts = {})
2483
+ if @api_client.config.debugging
2484
+ @api_client.config.logger.debug 'Calling API: LoyaltiesApi.list_member_pending_points1 ...'
2485
+ end
2486
+ # resource path
2487
+ local_var_path = '/v1/loyalties/{campaignId}/members/{memberId}/pending-points'.sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s)).sub('{' + 'memberId' + '}', CGI.escape(member_id.to_s))
2488
+
2489
+ # query parameters
2490
+ query_params = opts[:query_params] || {}
2491
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
2492
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
2493
+ query_params[:'starting_after_id'] = opts[:'starting_after_id'] if !opts[:'starting_after_id'].nil?
2494
+
2495
+ # header parameters
2496
+ header_params = opts[:header_params] || {}
2497
+ # HTTP header 'Accept' (if needed)
2498
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2499
+
2500
+ # form parameters
2501
+ form_params = opts[:form_params] || {}
2502
+
2503
+ # http body (model)
2504
+ post_body = opts[:debug_body]
2505
+
2506
+ # return_type
2507
+ return_type = opts[:debug_return_type] || 'LoyaltiesMembersPendingPointsListResponseBody'
2508
+
2509
+ # auth_names
2510
+ auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']
2511
+
2512
+ new_options = opts.merge(
2513
+ :operation => :"LoyaltiesApi.list_member_pending_points1",
2514
+ :header_params => header_params,
2515
+ :query_params => query_params,
2516
+ :form_params => form_params,
2517
+ :body => post_body,
2518
+ :auth_names => auth_names,
2519
+ :return_type => return_type
2520
+ )
2521
+
2522
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2523
+ if @api_client.config.debugging
2524
+ @api_client.config.logger.debug "API called: LoyaltiesApi#list_member_pending_points1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2525
+ end
2526
+ return data, status_code, headers
2527
+ end
2528
+
1998
2529
  # List Member Rewards
1999
2530
  # Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.
2000
2531
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
@@ -2140,8 +2671,8 @@ module VoucherifySdk
2140
2671
  return data, status_code, headers
2141
2672
  end
2142
2673
 
2143
- # Get Points Expiration
2144
- # 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.
2674
+ # List Loyalty Card Point Expiration
2675
+ # Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the [Exports API](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets.
2145
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.
2146
2677
  # @param member_id [String] Loyalty card code.
2147
2678
  # @param [Hash] opts the optional parameters
@@ -2153,8 +2684,8 @@ module VoucherifySdk
2153
2684
  data
2154
2685
  end
2155
2686
 
2156
- # Get Points Expiration
2157
- # 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.
2687
+ # List Loyalty Card Point Expiration
2688
+ # Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the [Exports API](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets.
2158
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.
2159
2690
  # @param member_id [String] Loyalty card code.
2160
2691
  # @param [Hash] opts the optional parameters
@@ -2207,8 +2738,8 @@ module VoucherifySdk
2207
2738
  return data, status_code, headers
2208
2739
  end
2209
2740
 
2210
- # List Reward Assignments
2211
- # 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.
2212
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.
2213
2744
  # @param [Hash] opts the optional parameters
2214
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.
@@ -2220,8 +2751,8 @@ module VoucherifySdk
2220
2751
  data
2221
2752
  end
2222
2753
 
2223
- # List Reward Assignments
2224
- # 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.
2225
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.
2226
2757
  # @param [Hash] opts the optional parameters
2227
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.
@@ -2275,7 +2806,7 @@ module VoucherifySdk
2275
2806
  return data, status_code, headers
2276
2807
  end
2277
2808
 
2278
- # List Reward Assignments
2809
+ # List Campaign Rewards
2279
2810
  # Returns active rewards from a given loyalty campaign.
2280
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.
2281
2812
  # @param [Hash] opts the optional parameters
@@ -2288,7 +2819,7 @@ module VoucherifySdk
2288
2819
  data
2289
2820
  end
2290
2821
 
2291
- # List Reward Assignments
2822
+ # List Campaign Rewards
2292
2823
  # Returns active rewards from a given loyalty campaign.
2293
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.
2294
2825
  # @param [Hash] opts the optional parameters
@@ -2344,7 +2875,7 @@ module VoucherifySdk
2344
2875
  end
2345
2876
 
2346
2877
  # Redeem Reward
2347
- # 📘 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.
2348
2879
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2349
2880
  # @param [Hash] opts the optional parameters
2350
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.
@@ -2355,7 +2886,7 @@ module VoucherifySdk
2355
2886
  end
2356
2887
 
2357
2888
  # Redeem Reward
2358
- # 📘 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.
2359
2890
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2360
2891
  # @param [Hash] opts the optional parameters
2361
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.
@@ -2409,7 +2940,7 @@ module VoucherifySdk
2409
2940
  return data, status_code, headers
2410
2941
  end
2411
2942
 
2412
- # Redeem Reward
2943
+ # Redeem Reward with campaign ID
2413
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.
2414
2945
  # @param campaign_id [String] Unique campaign ID.
2415
2946
  # @param member_id [String] A code that identifies the loyalty card.
@@ -2421,7 +2952,7 @@ module VoucherifySdk
2421
2952
  data
2422
2953
  end
2423
2954
 
2424
- # Redeem Reward
2955
+ # Redeem Reward with campaign ID
2425
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.
2426
2957
  # @param campaign_id [String] Unique campaign ID.
2427
2958
  # @param member_id [String] A code that identifies the loyalty card.
@@ -2478,7 +3009,7 @@ module VoucherifySdk
2478
3009
  end
2479
3010
 
2480
3011
  # Transfer Loyalty Points
2481
- # 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.
2482
3013
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
2483
3014
  # @param member_id [String] A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
2484
3015
  # @param [Hash] opts the optional parameters
@@ -2490,7 +3021,7 @@ module VoucherifySdk
2490
3021
  end
2491
3022
 
2492
3023
  # Transfer Loyalty Points
2493
- # 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.
2494
3025
  # @param campaign_id [String] A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
2495
3026
  # @param member_id [String] A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
2496
3027
  # @param [Hash] opts the optional parameters
@@ -2613,8 +3144,8 @@ module VoucherifySdk
2613
3144
  return data, status_code, headers
2614
3145
  end
2615
3146
 
2616
- # Add or Remove Loyalty Card Balance
2617
- # 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.
2618
3149
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2619
3150
  # @param [Hash] opts the optional parameters
2620
3151
  # @option opts [LoyaltiesMembersBalanceUpdateRequestBody] :loyalties_members_balance_update_request_body Specify the point adjustment along with the expiration mechanism.
@@ -2624,8 +3155,8 @@ module VoucherifySdk
2624
3155
  data
2625
3156
  end
2626
3157
 
2627
- # Add or Remove Loyalty Card Balance
2628
- # 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.
2629
3160
  # @param member_id [String] Unique loyalty card assigned to a particular customer.
2630
3161
  # @param [Hash] opts the optional parameters
2631
3162
  # @option opts [LoyaltiesMembersBalanceUpdateRequestBody] :loyalties_members_balance_update_request_body Specify the point adjustment along with the expiration mechanism.
@@ -2679,8 +3210,8 @@ module VoucherifySdk
2679
3210
  return data, status_code, headers
2680
3211
  end
2681
3212
 
2682
- # Add or Remove Loyalty Card Balance
2683
- # 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.
2684
3215
  # @param campaign_id [String] Unique campaign ID.
2685
3216
  # @param member_id [String] A code that identifies the loyalty card.
2686
3217
  # @param [Hash] opts the optional parameters
@@ -2691,8 +3222,8 @@ module VoucherifySdk
2691
3222
  data
2692
3223
  end
2693
3224
 
2694
- # Add or Remove Loyalty Card Balance
2695
- # 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.
2696
3227
  # @param campaign_id [String] Unique campaign ID.
2697
3228
  # @param member_id [String] A code that identifies the loyalty card.
2698
3229
  # @param [Hash] opts the optional parameters
@@ -2748,7 +3279,7 @@ module VoucherifySdk
2748
3279
  end
2749
3280
 
2750
3281
  # Update Loyalty Campaign
2751
- # 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.
2752
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.
2753
3284
  # @param [Hash] opts the optional parameters
2754
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.
@@ -2759,7 +3290,7 @@ module VoucherifySdk
2759
3290
  end
2760
3291
 
2761
3292
  # Update Loyalty Campaign
2762
- # 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.
2763
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.
2764
3295
  # @param [Hash] opts the optional parameters
2765
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.
@@ -2813,7 +3344,7 @@ module VoucherifySdk
2813
3344
  return data, status_code, headers
2814
3345
  end
2815
3346
 
2816
- # Update Reward Assignment
3347
+ # Update Campaign Reward Assignment
2817
3348
  # Updates rewards parameters, i.e. the points cost for the specific reward.
2818
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.
2819
3350
  # @param assignment_id [String] A unique reward assignment ID.
@@ -2825,7 +3356,7 @@ module VoucherifySdk
2825
3356
  data
2826
3357
  end
2827
3358
 
2828
- # Update Reward Assignment
3359
+ # Update Campaign Reward Assignment
2829
3360
  # Updates rewards parameters, i.e. the points cost for the specific reward.
2830
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.
2831
3362
  # @param assignment_id [String] A unique reward assignment ID.