voucherify 8.0.2 → 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 (214) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +1 -1
  3. data/ENDPOINTS-COVERAGE.md +53 -48
  4. data/Gemfile.lock +8 -6
  5. data/README.md +44 -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 +1 -1
  16. data/docs/CampaignBase.md +1 -0
  17. data/docs/CampaignsCreateRequestBody.md +1 -0
  18. data/docs/CampaignsCreateResponseBody.md +1 -1
  19. data/docs/CampaignsGetResponseBody.md +1 -1
  20. data/docs/CampaignsUpdateRequestBody.md +1 -0
  21. data/docs/CampaignsUpdateResponseBody.md +1 -1
  22. data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +2 -1
  23. data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +2 -1
  24. data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +1 -1
  25. data/docs/CustomerLoyalty.md +1 -1
  26. data/docs/Discount.md +1 -1
  27. data/docs/DiscountUnitMultipleOneUnit.md +1 -1
  28. data/docs/EarningRule.md +1 -0
  29. data/docs/EarningRulePendingPoints.md +9 -0
  30. data/docs/EventSource.md +10 -0
  31. data/docs/EventSourceApiKey.md +9 -0
  32. data/docs/EventSourceUser.md +8 -0
  33. data/docs/InapplicableTo.md +3 -2
  34. data/docs/InapplicableToOrderItemUnitsItem.md +9 -0
  35. data/docs/LoyaltiesApi.md +334 -10
  36. data/docs/LoyaltiesCreateCampaignRequestBody.md +1 -0
  37. data/docs/LoyaltiesEarningRulesCreateResponseBody.md +1 -0
  38. data/docs/LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md +9 -0
  39. data/docs/LoyaltiesEarningRulesDisableResponseBody.md +1 -0
  40. data/docs/LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md +9 -0
  41. data/docs/LoyaltiesEarningRulesEnableResponseBody.md +1 -0
  42. data/docs/LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md +9 -0
  43. data/docs/LoyaltiesEarningRulesGetResponseBody.md +1 -0
  44. data/docs/LoyaltiesEarningRulesGetResponseBodyPendingPoints.md +9 -0
  45. data/docs/LoyaltiesEarningRulesUpdateResponseBody.md +1 -0
  46. data/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md +9 -0
  47. data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +2 -1
  48. data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +2 -1
  49. data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +14 -0
  50. data/docs/LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md +9 -0
  51. data/docs/LoyaltiesMembersPendingPointsListResponseBody.md +12 -0
  52. data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +2 -1
  53. data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +2 -1
  54. data/docs/LoyaltiesPendingPointsListResponseBody.md +12 -0
  55. data/docs/LoyaltiesUpdateCampaignRequestBody.md +1 -0
  56. data/docs/LoyaltyCardTransactionDetails.md +2 -0
  57. data/docs/LoyaltyCardTransactionDetailsEarningRule.md +1 -1
  58. data/docs/LoyaltyCardTransactionDetailsHolderLoyaltyTier.md +9 -0
  59. data/docs/LoyaltyCardTransactionDetailsLoyaltyTier.md +2 -2
  60. data/docs/LoyaltyMemberLoyaltyCard.md +2 -1
  61. data/docs/LoyaltyPendingPoints.md +17 -0
  62. data/docs/LoyaltyPendingPointsDetails.md +12 -0
  63. data/docs/LoyaltyPendingPointsDetailsEarningRule.md +9 -0
  64. data/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md +8 -0
  65. data/docs/LoyaltyPendingPointsDetailsEvent.md +14 -0
  66. data/docs/LoyaltyPendingPointsDetailsHolderLoyaltyTier.md +9 -0
  67. data/docs/LoyaltyPendingPointsDetailsLoyaltyTier.md +9 -0
  68. data/docs/LoyaltyPendingPointsDetailsOrder.md +9 -0
  69. data/docs/LoyaltyTierExpiration.md +1 -1
  70. data/docs/Order.md +2 -2
  71. data/docs/OrderCalculated.md +11 -11
  72. data/docs/OrderCalculatedItem.md +1 -0
  73. data/docs/OrderRedemptionsEntry.md +1 -1
  74. data/docs/OrdersCreateRequestBody.md +2 -2
  75. data/docs/OrdersCreateResponseBody.md +11 -11
  76. data/docs/OrdersGetResponseBody.md +11 -11
  77. data/docs/OrdersImportCreateRequestBodyItem.md +2 -2
  78. data/docs/OrdersUpdateRequestBody.md +2 -2
  79. data/docs/OrdersUpdateResponseBody.md +11 -11
  80. data/docs/ParameterOrderListPendingPoints.md +7 -0
  81. data/docs/RedeemableLoyaltyCard.md +1 -1
  82. data/docs/RedeemableVoucherLoyaltyCard.md +2 -1
  83. data/docs/RedemptionEntryOrder.md +11 -11
  84. data/docs/RedemptionEntryVoucherLoyaltyCard.md +2 -1
  85. data/docs/RedemptionVoucherLoyaltyCard.md +2 -1
  86. data/docs/RedemptionsGetResponseBodyOrder.md +11 -11
  87. data/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +2 -1
  88. data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +11 -11
  89. data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +2 -1
  90. data/docs/SimpleLoyaltyCard.md +2 -1
  91. data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +1 -0
  92. data/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +1 -1
  93. data/docs/VoucherLoyaltyCard.md +2 -1
  94. data/docs/VoucherTransactionDetails.md +2 -0
  95. data/docs/VoucherTransactionDetailsCustomEvent.md +2 -2
  96. data/docs/VoucherTransactionDetailsEarningRule.md +1 -1
  97. data/docs/VoucherTransactionDetailsEventSchema.md +2 -2
  98. data/docs/VoucherTransactionDetailsHolderLoyaltyTier.md +9 -0
  99. data/docs/VoucherTransactionDetailsLoyaltyTier.md +2 -2
  100. data/docs/VoucherTransactionDetailsRollback.md +1 -1
  101. data/docs/VoucherTransactionDetailsSegment.md +2 -2
  102. data/docs/VoucherWithCategoriesLoyaltyCard.md +2 -1
  103. data/docs/VouchersCreateResponseBodyLoyaltyCard.md +2 -1
  104. data/docs/VouchersDisableResponseBodyLoyaltyCard.md +2 -1
  105. data/docs/VouchersEnableResponseBodyLoyaltyCard.md +2 -1
  106. data/docs/VouchersGetResponseBodyLoyaltyCard.md +2 -1
  107. data/docs/VouchersUpdateResponseBodyLoyaltyCard.md +2 -1
  108. data/lib/VoucherifySdk/api/bin_api.rb +4 -4
  109. data/lib/VoucherifySdk/api/loyalties_api.rb +334 -8
  110. data/lib/VoucherifySdk/models/access_settings.rb +219 -0
  111. data/lib/VoucherifySdk/models/access_settings_assign.rb +238 -0
  112. data/lib/VoucherifySdk/models/access_settings_unassign.rb +238 -0
  113. data/lib/VoucherifySdk/models/applicable_to.rb +16 -3
  114. data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +220 -0
  115. data/lib/VoucherifySdk/models/application_details_item.rb +284 -0
  116. data/lib/VoucherifySdk/models/area_store_campaign_assignment.rb +12 -1
  117. data/lib/VoucherifySdk/models/campaign.rb +13 -13
  118. data/lib/VoucherifySdk/models/campaign_base.rb +13 -4
  119. data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +10 -1
  120. data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +13 -13
  121. data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +13 -13
  122. data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +10 -1
  123. data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +13 -13
  124. data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_loyalty_card.rb +17 -6
  125. data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_loyalty_card.rb +17 -6
  126. data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_discount.rb +1 -0
  127. data/lib/VoucherifySdk/models/customer_loyalty.rb +1 -1
  128. data/lib/VoucherifySdk/models/discount.rb +1 -0
  129. data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -0
  130. data/lib/VoucherifySdk/models/earning_rule.rb +11 -1
  131. data/lib/VoucherifySdk/models/earning_rule_pending_points.rb +257 -0
  132. data/lib/VoucherifySdk/models/event_source.rb +254 -0
  133. data/lib/VoucherifySdk/models/event_source_api_key.rb +221 -0
  134. data/lib/VoucherifySdk/models/event_source_user.rb +210 -0
  135. data/lib/VoucherifySdk/models/inapplicable_to.rb +16 -3
  136. data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +220 -0
  137. data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +10 -1
  138. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body.rb +11 -1
  139. data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_pending_points.rb +257 -0
  140. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +11 -1
  141. data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_pending_points.rb +257 -0
  142. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +11 -1
  143. data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_pending_points.rb +257 -0
  144. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +11 -1
  145. data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_pending_points.rb +257 -0
  146. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body.rb +11 -1
  147. data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_pending_points.rb +257 -0
  148. data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +17 -6
  149. data/lib/VoucherifySdk/models/loyalties_members_get_response_body_loyalty_card.rb +17 -6
  150. data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body.rb +309 -0
  151. data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body_related_object.rb +247 -0
  152. data/lib/VoucherifySdk/models/loyalties_members_pending_points_list_response_body.rb +286 -0
  153. data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb +17 -6
  154. data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +17 -6
  155. data/lib/VoucherifySdk/models/loyalties_pending_points_list_response_body.rb +286 -0
  156. data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +10 -1
  157. data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb +20 -1
  158. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_earning_rule.rb +1 -1
  159. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_holder_loyalty_tier.rb +221 -0
  160. data/lib/VoucherifySdk/models/loyalty_card_transaction_details_loyalty_tier.rb +3 -1
  161. data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb +2 -1
  162. data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +17 -6
  163. data/lib/VoucherifySdk/models/loyalty_pending_points.rb +314 -0
  164. data/lib/VoucherifySdk/models/loyalty_pending_points_details.rb +249 -0
  165. data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule.rb +220 -0
  166. data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule_source.rb +210 -0
  167. data/lib/VoucherifySdk/models/loyalty_pending_points_details_event.rb +302 -0
  168. data/lib/VoucherifySdk/models/loyalty_pending_points_details_holder_loyalty_tier.rb +221 -0
  169. data/lib/VoucherifySdk/models/loyalty_pending_points_details_loyalty_tier.rb +221 -0
  170. data/lib/VoucherifySdk/models/loyalty_pending_points_details_order.rb +221 -0
  171. data/lib/VoucherifySdk/models/loyalty_tier_expiration.rb +1 -1
  172. data/lib/VoucherifySdk/models/order.rb +2 -2
  173. data/lib/VoucherifySdk/models/order_calculated.rb +28 -28
  174. data/lib/VoucherifySdk/models/order_calculated_item.rb +17 -5
  175. data/lib/VoucherifySdk/models/order_redemptions_entry.rb +1 -1
  176. data/lib/VoucherifySdk/models/orders_create_request_body.rb +2 -2
  177. data/lib/VoucherifySdk/models/orders_create_response_body.rb +28 -28
  178. data/lib/VoucherifySdk/models/orders_get_response_body.rb +28 -28
  179. data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +2 -2
  180. data/lib/VoucherifySdk/models/orders_update_request_body.rb +2 -2
  181. data/lib/VoucherifySdk/models/orders_update_response_body.rb +28 -28
  182. data/lib/VoucherifySdk/models/parameter_order_list_pending_points.rb +40 -0
  183. data/lib/VoucherifySdk/models/qualifications_option.rb +3 -3
  184. data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +1 -1
  185. data/lib/VoucherifySdk/models/redeemable_voucher_loyalty_card.rb +17 -6
  186. data/lib/VoucherifySdk/models/redemption_entry_order.rb +28 -28
  187. data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb +17 -6
  188. data/lib/VoucherifySdk/models/redemption_voucher_loyalty_card.rb +17 -6
  189. data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +28 -28
  190. data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_loyalty_card.rb +17 -6
  191. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +27 -28
  192. data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_loyalty_card.rb +17 -6
  193. data/lib/VoucherifySdk/models/simple_loyalty_card.rb +17 -6
  194. data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +10 -1
  195. data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_discount.rb +1 -0
  196. data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +17 -6
  197. data/lib/VoucherifySdk/models/voucher_transaction.rb +1 -1
  198. data/lib/VoucherifySdk/models/voucher_transaction_details.rb +20 -1
  199. data/lib/VoucherifySdk/models/voucher_transaction_details_custom_event.rb +2 -2
  200. data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb +1 -1
  201. data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb +2 -2
  202. data/lib/VoucherifySdk/models/voucher_transaction_details_holder_loyalty_tier.rb +221 -0
  203. data/lib/VoucherifySdk/models/voucher_transaction_details_loyalty_tier.rb +3 -1
  204. data/lib/VoucherifySdk/models/voucher_transaction_details_rollback.rb +1 -1
  205. data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb +2 -0
  206. data/lib/VoucherifySdk/models/voucher_with_categories_loyalty_card.rb +17 -6
  207. data/lib/VoucherifySdk/models/vouchers_create_response_body_loyalty_card.rb +17 -6
  208. data/lib/VoucherifySdk/models/vouchers_disable_response_body_loyalty_card.rb +17 -6
  209. data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +17 -6
  210. data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +17 -6
  211. data/lib/VoucherifySdk/models/vouchers_update_response_body_loyalty_card.rb +17 -6
  212. data/lib/VoucherifySdk/version.rb +1 -1
  213. data/lib/VoucherifySdk.rb +30 -0
  214. metadata +96 -36
