voucherify 8.0.1 → 8.0.3

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 (289) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +1 -1
  3. data/ENDPOINTS-COVERAGE.md +69 -60
  4. data/Gemfile.lock +9 -7
  5. data/README.md +55 -2
  6. data/__tests__/spec/12_validation_rules_spec.rb +1 -15
  7. data/docs/AccessSettings.md +9 -0
  8. data/docs/AccessSettingsAssign.md +10 -0
  9. data/docs/AccessSettingsUnassign.md +10 -0
  10. data/docs/ApplicableTo.md +3 -2
  11. data/docs/ApplicableToOrderItemUnitsItem.md +9 -0
  12. data/docs/ApplicationDetailsItem.md +14 -0
  13. data/docs/AreaStoreCampaignAssignment.md +1 -0
  14. data/docs/BinApi.md +4 -4
  15. data/docs/Campaign.md +3 -3
  16. data/docs/CampaignBase.md +3 -2
  17. data/docs/CampaignsApi.md +3 -3
  18. data/docs/CampaignsCreateRequestBody.md +2 -1
  19. data/docs/CampaignsCreateResponseBody.md +3 -3
  20. data/docs/CampaignsGetResponseBody.md +3 -3
  21. data/docs/CampaignsUpdateRequestBody.md +3 -2
  22. data/docs/CampaignsUpdateResponseBody.md +3 -3
  23. data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +2 -1
  24. data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +2 -1
  25. data/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md +3 -2
  26. data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +1 -1
  27. data/docs/CustomerLoyalty.md +1 -1
  28. data/docs/Discount.md +1 -1
  29. data/docs/DiscountUnitMultipleOneUnit.md +1 -1
  30. data/docs/EarningRule.md +1 -0
  31. data/docs/EarningRulePendingPoints.md +9 -0
  32. data/docs/Error.md +1 -0
  33. data/docs/ErrorError.md +8 -0
  34. data/docs/EventSource.md +10 -0
  35. data/docs/EventSourceApiKey.md +9 -0
  36. data/docs/EventSourceUser.md +8 -0
  37. data/docs/InapplicableTo.md +3 -2
  38. data/docs/InapplicableToOrderItemUnitsItem.md +9 -0
  39. data/docs/LoyaltiesApi.md +334 -10
  40. data/docs/LoyaltiesCreateCampaignRequestBody.md +2 -1
  41. data/docs/LoyaltiesEarningRulesCreateResponseBody.md +1 -0
  42. data/docs/LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md +9 -0
  43. data/docs/LoyaltiesEarningRulesDisableResponseBody.md +1 -0
  44. data/docs/LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md +9 -0
  45. data/docs/LoyaltiesEarningRulesEnableResponseBody.md +1 -0
  46. data/docs/LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md +9 -0
  47. data/docs/LoyaltiesEarningRulesGetResponseBody.md +1 -0
  48. data/docs/LoyaltiesEarningRulesGetResponseBodyPendingPoints.md +9 -0
  49. data/docs/LoyaltiesEarningRulesUpdateResponseBody.md +1 -0
  50. data/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md +9 -0
  51. data/docs/LoyaltiesMembersBalanceUpdateResponseBody.md +1 -1
  52. data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +2 -1
  53. data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +2 -1
  54. data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +14 -0
  55. data/docs/LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md +9 -0
  56. data/docs/LoyaltiesMembersPendingPointsListResponseBody.md +12 -0
  57. data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItem.md +9 -9
  58. data/docs/LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket.md +1 -1
  59. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +2 -1
  60. data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +2 -1
  61. data/docs/LoyaltiesPendingPointsListResponseBody.md +12 -0
  62. data/docs/LoyaltiesUpdateCampaignRequestBody.md +3 -2
  63. data/docs/LoyaltyCardTransaction.md +2 -2
  64. data/docs/LoyaltyCardTransactionDetails.md +2 -0
  65. data/docs/LoyaltyCardTransactionDetailsBalance.md +5 -4
  66. data/docs/LoyaltyCardTransactionDetailsBalanceRelatedObject.md +1 -1
  67. data/docs/LoyaltyCardTransactionDetailsEarningRule.md +1 -1
  68. data/docs/LoyaltyCardTransactionDetailsHolderLoyaltyTier.md +9 -0
  69. data/docs/LoyaltyCardTransactionDetailsLoyaltyTier.md +2 -2
  70. data/docs/LoyaltyMemberLoyaltyCard.md +2 -1
  71. data/docs/LoyaltyPendingPoints.md +17 -0
  72. data/docs/LoyaltyPendingPointsDetails.md +12 -0
  73. data/docs/LoyaltyPendingPointsDetailsEarningRule.md +9 -0
  74. data/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md +8 -0
  75. data/docs/LoyaltyPendingPointsDetailsEvent.md +14 -0
  76. data/docs/LoyaltyPendingPointsDetailsHolderLoyaltyTier.md +9 -0
  77. data/docs/LoyaltyPendingPointsDetailsLoyaltyTier.md +9 -0
  78. data/docs/LoyaltyPendingPointsDetailsOrder.md +9 -0
  79. data/docs/LoyaltyPointsBucket.md +16 -0
  80. data/docs/LoyaltyPointsBucketBucket.md +8 -0
  81. data/docs/LoyaltyTierExpiration.md +1 -1
  82. data/docs/Order.md +3 -3
  83. data/docs/OrderCalculated.md +12 -12
  84. data/docs/OrderCalculatedItem.md +2 -1
  85. data/docs/OrderCalculatedItemProduct.md +1 -1
  86. data/docs/OrderCalculatedItemSku.md +1 -0
  87. data/docs/OrderItem.md +1 -1
  88. data/docs/OrderItemProduct.md +1 -1
  89. data/docs/OrderItemSku.md +1 -0
  90. data/docs/OrderRedemptionsEntry.md +1 -1
  91. data/docs/OrdersCreateRequestBody.md +3 -3
  92. data/docs/OrdersCreateResponseBody.md +12 -12
  93. data/docs/OrdersGetResponseBody.md +12 -12
  94. data/docs/OrdersImportCreateRequestBodyItem.md +3 -3
  95. data/docs/OrdersUpdateRequestBody.md +3 -3
  96. data/docs/OrdersUpdateResponseBody.md +12 -12
  97. data/docs/ParameterOrderListPendingPoints.md +7 -0
  98. data/docs/Product.md +1 -1
  99. data/docs/ProductCollectionsProductsListResponseBodyDataItem.md +1 -1
  100. data/docs/ProductWithoutSkus.md +1 -1
  101. data/docs/ProductsCreateResponseBody.md +1 -1
  102. data/docs/ProductsGetResponseBody.md +1 -1
  103. data/docs/ProductsSkusCreateResponseBody.md +1 -1
  104. data/docs/ProductsSkusUpdateResponseBody.md +1 -1
  105. data/docs/ProductsUpdateResponseBody.md +1 -1
  106. data/docs/RedeemableLoyaltyCard.md +1 -1
  107. data/docs/RedeemableVoucherLoyaltyCard.md +2 -1
  108. data/docs/RedemptionEntryOrder.md +12 -12
  109. data/docs/RedemptionEntryVoucherLoyaltyCard.md +2 -1
  110. data/docs/RedemptionVoucherLoyaltyCard.md +2 -1
  111. data/docs/RedemptionsGetResponseBodyOrder.md +12 -12
  112. data/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +2 -1
  113. data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +12 -12
  114. data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +2 -1
  115. data/docs/SimpleLoyaltyCard.md +2 -1
  116. data/docs/Sku.md +1 -1
  117. data/docs/SkusGetResponseBody.md +1 -1
  118. data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +2 -1
  119. data/docs/ValidationsRedeemableInapplicable.md +3 -2
  120. data/docs/ValidationsRedeemableSkipped.md +3 -2
  121. data/docs/ValidationsValidateResponseBodyRedeemablesItem.md +3 -2
  122. data/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +1 -1
  123. data/docs/VoucherBalance.md +14 -0
  124. data/docs/VoucherBalanceRelatedObject.md +9 -0
  125. data/docs/VoucherLoyaltyCard.md +2 -1
  126. data/docs/VoucherTransaction.md +2 -2
  127. data/docs/VoucherTransactionDetails.md +2 -0
  128. data/docs/VoucherTransactionDetailsBalance.md +5 -4
  129. data/docs/VoucherTransactionDetailsBalanceRelatedObject.md +1 -1
  130. data/docs/VoucherTransactionDetailsCustomEvent.md +2 -2
  131. data/docs/VoucherTransactionDetailsEarningRule.md +1 -1
  132. data/docs/VoucherTransactionDetailsEventSchema.md +2 -2
  133. data/docs/VoucherTransactionDetailsHolderLoyaltyTier.md +9 -0
  134. data/docs/VoucherTransactionDetailsLoyaltyTier.md +2 -2
  135. data/docs/VoucherTransactionDetailsRollback.md +1 -1
  136. data/docs/VoucherTransactionDetailsSegment.md +2 -2
  137. data/docs/VoucherWithCategoriesLoyaltyCard.md +2 -1
  138. data/docs/VouchersApi.md +6 -6
  139. data/docs/VouchersBalanceUpdateResponseBody.md +1 -1
  140. data/docs/VouchersCreateResponseBodyLoyaltyCard.md +2 -1
  141. data/docs/VouchersDisableResponseBodyLoyaltyCard.md +2 -1
  142. data/docs/VouchersEnableResponseBodyLoyaltyCard.md +2 -1
  143. data/docs/VouchersGetResponseBodyLoyaltyCard.md +2 -1
  144. data/docs/VouchersUpdateResponseBodyLoyaltyCard.md +2 -1
  145. data/lib/VoucherifySdk/api/bin_api.rb +4 -4
  146. data/lib/VoucherifySdk/api/campaigns_api.rb +4 -4
  147. data/lib/VoucherifySdk/api/loyalties_api.rb +334 -8
  148. data/lib/VoucherifySdk/api/vouchers_api.rb +10 -10
  149. data/lib/VoucherifySdk/models/access_settings.rb +219 -0
  150. data/lib/VoucherifySdk/models/access_settings_assign.rb +238 -0
  151. data/lib/VoucherifySdk/models/access_settings_campaign_assignments_list.rb +1 -1
  152. data/lib/VoucherifySdk/models/access_settings_unassign.rb +238 -0
  153. data/lib/VoucherifySdk/models/applicable_to.rb +16 -3
  154. data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +220 -0
  155. data/lib/VoucherifySdk/models/application_details_item.rb +284 -0
  156. data/lib/VoucherifySdk/models/area_store_campaign_assignment.rb +12 -1
  157. data/lib/VoucherifySdk/models/campaign.rb +16 -16
  158. data/lib/VoucherifySdk/models/campaign_base.rb +16 -7
  159. data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +11 -2
  160. data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +16 -16
  161. data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +16 -16
  162. data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +12 -3
  163. data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +16 -16
  164. data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_loyalty_card.rb +17 -6
  165. data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_loyalty_card.rb +17 -6
  166. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item.rb +18 -7
  167. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_discount.rb +1 -0
  168. data/lib/VoucherifySdk/models/customer_loyalty.rb +1 -1
  169. data/lib/VoucherifySdk/models/discount.rb +1 -0
  170. data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -0
  171. data/lib/VoucherifySdk/models/earning_rule.rb +11 -1
  172. data/lib/VoucherifySdk/models/earning_rule_pending_points.rb +257 -0
  173. data/lib/VoucherifySdk/models/error.rb +15 -5
  174. data/lib/VoucherifySdk/models/error_error.rb +210 -0
  175. data/lib/VoucherifySdk/models/event_source.rb +254 -0
  176. data/lib/VoucherifySdk/models/event_source_api_key.rb +221 -0
  177. data/lib/VoucherifySdk/models/event_source_user.rb +210 -0
  178. data/lib/VoucherifySdk/models/inapplicable_to.rb +16 -3
  179. data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +220 -0
  180. data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +11 -2
  181. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body.rb +11 -1
  182. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_pending_points.rb +257 -0
  183. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +11 -1
  184. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_pending_points.rb +257 -0
  185. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +11 -1
  186. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_pending_points.rb +257 -0
  187. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +11 -1
  188. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_pending_points.rb +257 -0
  189. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body.rb +11 -1
  190. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_pending_points.rb +257 -0
  191. data/lib/VoucherifySdk/models/loyalties_members_balance_update_response_body.rb +1 -0
  192. data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +17 -6
  193. data/lib/VoucherifySdk/models/loyalties_members_get_response_body_loyalty_card.rb +17 -6
  194. data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body.rb +309 -0
  195. data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body_related_object.rb +247 -0
  196. data/lib/VoucherifySdk/models/loyalties_members_pending_points_list_response_body.rb +286 -0
  197. data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item.rb +27 -77
  198. data/lib/VoucherifySdk/models/loyalties_members_points_expiration_list_response_body_data_item_bucket.rb +3 -9
  199. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb +17 -6
  200. data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +17 -6
  201. data/lib/VoucherifySdk/models/loyalties_pending_points_list_response_body.rb +286 -0
  202. data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +12 -3
  203. data/lib/VoucherifySdk/models/loyalty_card_transaction.rb +24 -31
  204. data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb +20 -2
  205. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance.rb +18 -19
  206. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_balance_related_object.rb +1 -7
  207. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_earning_rule.rb +1 -1
  208. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_holder_loyalty_tier.rb +221 -0
  209. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_loyalty_tier.rb +3 -1
  210. data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb +2 -1
  211. data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +17 -6
  212. data/lib/VoucherifySdk/models/loyalty_pending_points.rb +314 -0
  213. data/lib/VoucherifySdk/models/loyalty_pending_points_details.rb +249 -0
  214. data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule.rb +220 -0
  215. data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule_source.rb +210 -0
  216. data/lib/VoucherifySdk/models/loyalty_pending_points_details_event.rb +302 -0
  217. data/lib/VoucherifySdk/models/loyalty_pending_points_details_holder_loyalty_tier.rb +221 -0
  218. data/lib/VoucherifySdk/models/loyalty_pending_points_details_loyalty_tier.rb +221 -0
  219. data/lib/VoucherifySdk/models/loyalty_pending_points_details_order.rb +221 -0
  220. data/lib/VoucherifySdk/models/loyalty_points_bucket.rb +323 -0
  221. data/lib/VoucherifySdk/models/loyalty_points_bucket_bucket.rb +210 -0
  222. data/lib/VoucherifySdk/models/loyalty_tier_expiration.rb +1 -1
  223. data/lib/VoucherifySdk/models/order.rb +3 -3
  224. data/lib/VoucherifySdk/models/order_calculated.rb +29 -29
  225. data/lib/VoucherifySdk/models/order_calculated_item.rb +18 -6
  226. data/lib/VoucherifySdk/models/order_calculated_item_product.rb +1 -1
  227. data/lib/VoucherifySdk/models/order_calculated_item_sku.rb +16 -5
  228. data/lib/VoucherifySdk/models/order_item.rb +1 -1
  229. data/lib/VoucherifySdk/models/order_item_product.rb +1 -1
  230. data/lib/VoucherifySdk/models/order_item_sku.rb +16 -5
  231. data/lib/VoucherifySdk/models/order_redemptions_entry.rb +1 -1
  232. data/lib/VoucherifySdk/models/orders_create_request_body.rb +3 -3
  233. data/lib/VoucherifySdk/models/orders_create_response_body.rb +29 -29
  234. data/lib/VoucherifySdk/models/orders_get_response_body.rb +29 -29
  235. data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +3 -3
  236. data/lib/VoucherifySdk/models/orders_update_request_body.rb +3 -3
  237. data/lib/VoucherifySdk/models/orders_update_response_body.rb +29 -29
  238. data/lib/VoucherifySdk/models/parameter_expand_list_campaigns.rb +2 -1
  239. data/lib/VoucherifySdk/models/parameter_order_list_pending_points.rb +40 -0
  240. data/lib/VoucherifySdk/models/product.rb +1 -1
  241. data/lib/VoucherifySdk/models/product_collections_products_list_response_body_data_item.rb +1 -1
  242. data/lib/VoucherifySdk/models/product_without_skus.rb +1 -1
  243. data/lib/VoucherifySdk/models/products_create_response_body.rb +1 -1
  244. data/lib/VoucherifySdk/models/products_get_response_body.rb +1 -1
  245. data/lib/VoucherifySdk/models/products_skus_create_response_body.rb +1 -1
  246. data/lib/VoucherifySdk/models/products_skus_update_response_body.rb +1 -1
  247. data/lib/VoucherifySdk/models/products_update_response_body.rb +1 -1
  248. data/lib/VoucherifySdk/models/qualifications_option.rb +3 -3
  249. data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +1 -1
  250. data/lib/VoucherifySdk/models/redeemable_voucher_loyalty_card.rb +17 -6
  251. data/lib/VoucherifySdk/models/redemption_entry_order.rb +29 -29
  252. data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb +17 -6
  253. data/lib/VoucherifySdk/models/redemption_voucher_loyalty_card.rb +17 -6
  254. data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +29 -29
  255. data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_loyalty_card.rb +17 -6
  256. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +28 -29
  257. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_loyalty_card.rb +17 -6
  258. data/lib/VoucherifySdk/models/simple_loyalty_card.rb +17 -6
  259. data/lib/VoucherifySdk/models/sku.rb +1 -1
  260. data/lib/VoucherifySdk/models/skus_get_response_body.rb +1 -1
  261. data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +11 -2
  262. data/lib/VoucherifySdk/models/validations_redeemable_inapplicable.rb +18 -7
  263. data/lib/VoucherifySdk/models/validations_redeemable_skipped.rb +18 -7
  264. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item.rb +18 -7
  265. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_discount.rb +1 -0
  266. data/lib/VoucherifySdk/models/voucher_balance.rb +305 -0
  267. data/lib/VoucherifySdk/models/voucher_balance_related_object.rb +247 -0
  268. data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +17 -6
  269. data/lib/VoucherifySdk/models/voucher_transaction.rb +27 -31
  270. data/lib/VoucherifySdk/models/voucher_transaction_details.rb +20 -2
  271. data/lib/VoucherifySdk/models/voucher_transaction_details_balance.rb +18 -19
  272. data/lib/VoucherifySdk/models/voucher_transaction_details_balance_related_object.rb +1 -7
  273. data/lib/VoucherifySdk/models/voucher_transaction_details_custom_event.rb +2 -2
  274. data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb +1 -1
  275. data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb +2 -2
  276. data/lib/VoucherifySdk/models/voucher_transaction_details_holder_loyalty_tier.rb +221 -0
  277. data/lib/VoucherifySdk/models/voucher_transaction_details_loyalty_tier.rb +3 -1
  278. data/lib/VoucherifySdk/models/voucher_transaction_details_rollback.rb +1 -1
  279. data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb +2 -0
  280. data/lib/VoucherifySdk/models/voucher_with_categories_loyalty_card.rb +17 -6
  281. data/lib/VoucherifySdk/models/vouchers_balance_update_response_body.rb +1 -0
  282. data/lib/VoucherifySdk/models/vouchers_create_response_body_loyalty_card.rb +17 -6
  283. data/lib/VoucherifySdk/models/vouchers_disable_response_body_loyalty_card.rb +17 -6
  284. data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +17 -6
  285. data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +17 -6
  286. data/lib/VoucherifySdk/models/vouchers_update_response_body_loyalty_card.rb +17 -6
  287. data/lib/VoucherifySdk/version.rb +1 -1
  288. data/lib/VoucherifySdk.rb +35 -0
  289. metadata +106 -36