data/docs/LoyaltiesEarningRulesDisableResponseBody.md CHANGED
@@ -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 'earning_rule'] |
16
17
  | **automation_id** | **String** | For internal use by Voucherify. | [optional] |
data/docs/LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md ADDED
@@ -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 `DAY` value is accepted. | [optional][default to 'DAY'] |
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
+
data/docs/LoyaltiesEarningRulesEnableResponseBody.md CHANGED
@@ -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 'earning_rule'] |
16
17
  | **automation_id** | **String** | For internal use by Voucherify. | [optional] |
data/docs/LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md ADDED
@@ -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 `DAY` value is accepted. | [optional][default to 'DAY'] |
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
+
data/docs/LoyaltiesEarningRulesGetResponseBody.md CHANGED
@@ -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 'earning_rule'] |
16
17
  | **automation_id** | **String** | For internal use by Voucherify. | [optional] |
data/docs/LoyaltiesEarningRulesGetResponseBodyPendingPoints.md ADDED
@@ -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 `DAY` value is accepted. | [optional][default to 'DAY'] |
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
+
data/docs/LoyaltiesEarningRulesUpdateResponseBody.md CHANGED
@@ -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 'earning_rule'] |
16
17
  | **automation_id** | **String** | For internal use by Voucherify. | [optional] |
data/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md ADDED
@@ -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 `DAY` value is accepted. | [optional][default to 'DAY'] |
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
+
data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md CHANGED
@@ -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
 
data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md CHANGED
@@ -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
 
data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md ADDED
@@ -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 `loyalty_card`. | [optional][default to 'loyalty_card'] |
11
+ | **object** | **String** | The type of the object represented by JSON. Default is `balance`. | [optional][default to 'balance'] |
12
+ | **related_object** | [**LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject**](LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md) | | [optional] |
13
+ | **operation_type** | **String** | The type of the operation being performed. | [optional][default to 'MANUAL'] |
14
+
data/docs/LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md ADDED
@@ -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. `voucher`. | [optional][default to 'voucher'] |
8
+ | **id** | **String** | Identifies the voucher that is being modified. This is the unique identifer that was assigned by Voucherify. | [optional] |
9
+
data/docs/LoyaltiesMembersPendingPointsListResponseBody.md ADDED
@@ -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 'list'] |
8
+ | **data_ref** | **String** | Identifies the name of the attribute that contains the array of pending point objects. | [optional][default to 'data'] |
9
+ | **data** | [**Array<LoyaltyPendingPoints>**](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 `has_more` 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 `starting_after_id` query parameter to display another page of the results starting after the entry with that ID. | [optional] |
12
+
data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md CHANGED
@@ -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
 
data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md CHANGED
@@ -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** | **String** | 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
 
data/docs/LoyaltiesPendingPointsListResponseBody.md ADDED
@@ -0,0 +1,12 @@
1
+ # VoucherifySdk::LoyaltiesPendingPointsListResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'list'] |
8
+ | **data_ref** | **String** | Identifies the name of the attribute that contains the array of pending point objects. | [optional][default to 'data'] |
9
+ | **data** | [**Array<LoyaltyPendingPoints>**](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 `has_more` 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 `starting_after_id` query parameter to display another page of the results starting after the entry with that ID. | [optional] |
12
+
data/docs/LoyaltiesUpdateCampaignRequestBody.md CHANGED
@@ -14,6 +14,7 @@
14
14
  | **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] |
15
15
  | **unset_metadata_fields** | **Array<String>** | Determine which metadata should be removed from campaign. | [optional] |
16
16
  | **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
17
+ | **access_settings** | [**AccessSettings**](AccessSettings.md) | | [optional] |
17
18
  | **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
18
19
  | **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
19
20
  | **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
data/docs/LoyaltyCardTransactionDetails.md CHANGED
@@ -14,6 +14,8 @@
14
14
  | **rollback** | [**LoyaltyCardTransactionDetailsRollback**](LoyaltyCardTransactionDetailsRollback.md) | | [optional] |
15
15
  | **custom_event** | [**LoyaltyCardTransactionDetailsCustomEvent**](LoyaltyCardTransactionDetailsCustomEvent.md) | | [optional] |
16
16
  | **event_schema** | [**LoyaltyCardTransactionDetailsEventSchema**](LoyaltyCardTransactionDetailsEventSchema.md) | | [optional] |
17
+ | **holder_loyalty_tier** | [**LoyaltyCardTransactionDetailsHolderLoyaltyTier**](LoyaltyCardTransactionDetailsHolderLoyaltyTier.md) | | [optional] |
18
+ | **pending_points** | [**LoyaltyPendingPoints**](LoyaltyPendingPoints.md) | | [optional] |
17
19
  | **reward** | [**LoyaltyCardTransactionDetailsReward**](LoyaltyCardTransactionDetailsReward.md) | | [optional] |
18
20
  | **source_voucher** | [**SimpleVoucher**](SimpleVoucher.md) | | [optional] |
19
21
  | **destination_voucher** | [**SimpleVoucher**](SimpleVoucher.md) | | [optional] |
data/docs/LoyaltyCardTransactionDetailsEarningRule.md CHANGED
@@ -4,6 +4,6 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | Unique earning rule ID. | [optional] |
7
+ | **id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | [optional] |
8
8
  | **source** | [**LoyaltyCardTransactionDetailsEarningRuleSource**](LoyaltyCardTransactionDetailsEarningRuleSource.md) | | [optional] |
9
9
 
data/docs/LoyaltyCardTransactionDetailsHolderLoyaltyTier.md ADDED
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltyCardTransactionDetailsHolderLoyaltyTier
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier of the loyalty tier, assigned by Voucherify. | [optional] |
8
+ | **name** | **String** | User-defined name of the loyalty tier. | [optional] |
9
+
data/docs/LoyaltyCardTransactionDetailsLoyaltyTier.md CHANGED
@@ -4,6 +4,6 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | | [optional] |
8
- | **name** | **String** | | [optional] |
7
+ | **id** | **String** | Unique identifier of the loyalty tier, assigned by Voucherify. | [optional] |
8
+ | **name** | **String** | User-defined name of the loyalty tier. | [optional] |
9
9
 
data/docs/LoyaltyMemberLoyaltyCard.md CHANGED
@@ -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
 
data/docs/LoyaltyPendingPoints.md ADDED
@@ -0,0 +1,17 @@
1
+ # VoucherifySdk::LoyaltyPendingPoints
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier of the pending point entry, assigned by Voucherify. | [optional] |
8
+ | **voucher_id** | **String** | Unique identifier of the loyalty card, assigned by Voucherify. | [optional] |
9
+ | **campaign_id** | **String** | Unique campaign identifier, assigned by Voucherify. | [optional] |
10
+ | **customer_id** | **String** | Unique customer identifier, assigned by Voucherify. | [optional] |
11
+ | **order_id** | **String** | Unique order identifier, assigned by Voucherify. | [optional] |
12
+ | **points** | **Integer** | Number of points in the pending state. | [optional] |
13
+ | **activates_at** | **Date** | Date when the pending points are activated and added to the customer's loyalty card. | [optional] |
14
+ | **details** | [**LoyaltyPendingPointsDetails**](LoyaltyPendingPointsDetails.md) | | |
15
+ | **created_at** | **Time** | Timestamp representing the date and time when the pending point entry was created. The value is shown in the ISO 8601 format. | [optional] |
16
+ | **updated_at** | **Time** | Timestamp representing the date and time when the pending point entry was modified. The value is shown in the ISO 8601 format. | [optional] |
17
+
data/docs/LoyaltyPendingPointsDetails.md ADDED
@@ -0,0 +1,12 @@
1
+ # VoucherifySdk::LoyaltyPendingPointsDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **loyalty_tier** | [**LoyaltyPendingPointsDetailsLoyaltyTier**](LoyaltyPendingPointsDetailsLoyaltyTier.md) | | [optional] |
8
+ | **holder_loyalty_tier** | [**LoyaltyPendingPointsDetailsHolderLoyaltyTier**](LoyaltyPendingPointsDetailsHolderLoyaltyTier.md) | | [optional] |
9
+ | **event** | [**LoyaltyPendingPointsDetailsEvent**](LoyaltyPendingPointsDetailsEvent.md) | | [optional] |
10
+ | **earning_rule** | [**LoyaltyPendingPointsDetailsEarningRule**](LoyaltyPendingPointsDetailsEarningRule.md) | | [optional] |
11
+ | **order** | [**LoyaltyPendingPointsDetailsOrder**](LoyaltyPendingPointsDetailsOrder.md) | | [optional] |
12
+
data/docs/LoyaltyPendingPointsDetailsEarningRule.md ADDED
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltyPendingPointsDetailsEarningRule
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | [optional] |
8
+ | **source** | [**LoyaltyPendingPointsDetailsEarningRuleSource**](LoyaltyPendingPointsDetailsEarningRuleSource.md) | | [optional] |
9
+
data/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md ADDED
@@ -0,0 +1,8 @@
1
+ # VoucherifySdk::LoyaltyPendingPointsDetailsEarningRuleSource
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **banner** | **String** | Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. | [optional] |
8
+
data/docs/LoyaltyPendingPointsDetailsEvent.md ADDED
@@ -0,0 +1,14 @@
1
+ # VoucherifySdk::LoyaltyPendingPointsDetailsEvent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique event identifier, assigned by Voucherify. | [optional] |
8
+ | **type** | **String** | Type of the event that triggered the creation of pending points. | [optional][default to 'customer.order.paid'] |
9
+ | **group_id** | **String** | Unique identifier of the request that triggered the event, assigned by Voucherify. | [optional] |
10
+ | **entity_id** | **String** | Unique identifier of the entity that triggered the event, assigned by Voucherify. For pending points, it is the `customer_id` of the customer who paid for the order. | [optional] |
11
+ | **created_at** | **Time** | Timestamp representing the date and time when the event occurred. The value is shown in the ISO 8601 format. | [optional] |
12
+ | **category** | **String** | Type of the event. | [optional] |
13
+ | **event_source** | [**EventSource**](EventSource.md) | | [optional] |
14
+
data/docs/LoyaltyPendingPointsDetailsHolderLoyaltyTier.md ADDED
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltyPendingPointsDetailsHolderLoyaltyTier
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier of the loyalty tier, assigned by Voucherify. | [optional] |
8
+ | **name** | **String** | User-defined name of the loyalty tier. | [optional] |
9
+
data/docs/LoyaltyPendingPointsDetailsLoyaltyTier.md ADDED
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltyPendingPointsDetailsLoyaltyTier
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier of the loyalty tier, assigned by Voucherify. | [optional] |
8
+ | **name** | **String** | User-defined name of the loyalty tier. | [optional] |
9
+
data/docs/LoyaltyPendingPointsDetailsOrder.md ADDED
@@ -0,0 +1,9 @@
1
+ # VoucherifySdk::LoyaltyPendingPointsDetailsOrder
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique order identifier, assigned by Voucherify. | [optional] |
8
+ | **source_id** | **String** | User-defined order identifier. | [optional] |
9
+
data/docs/LoyaltyTierExpiration.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
7
+ | **customer_id** | **String** | Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify. | [optional] |
8
8
  | **campaign_id** | **String** | Unique campaign ID, assigned by Voucherify. | [optional] |
9
9
  | **tier_id** | **String** | Unique tier ID, assigned by Voucherify. | [optional] |
10
10
  | **start_date** | **String** | Activation timestamp defines when the loyalty tier starts to be active in ISO 8601 format. Loyalty tier is inactive before this date. | [optional] |
data/docs/Order.md CHANGED
@@ -9,7 +9,7 @@
9
9
  | **status** | **String** | The order status. | [optional] |
10
10
  | **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
11
11
  | **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
12
- | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
13
- | **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
12
+ | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
13
+ | **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] |
14
14
  | **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] |