data/docs/LoyaltiesApi.md CHANGED
@@ -4,11 +4,13 @@ All URIs are relative to *https://api.voucherify.io*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**activate_member_pending_points**](LoyaltiesApi.md#activate_member_pending_points) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | Activate Member Pending Points |
7
8
  | [**add_member**](LoyaltiesApi.md#add_member) | **POST** /v1/loyalties/{campaignId}/members | Add Member |
9
+ | [**cancel_member_pending_points**](LoyaltiesApi.md#cancel_member_pending_points) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | Cancel Member Pending Points |
8
10
  | [**create_earning_rule**](LoyaltiesApi.md#create_earning_rule) | **POST** /v1/loyalties/{campaignId}/earning-rules | Create Earning Rule |
9
11
  | [**create_in_bulk_loyalty_tiers**](LoyaltiesApi.md#create_in_bulk_loyalty_tiers) | **POST** /v1/loyalties/{campaignId}/tiers | Create loyalty tiers |
10
12
  | [**create_loyalty_program**](LoyaltiesApi.md#create_loyalty_program) | **POST** /v1/loyalties | Create Loyalty Campaign |
11
- | [**create_points_expiration_export**](LoyaltiesApi.md#create_points_expiration_export) | **POST** /v1/loyalties/{campaignId}/points-expiration/export | Create Points Expiration Export |
13
+ | [**create_points_expiration_export**](LoyaltiesApi.md#create_points_expiration_export) | **POST** /v1/loyalties/{campaignId}/points-expiration/export | Export Loyalty Campaign Point Expiration |
12
14
  | [**create_reward_assignment1**](LoyaltiesApi.md#create_reward_assignment1) | **POST** /v1/loyalties/{campaignId}/rewards | Create Reward Assignment |
13
15
  | [**delete_earning_rule**](LoyaltiesApi.md#delete_earning_rule) | **DELETE** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule |
14
16
  | [**delete_loyalty_program**](LoyaltiesApi.md#delete_loyalty_program) | **DELETE** /v1/loyalties/{campaignId} | Delete Loyalty Campaign |
@@ -25,6 +27,7 @@ All URIs are relative to *https://api.voucherify.io*
25
27
  | [**get_reward_assignment1**](LoyaltiesApi.md#get_reward_assignment1) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Reward Assignment |
26
28
  | [**get_reward_assignment2**](LoyaltiesApi.md#get_reward_assignment2) | **GET** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Reward Assignment |
27
29
  | [**get_reward_details**](LoyaltiesApi.md#get_reward_details) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details |
30
+ | [**list_campaign_pending_points**](LoyaltiesApi.md#list_campaign_pending_points) | **GET** /v1/loyalties/{campaignId}/pending-points | List Campaign Pending Points |
28
31
  | [**list_earning_rules**](LoyaltiesApi.md#list_earning_rules) | **GET** /v1/loyalties/{campaignId}/earning-rules | List Earning Rules |
29
32
  | [**list_loyalty_card_transactions**](LoyaltiesApi.md#list_loyalty_card_transactions) | **GET** /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions |
30
33
  | [**list_loyalty_card_transactions1**](LoyaltiesApi.md#list_loyalty_card_transactions1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions |
@@ -35,9 +38,11 @@ All URIs are relative to *https://api.voucherify.io*
35
38
  | [**list_member_activity**](LoyaltiesApi.md#list_member_activity) | **GET** /v1/loyalties/members/{memberId}/activity | List Member Activity |
36
39
  | [**list_member_activity1**](LoyaltiesApi.md#list_member_activity1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/activity | List Member Activity |
37
40
  | [**list_member_loyalty_tier**](LoyaltiesApi.md#list_member_loyalty_tier) | **GET** /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers |
41
+ | [**list_member_pending_points**](LoyaltiesApi.md#list_member_pending_points) | **GET** /v1/loyalties/members/{memberId}/pending-points | List Member Pending Points |
42
+ | [**list_member_pending_points1**](LoyaltiesApi.md#list_member_pending_points1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/pending-points | List Member Pending Points |
38
43
  | [**list_member_rewards**](LoyaltiesApi.md#list_member_rewards) | **GET** /v1/loyalties/members/{memberId}/rewards | List Member Rewards |
39
44
  | [**list_members**](LoyaltiesApi.md#list_members) | **GET** /v1/loyalties/{campaignId}/members | List Members |
40
- | [**list_points_expiration**](LoyaltiesApi.md#list_points_expiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | Get Points Expiration |
45
+ | [**list_points_expiration**](LoyaltiesApi.md#list_points_expiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | List Loyalty Card Point Expiration |
41
46
  | [**list_reward_assignments1**](LoyaltiesApi.md#list_reward_assignments1) | **GET** /v1/loyalties/{campaignId}/reward-assignments | List Reward Assignments |
42
47
  | [**list_reward_assignments2**](LoyaltiesApi.md#list_reward_assignments2) | **GET** /v1/loyalties/{campaignId}/rewards | List Reward Assignments |
43
48
  | [**redeem_reward**](LoyaltiesApi.md#redeem_reward) | **POST** /v1/loyalties/members/{memberId}/redemption | Redeem Reward |
@@ -50,6 +55,66 @@ All URIs are relative to *https://api.voucherify.io*
50
55
  | [**update_reward_assignment1**](LoyaltiesApi.md#update_reward_assignment1) | **PUT** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Update Reward Assignment |
51
56
 
52
57
 
58
+ ## activate_member_pending_points
59
+
60
+ > <LoyaltiesMembersPendingPointsActivateResponseBody> activate_member_pending_points(member_id, pending_points_id)
61
+
62
+ Activate Member Pending Points
63
+
64
+ >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member (with campaign ID, without campaign ID), List campaign pending points. This **POST** method does not require a request body.
65
+
66
+ ### Examples
67
+
68
+ ```ruby
69
+ require 'time'
70
+ require 'VoucherifySdk'
71
+ # setup authorization
72
+ VoucherifySdk.configure do |config|
73
+ # Configure API key authorization: X-App-Id
74
+ config.api_key['X-App-Id'] = 'YOUR API KEY'
75
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
76
+ # config.api_key_prefix['X-App-Id'] = 'Bearer'
77
+
78
+ # Configure API key authorization: X-App-Token
79
+ config.api_key['X-App-Token'] = 'YOUR API KEY'
80
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
81
+ # config.api_key_prefix['X-App-Token'] = 'Bearer'
82
+ end
83
+
84
+ api_instance = VoucherifySdk::LoyaltiesApi.new
85
+ member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
86
+ pending_points_id = 'pending_points_id_example' # String | Unique pending point identifier, assigned by Voucherify.
87
+
88
+ begin
89
+ # Activate Member Pending Points
90
+ result = api_instance.activate_member_pending_points(member_id, pending_points_id)
91
+ p result
92
+ rescue VoucherifySdk::ApiError => e
93
+ puts "Error when calling LoyaltiesApi->activate_member_pending_points: #{e}"
94
+ end
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+ | Name | Type | Description | Notes |
100
+ | ---- | ---- | ----------- | ----- |
101
+ | **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
102
+ | **pending_points_id** | **String** | Unique pending point identifier, assigned by Voucherify. | |
103
+
104
+ ### Return type
105
+
106
+ [**LoyaltiesMembersPendingPointsActivateResponseBody**](LoyaltiesMembersPendingPointsActivateResponseBody.md)
107
+
108
+ ### Authorization
109
+
110
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
111
+
112
+ ### HTTP request headers
113
+
114
+ - **Content-Type**: Not defined
115
+ - **Accept**: application/json
116
+
117
+
53
118
  ## add_member
54
119
 
55
120
  > <LoyaltiesMembersCreateResponseBody> add_member(campaign_id, opts)
@@ -112,6 +177,65 @@ end
112
177
  - **Accept**: application/json
113
178
 
114
179
 
180
+ ## cancel_member_pending_points
181
+
182
+ > cancel_member_pending_points(member_id, pending_points_id)
183
+
184
+ Cancel Member Pending Points
185
+
186
+ >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member (with campaign ID, without campaign ID), List campaign pending points. This **POST** method does not require a request body and it returns an empty, 204, response.
187
+
188
+ ### Examples
189
+
190
+ ```ruby
191
+ require 'time'
192
+ require 'VoucherifySdk'
193
+ # setup authorization
194
+ VoucherifySdk.configure do |config|
195
+ # Configure API key authorization: X-App-Id
196
+ config.api_key['X-App-Id'] = 'YOUR API KEY'
197
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
198
+ # config.api_key_prefix['X-App-Id'] = 'Bearer'
199
+
200
+ # Configure API key authorization: X-App-Token
201
+ config.api_key['X-App-Token'] = 'YOUR API KEY'
202
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
203
+ # config.api_key_prefix['X-App-Token'] = 'Bearer'
204
+ end
205
+
206
+ api_instance = VoucherifySdk::LoyaltiesApi.new
207
+ member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
208
+ pending_points_id = 'pending_points_id_example' # String | Unique pending point identifier, assigned by Voucherify.
209
+
210
+ begin
211
+ # Cancel Member Pending Points
212
+ api_instance.cancel_member_pending_points(member_id, pending_points_id)
213
+ rescue VoucherifySdk::ApiError => e
214
+ puts "Error when calling LoyaltiesApi->cancel_member_pending_points: #{e}"
215
+ end
216
+ ```
217
+
218
+ ### Parameters
219
+
220
+ | Name | Type | Description | Notes |
221
+ | ---- | ---- | ----------- | ----- |
222
+ | **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
223
+ | **pending_points_id** | **String** | Unique pending point identifier, assigned by Voucherify. | |
224
+
225
+ ### Return type
226
+
227
+ nil (empty response body)
228
+
229
+ ### Authorization
230
+
231
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
232
+
233
+ ### HTTP request headers
234
+
235
+ - **Content-Type**: Not defined
236
+ - **Accept**: Not defined
237
+
238
+
115
239
  ## create_earning_rule
116
240
 
117
241
  > <Array<LoyaltiesEarningRulesCreateResponseBody>> create_earning_rule(campaign_id, opts)
@@ -300,7 +424,7 @@ end
300
424
 
301
425
  > <LoyaltiesPointsExpirationExportCreateResponseBody> create_points_expiration_export(campaign_id, opts)
302
426
 
303
- Create Points Expiration Export
427
+ Export Loyalty Campaign Point Expiration
304
428
 
305
429
  Schedule the generation of a points expiration CSV file for a particular campaign.
306
430
 
@@ -329,7 +453,7 @@ opts = {
329
453
  }
330
454
 
331
455
  begin
332
- # Create Points Expiration Export
456
+ # Export Loyalty Campaign Point Expiration
333
457
  result = api_instance.create_points_expiration_export(campaign_id, opts)
334
458
  p result
335
459
  rescue VoucherifySdk::ApiError => e
@@ -628,7 +752,7 @@ end
628
752
 
629
753
  api_instance = VoucherifySdk::LoyaltiesApi.new
630
754
  campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
631
- earning_rule_id = 'earning_rule_id_example' # String | Unique earning rule ID.
755
+ earning_rule_id = 'earning_rule_id_example' # String | Unique identifier of an earning rule, assigned by Voucherify.
632
756
 
633
757
  begin
634
758
  # Disable Earning Rule
@@ -644,7 +768,7 @@ end
644
768
  | Name | Type | Description | Notes |
645
769
  | ---- | ---- | ----------- | ----- |
646
770
  | **campaign_id** | **String** | Unique campaign ID or name. | |
647
- | **earning_rule_id** | **String** | Unique earning rule ID. | |
771
+ | **earning_rule_id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | |
648
772
 
649
773
  ### Return type
650
774
 
@@ -688,7 +812,7 @@ end
688
812
 
689
813
  api_instance = VoucherifySdk::LoyaltiesApi.new
690
814
  campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
691
- earning_rule_id = 'earning_rule_id_example' # String | Unique earning rule ID.
815
+ earning_rule_id = 'earning_rule_id_example' # String | Unique identifier of an earning rule, assigned by Voucherify.
692
816
 
693
817
  begin
694
818
  # Enable Earning Rule
@@ -704,7 +828,7 @@ end
704
828
  | Name | Type | Description | Notes |
705
829
  | ---- | ---- | ----------- | ----- |
706
830
  | **campaign_id** | **String** | Unique campaign ID or name. | |
707
- | **earning_rule_id** | **String** | Unique earning rule ID. | |
831
+ | **earning_rule_id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | |
708
832
 
709
833
  ### Return type
710
834
 
@@ -1322,6 +1446,72 @@ end
1322
1446
  - **Accept**: application/json
1323
1447
 
1324
1448
 
1449
+ ## list_campaign_pending_points
1450
+
1451
+ > <LoyaltiesPendingPointsListResponseBody> list_campaign_pending_points(campaign_id, opts)
1452
+
1453
+ List Campaign Pending Points
1454
+
1455
+ >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned.
1456
+
1457
+ ### Examples
1458
+
1459
+ ```ruby
1460
+ require 'time'
1461
+ require 'VoucherifySdk'
1462
+ # setup authorization
1463
+ VoucherifySdk.configure do |config|
1464
+ # Configure API key authorization: X-App-Id
1465
+ config.api_key['X-App-Id'] = 'YOUR API KEY'
1466
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1467
+ # config.api_key_prefix['X-App-Id'] = 'Bearer'
1468
+
1469
+ # Configure API key authorization: X-App-Token
1470
+ config.api_key['X-App-Token'] = 'YOUR API KEY'
1471
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1472
+ # config.api_key_prefix['X-App-Token'] = 'Bearer'
1473
+ end
1474
+
1475
+ api_instance = VoucherifySdk::LoyaltiesApi.new
1476
+ campaign_id = 'campaign_id_example' # String | Unique campaign ID.
1477
+ opts = {
1478
+ limit: 56, # Integer | Limit the number of the pending point entries that the API returns in the response.
1479
+ order: VoucherifySdk::ParameterOrderListPendingPoints::ID, # ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
1480
+ starting_after_id: 'starting_after_id_example' # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
1481
+ }
1482
+
1483
+ begin
1484
+ # List Campaign Pending Points
1485
+ result = api_instance.list_campaign_pending_points(campaign_id, opts)
1486
+ p result
1487
+ rescue VoucherifySdk::ApiError => e
1488
+ puts "Error when calling LoyaltiesApi->list_campaign_pending_points: #{e}"
1489
+ end
1490
+ ```
1491
+
1492
+ ### Parameters
1493
+
1494
+ | Name | Type | Description | Notes |
1495
+ | ---- | ---- | ----------- | ----- |
1496
+ | **campaign_id** | **String** | Unique campaign ID. | |
1497
+ | **limit** | **Integer** | Limit the number of the pending point entries that the API returns in the response. | [optional] |
1498
+ | **order** | [**ParameterOrderListPendingPoints**](.md) | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
1499
+ | **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
1500
+
1501
+ ### Return type
1502
+
1503
+ [**LoyaltiesPendingPointsListResponseBody**](LoyaltiesPendingPointsListResponseBody.md)
1504
+
1505
+ ### Authorization
1506
+
1507
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
1508
+
1509
+ ### HTTP request headers
1510
+
1511
+ - **Content-Type**: Not defined
1512
+ - **Accept**: application/json
1513
+
1514
+
1325
1515
  ## list_earning_rules
1326
1516
 
1327
1517
  > <LoyaltiesEarningRulesListResponseBody> list_earning_rules(campaign_id, opts)
@@ -1968,6 +2158,140 @@ end
1968
2158
  - **Accept**: application/json
1969
2159
 
1970
2160
 
2161
+ ## list_member_pending_points
2162
+
2163
+ > <LoyaltiesMembersPendingPointsListResponseBody> list_member_pending_points(member_id, opts)
2164
+
2165
+ List Member Pending Points
2166
+
2167
+ >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned.
2168
+
2169
+ ### Examples
2170
+
2171
+ ```ruby
2172
+ require 'time'
2173
+ require 'VoucherifySdk'
2174
+ # setup authorization
2175
+ VoucherifySdk.configure do |config|
2176
+ # Configure API key authorization: X-App-Id
2177
+ config.api_key['X-App-Id'] = 'YOUR API KEY'
2178
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2179
+ # config.api_key_prefix['X-App-Id'] = 'Bearer'
2180
+
2181
+ # Configure API key authorization: X-App-Token
2182
+ config.api_key['X-App-Token'] = 'YOUR API KEY'
2183
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2184
+ # config.api_key_prefix['X-App-Token'] = 'Bearer'
2185
+ end
2186
+
2187
+ api_instance = VoucherifySdk::LoyaltiesApi.new
2188
+ member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
2189
+ opts = {
2190
+ limit: 56, # Integer | Limit the number of the pending point entries that the API returns in the response.
2191
+ order: VoucherifySdk::ParameterOrderListPendingPoints::ID, # ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
2192
+ starting_after_id: 'starting_after_id_example' # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
2193
+ }
2194
+
2195
+ begin
2196
+ # List Member Pending Points
2197
+ result = api_instance.list_member_pending_points(member_id, opts)
2198
+ p result
2199
+ rescue VoucherifySdk::ApiError => e
2200
+ puts "Error when calling LoyaltiesApi->list_member_pending_points: #{e}"
2201
+ end
2202
+ ```
2203
+
2204
+ ### Parameters
2205
+
2206
+ | Name | Type | Description | Notes |
2207
+ | ---- | ---- | ----------- | ----- |
2208
+ | **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
2209
+ | **limit** | **Integer** | Limit the number of the pending point entries that the API returns in the response. | [optional] |
2210
+ | **order** | [**ParameterOrderListPendingPoints**](.md) | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
2211
+ | **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
2212
+
2213
+ ### Return type
2214
+
2215
+ [**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md)
2216
+
2217
+ ### Authorization
2218
+
2219
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
2220
+
2221
+ ### HTTP request headers
2222
+
2223
+ - **Content-Type**: Not defined
2224
+ - **Accept**: application/json
2225
+
2226
+
2227
+ ## list_member_pending_points1
2228
+
2229
+ > <LoyaltiesMembersPendingPointsListResponseBody> list_member_pending_points1(campaign_id, member_id, opts)
2230
+
2231
+ List Member Pending Points
2232
+
2233
+ >🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned.
2234
+
2235
+ ### Examples
2236
+
2237
+ ```ruby
2238
+ require 'time'
2239
+ require 'VoucherifySdk'
2240
+ # setup authorization
2241
+ VoucherifySdk.configure do |config|
2242
+ # Configure API key authorization: X-App-Id
2243
+ config.api_key['X-App-Id'] = 'YOUR API KEY'
2244
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2245
+ # config.api_key_prefix['X-App-Id'] = 'Bearer'
2246
+
2247
+ # Configure API key authorization: X-App-Token
2248
+ config.api_key['X-App-Token'] = 'YOUR API KEY'
2249
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2250
+ # config.api_key_prefix['X-App-Token'] = 'Bearer'
2251
+ end
2252
+
2253
+ api_instance = VoucherifySdk::LoyaltiesApi.new
2254
+ campaign_id = 'campaign_id_example' # String | Unique campaign ID.
2255
+ member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
2256
+ opts = {
2257
+ limit: 56, # Integer | Limit the number of the pending point entries that the API returns in the response.
2258
+ order: VoucherifySdk::ParameterOrderListPendingPoints::ID, # ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
2259
+ starting_after_id: 'starting_after_id_example' # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
2260
+ }
2261
+
2262
+ begin
2263
+ # List Member Pending Points
2264
+ result = api_instance.list_member_pending_points1(campaign_id, member_id, opts)
2265
+ p result
2266
+ rescue VoucherifySdk::ApiError => e
2267
+ puts "Error when calling LoyaltiesApi->list_member_pending_points1: #{e}"
2268
+ end
2269
+ ```
2270
+
2271
+ ### Parameters
2272
+
2273
+ | Name | Type | Description | Notes |
2274
+ | ---- | ---- | ----------- | ----- |
2275
+ | **campaign_id** | **String** | Unique campaign ID. | |
2276
+ | **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
2277
+ | **limit** | **Integer** | Limit the number of the pending point entries that the API returns in the response. | [optional] |
2278
+ | **order** | [**ParameterOrderListPendingPoints**](.md) | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
2279
+ | **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
2280
+
2281
+ ### Return type
2282
+
2283
+ [**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md)
2284
+
2285
+ ### Authorization
2286
+
2287
+ [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
2288
+
2289
+ ### HTTP request headers
2290
+
2291
+ - **Content-Type**: Not defined
2292
+ - **Accept**: application/json
2293
+
2294
+
1971
2295
  ## list_member_rewards
1972
2296
 
1973
2297
  > <LoyaltiesMembersRewardsListResponseBody> list_member_rewards(member_id, opts)
@@ -2110,7 +2434,7 @@ end
2110
2434
 
2111
2435
  > <LoyaltiesMembersPointsExpirationListResponseBody> list_points_expiration(campaign_id, member_id, opts)
2112
2436
 
2113
- Get Points Expiration
2437
+ List Loyalty Card Point Expiration
2114
2438
 
2115
2439
  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.
2116
2440
 
@@ -2141,7 +2465,7 @@ opts = {
2141
2465
  }
2142
2466
 
2143
2467
  begin
2144
- # Get Points Expiration
2468
+ # List Loyalty Card Point Expiration
2145
2469
  result = api_instance.list_points_expiration(campaign_id, member_id, opts)
2146
2470
  p result
2147
2471
  rescue VoucherifySdk::ApiError => e
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **name** | **String** | Campaign name. | [optional] |
8
8
  | **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
9
- | **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation. - &#x60;AUTO_UPDATE&#x60;: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - &#x60;STATIC&#x60;: vouchers need to be manually published. | [optional] |
9
+ | **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - &#x60;AUTO_UPDATE&#x60;: the campaign is dynamic, i.e. vouchers will generate based on set criteria - &#x60;STATIC&#x60;: vouchers need to be manually published | [optional] |
10
10
  | **join_once** | **Boolean** | If this value is set to &#x60;true&#x60;, customers will be able to join the campaign only once. | [optional] |
11
11
  | **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
12
12
  | **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher&#39;s metadata schema instead of the campaign metadata schema. | [optional] |
@@ -20,6 +20,7 @@
20
20
  | **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the &#x60;category&#x60;. | [optional] |
21
21
  | **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the &#x60;category_id&#x60;. | [optional] |
22
22
  | **metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] |
23
+ | **access_settings** | [**AccessSettings**](AccessSettings.md) | | [optional] |
23
24
  | **validation_rules** | **Array&lt;String&gt;** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] |
24
25
  | **campaign_type** | **String** | Type of campaign. | [optional][default to &#39;LOYALTY_PROGRAM&#39;] |
25
26
  | **voucher** | [**CampaignLoyaltyVoucher**](CampaignLoyaltyVoucher.md) | | [optional] |
@@ -11,6 +11,7 @@
11
11
  | **custom_event** | [**LoyaltiesEarningRulesCreateResponseBodyCustomEvent**](LoyaltiesEarningRulesCreateResponseBodyCustomEvent.md) | | [optional] |
12
12
  | **segment** | [**LoyaltiesEarningRulesCreateResponseBodySegment**](LoyaltiesEarningRulesCreateResponseBodySegment.md) | | [optional] |
13
13
  | **loyalty_tier** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier.md) | | [optional] |
14
+ | **pending_points** | [**LoyaltiesEarningRulesCreateResponseBodyPendingPoints**](LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md) | | [optional] |
14
15
  | **source** | [**LoyaltiesEarningRulesCreateResponseBodySource**](LoyaltiesEarningRulesCreateResponseBodySource.md) | | [optional] |
15
16
  | **object** | **String** | The type of the object represented by JSON. Default is earning_rule. | [optional][default to &#39;earning_rule&#39;] |
16
17
  | **automation_id** | **String** | For internal use by Voucherify. | [optional] |
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltiesEarningRulesCreateResponseBodyPendingPoints
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **period_type** | **String** | Defines the type of the period during which the points are in the pending state. Currently, only &#x60;DAY&#x60; value is accepted. | [optional][default to &#39;DAY&#39;] |
8
+ | **period_value** | **Integer** | Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90. | [optional] |
9
+
@@ -11,6 +11,7 @@
11
11
  | **custom_event** | [**LoyaltiesEarningRulesDisableResponseBodyCustomEvent**](LoyaltiesEarningRulesDisableResponseBodyCustomEvent.md) | | [optional] |
12
12
  | **segment** | [**LoyaltiesEarningRulesDisableResponseBodySegment**](LoyaltiesEarningRulesDisableResponseBodySegment.md) | | [optional] |
13
13
  | **loyalty_tier** | [**LoyaltiesEarningRulesDisableResponseBodyLoyaltyTier**](LoyaltiesEarningRulesDisableResponseBodyLoyaltyTier.md) | | [optional] |
14
+ | **pending_points** | [**LoyaltiesEarningRulesDisableResponseBodyPendingPoints**](LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md) | | [optional] |
14
15
  | **source** | [**LoyaltiesEarningRulesDisableResponseBodySource**](LoyaltiesEarningRulesDisableResponseBodySource.md) | | [optional] |
15
16
  | **object** | **String** | The type of the object represented by JSON. Default is earning_rule. | [optional][default to &#39;earning_rule&#39;] |
16
17
  | **automation_id** | **String** | For internal use by Voucherify. | [optional] |
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltiesEarningRulesDisableResponseBodyPendingPoints
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **period_type** | **String** | Defines the type of the period during which the points are in the pending state. Currently, only &#x60;DAY&#x60; value is accepted. | [optional][default to &#39;DAY&#39;] |
8
+ | **period_value** | **Integer** | Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90. | [optional] |
9
+
@@ -11,6 +11,7 @@
11
11
  | **custom_event** | [**LoyaltiesEarningRulesEnableResponseBodyCustomEvent**](LoyaltiesEarningRulesEnableResponseBodyCustomEvent.md) | | [optional] |
12
12
  | **segment** | [**LoyaltiesEarningRulesEnableResponseBodySegment**](LoyaltiesEarningRulesEnableResponseBodySegment.md) | | [optional] |
13
13
  | **loyalty_tier** | [**LoyaltiesEarningRulesEnableResponseBodyLoyaltyTier**](LoyaltiesEarningRulesEnableResponseBodyLoyaltyTier.md) | | [optional] |
14
+ | **pending_points** | [**LoyaltiesEarningRulesEnableResponseBodyPendingPoints**](LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md) | | [optional] |
14
15
  | **source** | [**LoyaltiesEarningRulesEnableResponseBodySource**](LoyaltiesEarningRulesEnableResponseBodySource.md) | | [optional] |
15
16
  | **object** | **String** | The type of the object represented by JSON. Default is earning_rule. | [optional][default to &#39;earning_rule&#39;] |
16
17
  | **automation_id** | **String** | For internal use by Voucherify. | [optional] |
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltiesEarningRulesEnableResponseBodyPendingPoints
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **period_type** | **String** | Defines the type of the period during which the points are in the pending state. Currently, only &#x60;DAY&#x60; value is accepted. | [optional][default to &#39;DAY&#39;] |
8
+ | **period_value** | **Integer** | Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90. | [optional] |
9
+
@@ -11,6 +11,7 @@
11
11
  | **custom_event** | [**LoyaltiesEarningRulesGetResponseBodyCustomEvent**](LoyaltiesEarningRulesGetResponseBodyCustomEvent.md) | | [optional] |
12
12
  | **segment** | [**LoyaltiesEarningRulesGetResponseBodySegment**](LoyaltiesEarningRulesGetResponseBodySegment.md) | | [optional] |
13
13
  | **loyalty_tier** | [**LoyaltiesEarningRulesGetResponseBodyLoyaltyTier**](LoyaltiesEarningRulesGetResponseBodyLoyaltyTier.md) | | [optional] |
14
+ | **pending_points** | [**LoyaltiesEarningRulesGetResponseBodyPendingPoints**](LoyaltiesEarningRulesGetResponseBodyPendingPoints.md) | | [optional] |
14
15
  | **source** | [**LoyaltiesEarningRulesGetResponseBodySource**](LoyaltiesEarningRulesGetResponseBodySource.md) | | [optional] |
15
16
  | **object** | **String** | The type of the object represented by JSON. Default is earning_rule. | [optional][default to &#39;earning_rule&#39;] |
16
17
  | **automation_id** | **String** | For internal use by Voucherify. | [optional] |
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltiesEarningRulesGetResponseBodyPendingPoints
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **period_type** | **String** | Defines the type of the period during which the points are in the pending state. Currently, only &#x60;DAY&#x60; value is accepted. | [optional][default to &#39;DAY&#39;] |
8
+ | **period_value** | **Integer** | Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90. | [optional] |
9
+
@@ -11,6 +11,7 @@
11
11
  | **custom_event** | [**LoyaltiesEarningRulesUpdateResponseBodyCustomEvent**](LoyaltiesEarningRulesUpdateResponseBodyCustomEvent.md) | | [optional] |
12
12
  | **segment** | [**LoyaltiesEarningRulesUpdateResponseBodySegment**](LoyaltiesEarningRulesUpdateResponseBodySegment.md) | | [optional] |
13
13
  | **loyalty_tier** | [**LoyaltiesEarningRulesUpdateResponseBodyLoyaltyTier**](LoyaltiesEarningRulesUpdateResponseBodyLoyaltyTier.md) | | [optional] |
14
+ | **pending_points** | [**LoyaltiesEarningRulesUpdateResponseBodyPendingPoints**](LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md) | | [optional] |
14
15
  | **source** | [**LoyaltiesEarningRulesUpdateResponseBodySource**](LoyaltiesEarningRulesUpdateResponseBodySource.md) | | [optional] |
15
16
  | **object** | **String** | The type of the object represented by JSON. Default is earning_rule. | [optional][default to &#39;earning_rule&#39;] |
16
17
  | **automation_id** | **String** | For internal use by Voucherify. | [optional] |
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltiesEarningRulesUpdateResponseBodyPendingPoints
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **period_type** | **String** | Defines the type of the period during which the points are in the pending state. Currently, only &#x60;DAY&#x60; value is accepted. | [optional][default to &#39;DAY&#39;] |
8
+ | **period_value** | **Integer** | Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90. | [optional] |
9
+
@@ -10,5 +10,5 @@
10
10
  | **type** | **String** | The type of voucher being modified. | [optional] |
11
11
  | **object** | **String** | The type of the object represented by JSON. Default is balance. | [optional][default to &#39;balance&#39;] |
12
12
  | **related_object** | [**LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject**](LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject.md) | | [optional] |
13
- | **operation_type** | **String** | | [optional] |
13
+ | **operation_type** | **String** | The type of operation being performed. | [optional] |
14
14
 
@@ -4,8 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
7
+ | **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] |
8
8
  | **balance** | **Integer** | Points available for reward redemption. | [optional] |
9
9
  | **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
10
10
  | **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
11
+ | **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
11
12
 
@@ -4,8 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
7
+ | **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] |
8
8
  | **balance** | **Integer** | Points available for reward redemption. | [optional] |
9
9
  | **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
10
10
  | **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
11
+ | **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
11
12
 
@@ -0,0 +1,14 @@
1
+ # VoucherifySdk::LoyaltiesMembersPendingPointsActivateResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **points** | **Integer** | The number of pending points added to the loyalty card. | [optional] |
8
+ | **total** | **Integer** | Total number of points incurred over the lifespan of the loyalty card, minus the expired points. | [optional] |
9
+ | **balance** | **Integer** | The current number of loyalty points after the pendint points have been added. | [optional] |
10
+ | **type** | **String** | The type of the voucher being modified. For pending points, it is always &#x60;loyalty_card&#x60;. | [optional][default to &#39;loyalty_card&#39;] |
11
+ | **object** | **String** | The type of the object represented by JSON. Default is &#x60;balance&#x60;. | [optional][default to &#39;balance&#39;] |
12
+ | **related_object** | [**LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject**](LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md) | | [optional] |
13
+ | **operation_type** | **String** | The type of the operation being performed. | [optional][default to &#39;MANUAL&#39;] |
14
+
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | The object being modified, i.e. &#x60;voucher&#x60;. | [optional][default to &#39;voucher&#39;] |
8
+ | **id** | **String** | Identifies the voucher that is being modified. This is the unique identifer that was assigned by Voucherify. | [optional] |
9
+
@@ -0,0 +1,12 @@
1
+ # VoucherifySdk::LoyaltiesMembersPendingPointsListResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object** | **String** | The type of the object represented by JSON. | [optional][default to &#39;list&#39;] |
8
+ | **data_ref** | **String** | Identifies the name of the attribute that contains the array of pending point objects. | [optional][default to &#39;data&#39;] |
9
+ | **data** | [**Array&lt;LoyaltyPendingPoints&gt;**](LoyaltyPendingPoints.md) | A dictionary that contains an array of pending point entries. Each entry in the array is a separate pending point object. | [optional] |
10
+ | **has_more** | **Boolean** | As query results are always limited (by the limit parameter), the &#x60;has_more&#x60; flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results. | [optional] |
11
+ | **more_starting_after** | **String** | Returns an ID that can be used to return another page of results. Use the pending point entry ID in the &#x60;starting_after_id&#x60; query parameter to display another page of the results starting after the entry with that ID. | [optional] |
12
+