15
15
 
data/docs/OrderCalculated.md CHANGED
@@ -7,23 +7,23 @@
7
7
  | **id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
8
8
  | **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] |
9
9
  | **status** | **String** | The order status. | [optional] |
10
- | **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
11
- | **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
12
- | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
13
- | **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. | [optional] |
14
- | **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. | [optional] |
15
- | **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. | [optional] |
16
- | **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
17
- | **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)` | [optional] |
18
- | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request. `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
19
- | **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
10
+ | **amount** | **Integer** | This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
11
+ | **initial_amount** | **Integer** | This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
12
+ | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
13
+ | **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
14
+ | **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
15
+ | **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
16
+ | **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
17
+ | **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `sum(items, i => i.applied_discount_amount)` | [optional] |
18
+ | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
20
19
  | **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] |
21
20
  | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order'] |
22
21
  | **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
23
22
  | **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
24
- | **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
23
+ | **customer_id** | **String** | Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify. | [optional] |
25
24
  | **referrer_id** | **String** | Unique referrer ID. | [optional] |
26
25
  | **customer** | [**CustomerId**](CustomerId.md) | | [optional] |
27
26
  | **referrer** | [**ReferrerId**](ReferrerId.md) | | [optional] |
28
27
  | **redemptions** | [**Hash<String, OrderRedemptionsEntry>**](OrderRedemptionsEntry.md) | | [optional] |
28
+ | **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
29
29
 
data/docs/OrderCalculatedItem.md CHANGED
@@ -25,4 +25,5 @@
25
25
  | **sku** | [**OrderCalculatedItemSku**](OrderCalculatedItemSku.md) | | [optional] |
26
26
  | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order_item'] |
27
27
  | **metadata** | **Object** | A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas. | [optional] |
28
+ | **application_details** | [**Array<ApplicationDetailsItem>**](ApplicationDetailsItem.md) | Array containing details about the items that are replaced and the items that are replacements for discounts with the `REPLACE_ITEMS` effect. | [optional] |
28
29
 
data/docs/OrderRedemptionsEntry.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **date** | **Time** | Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format. | [optional] |
8
8
  | **rollback_id** | **String** | Unique ID of the redemption rollback. | [optional] |
9
- | **rollback_date** | **Time** | Timestamp representing the date and tiem when the redemption rollback was created. The value is shown in the ISO 8601 format. | [optional] |
9
+ | **rollback_date** | **Time** | Timestamp representing the date and time when the redemption rollback was created. The value is shown in the ISO 8601 format. | [optional] |
10
10
  | **related_object_type** | **String** | The source of the incentive. | [optional][default to 'redemption'] |
11
11
  | **related_object_id** | **String** | Unique ID of the parent redemption. | [optional] |
12
12
  | **related_object_parent_id** | **String** | Represent's the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier's parent campaign. | [optional] |
data/docs/OrdersCreateRequestBody.md CHANGED
@@ -9,8 +9,8 @@
9
9
  | **status** | **String** | The order status. | [optional] |
10
10
  | **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
11
11
  | **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
12
- | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
13
- | **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
12
+ | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
13
+ | **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] |
14
14
  | **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] |
15
15
  | **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
16
16
  | **referrer_id** | **String** | Unique referrer ID. | [optional] |
data/docs/OrdersCreateResponseBody.md CHANGED
@@ -7,23 +7,23 @@
7
7
  | **id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
8
8
  | **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] |
9
9
  | **status** | **String** | The order status. | [optional] |
10
- | **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
11
- | **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
12
- | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
13
- | **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. | [optional] |
14
- | **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. | [optional] |
15
- | **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. | [optional] |
16
- | **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
17
- | **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)` | [optional] |
18
- | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request. `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
19
- | **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
10
+ | **amount** | **Integer** | This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
11
+ | **initial_amount** | **Integer** | This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
12
+ | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
13
+ | **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
14
+ | **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
15
+ | **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
16
+ | **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
17
+ | **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `sum(items, i => i.applied_discount_amount)` | [optional] |
18
+ | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
20
19
  | **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] |
21
20
  | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order'] |
22
21
  | **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
23
22
  | **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
24
- | **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
23
+ | **customer_id** | **String** | Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify. | [optional] |
25
24
  | **referrer_id** | **String** | Unique referrer ID. | [optional] |
26
25
  | **customer** | [**CustomerId**](CustomerId.md) | | [optional] |
27
26
  | **referrer** | [**ReferrerId**](ReferrerId.md) | | [optional] |
28
27
  | **redemptions** | [**Hash<String, OrderRedemptionsEntry>**](OrderRedemptionsEntry.md) | | [optional] |
28
+ | **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] |
29
29
 
data/docs/OrdersGetResponseBody.md CHANGED
@@ -7,23 +7,23 @@
7
7
  | **id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
8
8
  | **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] |
9
9
  | **status** | **String** | The order status. | [optional] |
10
- | **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
11
- | **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
12
- | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
13
- | **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. | [optional] |
14
- | **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. | [optional] |
15
- | **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. | [optional] |
16
- | **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
17
- | **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request. `sum(items, i => i.applied_discount_amount)` | [optional] |
18
- | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request. `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
19
- | **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
10
+ | **amount** | **Integer** | This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
11
+ | **initial_amount** | **Integer** | This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
12
+ | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
13
+ | **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
14
+ | **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
15
+ | **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
16
+ | **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
17
+ | **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `sum(items, i => i.applied_discount_amount)` | [optional] |
18
+ | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
20
19
  | **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] |
21
20
  | **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order'] |
22
21
  | **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
23
22
  | **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
24
- | **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
23
+ | **customer_id** | **String** | Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify. | [optional] |
25
24
  | **referrer_id** | **String** | Unique referrer ID. | [optional] |
26
25
  | **customer** | [**CustomerId**](CustomerId.md) | | [optional] |
27
26
  | **referrer** | [**ReferrerId**](ReferrerId.md) | | [optional] |
28
27
  | **redemptions** | [**Hash<String, OrderRedemptionsEntry>**](OrderRedemptionsEntry.md) | | [optional] |
28
+ | **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] |
29
29
 
data/docs/OrdersImportCreateRequestBodyItem.md CHANGED
@@ -9,8 +9,8 @@
9
9
  | **status** | **String** | The order status. | [optional] |
10
10
  | **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
11
11
  | **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
12
- | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
13
- | **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
12
+ | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
13
+ | **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] |
14
14
  | **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] |
15
15
  | **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
16
16
  | **referrer_id** | **String** | Unique referrer ID. | [optional] |
data/docs/OrdersUpdateRequestBody.md CHANGED
@@ -8,8 +8,8 @@
8
8
  | **status** | **String** | The order status. | [optional] |
9
9
  | **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
10
10
  | **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
11
- | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
12
- | **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
11
+ | **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
12
+ | **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] |
13
13
  | **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] |
14
14
  | **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
15
15
  | **referrer_id** | **String** | Unique referrer ID. | [optional] |