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.
- checksums.yaml +4 -4
- data/Dockerfile +1 -1
- data/ENDPOINTS-COVERAGE.md +53 -48
- data/Gemfile.lock +8 -6
- data/README.md +44 -2
- data/__tests__/spec/12_validation_rules_spec.rb +1 -15
- data/docs/AccessSettings.md +9 -0
- data/docs/AccessSettingsAssign.md +10 -0
- data/docs/AccessSettingsUnassign.md +10 -0
- data/docs/ApplicableTo.md +3 -2
- data/docs/ApplicableToOrderItemUnitsItem.md +9 -0
- data/docs/ApplicationDetailsItem.md +14 -0
- data/docs/AreaStoreCampaignAssignment.md +1 -0
- data/docs/BinApi.md +4 -4
- data/docs/Campaign.md +1 -1
- data/docs/CampaignBase.md +1 -0
- data/docs/CampaignsCreateRequestBody.md +1 -0
- data/docs/CampaignsCreateResponseBody.md +1 -1
- data/docs/CampaignsGetResponseBody.md +1 -1
- data/docs/CampaignsUpdateRequestBody.md +1 -0
- data/docs/CampaignsUpdateResponseBody.md +1 -1
- data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md +2 -1
- data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md +2 -1
- data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +1 -1
- data/docs/CustomerLoyalty.md +1 -1
- data/docs/Discount.md +1 -1
- data/docs/DiscountUnitMultipleOneUnit.md +1 -1
- data/docs/EarningRule.md +1 -0
- data/docs/EarningRulePendingPoints.md +9 -0
- data/docs/EventSource.md +10 -0
- data/docs/EventSourceApiKey.md +9 -0
- data/docs/EventSourceUser.md +8 -0
- data/docs/InapplicableTo.md +3 -2
- data/docs/InapplicableToOrderItemUnitsItem.md +9 -0
- data/docs/LoyaltiesApi.md +334 -10
- data/docs/LoyaltiesCreateCampaignRequestBody.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesDisableResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesEnableResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesGetResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesGetResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBody.md +1 -0
- data/docs/LoyaltiesEarningRulesUpdateResponseBodyPendingPoints.md +9 -0
- data/docs/LoyaltiesMembersCreateResponseBodyLoyaltyCard.md +2 -1
- data/docs/LoyaltiesMembersGetResponseBodyLoyaltyCard.md +2 -1
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBody.md +14 -0
- data/docs/LoyaltiesMembersPendingPointsActivateResponseBodyRelatedObject.md +9 -0
- data/docs/LoyaltiesMembersPendingPointsListResponseBody.md +12 -0
- data/docs/LoyaltiesMembersRedemptionRedeemResponseBodyVoucherLoyaltyCard.md +2 -1
- data/docs/LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard.md +2 -1
- data/docs/LoyaltiesPendingPointsListResponseBody.md +12 -0
- data/docs/LoyaltiesUpdateCampaignRequestBody.md +1 -0
- data/docs/LoyaltyCardTransactionDetails.md +2 -0
- data/docs/LoyaltyCardTransactionDetailsEarningRule.md +1 -1
- data/docs/LoyaltyCardTransactionDetailsHolderLoyaltyTier.md +9 -0
- data/docs/LoyaltyCardTransactionDetailsLoyaltyTier.md +2 -2
- data/docs/LoyaltyMemberLoyaltyCard.md +2 -1
- data/docs/LoyaltyPendingPoints.md +17 -0
- data/docs/LoyaltyPendingPointsDetails.md +12 -0
- data/docs/LoyaltyPendingPointsDetailsEarningRule.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsEarningRuleSource.md +8 -0
- data/docs/LoyaltyPendingPointsDetailsEvent.md +14 -0
- data/docs/LoyaltyPendingPointsDetailsHolderLoyaltyTier.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsLoyaltyTier.md +9 -0
- data/docs/LoyaltyPendingPointsDetailsOrder.md +9 -0
- data/docs/LoyaltyTierExpiration.md +1 -1
- data/docs/Order.md +2 -2
- data/docs/OrderCalculated.md +11 -11
- data/docs/OrderCalculatedItem.md +1 -0
- data/docs/OrderRedemptionsEntry.md +1 -1
- data/docs/OrdersCreateRequestBody.md +2 -2
- data/docs/OrdersCreateResponseBody.md +11 -11
- data/docs/OrdersGetResponseBody.md +11 -11
- data/docs/OrdersImportCreateRequestBodyItem.md +2 -2
- data/docs/OrdersUpdateRequestBody.md +2 -2
- data/docs/OrdersUpdateResponseBody.md +11 -11
- data/docs/ParameterOrderListPendingPoints.md +7 -0
- data/docs/RedeemableLoyaltyCard.md +1 -1
- data/docs/RedeemableVoucherLoyaltyCard.md +2 -1
- data/docs/RedemptionEntryOrder.md +11 -11
- data/docs/RedemptionEntryVoucherLoyaltyCard.md +2 -1
- data/docs/RedemptionVoucherLoyaltyCard.md +2 -1
- data/docs/RedemptionsGetResponseBodyOrder.md +11 -11
- data/docs/RedemptionsGetResponseBodyVoucherLoyaltyCard.md +2 -1
- data/docs/RedemptionsListResponseBodyRedemptionsItemOrder.md +11 -11
- data/docs/RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard.md +2 -1
- data/docs/SimpleLoyaltyCard.md +2 -1
- data/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md +1 -0
- data/docs/ValidationsValidateResponseBodyRedeemablesItemResultDiscount.md +1 -1
- data/docs/VoucherLoyaltyCard.md +2 -1
- data/docs/VoucherTransactionDetails.md +2 -0
- data/docs/VoucherTransactionDetailsCustomEvent.md +2 -2
- data/docs/VoucherTransactionDetailsEarningRule.md +1 -1
- data/docs/VoucherTransactionDetailsEventSchema.md +2 -2
- data/docs/VoucherTransactionDetailsHolderLoyaltyTier.md +9 -0
- data/docs/VoucherTransactionDetailsLoyaltyTier.md +2 -2
- data/docs/VoucherTransactionDetailsRollback.md +1 -1
- data/docs/VoucherTransactionDetailsSegment.md +2 -2
- data/docs/VoucherWithCategoriesLoyaltyCard.md +2 -1
- data/docs/VouchersCreateResponseBodyLoyaltyCard.md +2 -1
- data/docs/VouchersDisableResponseBodyLoyaltyCard.md +2 -1
- data/docs/VouchersEnableResponseBodyLoyaltyCard.md +2 -1
- data/docs/VouchersGetResponseBodyLoyaltyCard.md +2 -1
- data/docs/VouchersUpdateResponseBodyLoyaltyCard.md +2 -1
- data/lib/VoucherifySdk/api/bin_api.rb +4 -4
- data/lib/VoucherifySdk/api/loyalties_api.rb +334 -8
- data/lib/VoucherifySdk/models/access_settings.rb +219 -0
- data/lib/VoucherifySdk/models/access_settings_assign.rb +238 -0
- data/lib/VoucherifySdk/models/access_settings_unassign.rb +238 -0
- data/lib/VoucherifySdk/models/applicable_to.rb +16 -3
- data/lib/VoucherifySdk/models/applicable_to_order_item_units_item.rb +220 -0
- data/lib/VoucherifySdk/models/application_details_item.rb +284 -0
- data/lib/VoucherifySdk/models/area_store_campaign_assignment.rb +12 -1
- data/lib/VoucherifySdk/models/campaign.rb +13 -13
- data/lib/VoucherifySdk/models/campaign_base.rb +13 -4
- data/lib/VoucherifySdk/models/campaigns_create_request_body.rb +10 -1
- data/lib/VoucherifySdk/models/campaigns_create_response_body.rb +13 -13
- data/lib/VoucherifySdk/models/campaigns_get_response_body.rb +13 -13
- data/lib/VoucherifySdk/models/campaigns_update_request_body.rb +10 -1
- data/lib/VoucherifySdk/models/campaigns_update_response_body.rb +13 -13
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_combined_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/campaigns_vouchers_create_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/client_validations_validate_response_body_redeemables_item_result_discount.rb +1 -0
- data/lib/VoucherifySdk/models/customer_loyalty.rb +1 -1
- data/lib/VoucherifySdk/models/discount.rb +1 -0
- data/lib/VoucherifySdk/models/discount_unit_multiple_one_unit.rb +1 -0
- data/lib/VoucherifySdk/models/earning_rule.rb +11 -1
- data/lib/VoucherifySdk/models/earning_rule_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/event_source.rb +254 -0
- data/lib/VoucherifySdk/models/event_source_api_key.rb +221 -0
- data/lib/VoucherifySdk/models/event_source_user.rb +210 -0
- data/lib/VoucherifySdk/models/inapplicable_to.rb +16 -3
- data/lib/VoucherifySdk/models/inapplicable_to_order_item_units_item.rb +220 -0
- data/lib/VoucherifySdk/models/loyalties_create_campaign_request_body.rb +10 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_create_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_disable_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_enable_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_get_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body.rb +11 -1
- data/lib/VoucherifySdk/models/loyalties_earning_rules_update_response_body_pending_points.rb +257 -0
- data/lib/VoucherifySdk/models/loyalties_members_create_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalties_members_get_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body.rb +309 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_activate_response_body_related_object.rb +247 -0
- data/lib/VoucherifySdk/models/loyalties_members_pending_points_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_members_redemption_redeem_response_body_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalties_members_transfers_create_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalties_pending_points_list_response_body.rb +286 -0
- data/lib/VoucherifySdk/models/loyalties_update_campaign_request_body.rb +10 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details.rb +20 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_earning_rule.rb +1 -1
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_card_transaction_details_loyalty_tier.rb +3 -1
- data/lib/VoucherifySdk/models/loyalty_card_transactions_type.rb +2 -1
- data/lib/VoucherifySdk/models/loyalty_member_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/loyalty_pending_points.rb +314 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details.rb +249 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule.rb +220 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_earning_rule_source.rb +210 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_event.rb +302 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_pending_points_details_order.rb +221 -0
- data/lib/VoucherifySdk/models/loyalty_tier_expiration.rb +1 -1
- data/lib/VoucherifySdk/models/order.rb +2 -2
- data/lib/VoucherifySdk/models/order_calculated.rb +28 -28
- data/lib/VoucherifySdk/models/order_calculated_item.rb +17 -5
- data/lib/VoucherifySdk/models/order_redemptions_entry.rb +1 -1
- data/lib/VoucherifySdk/models/orders_create_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/orders_create_response_body.rb +28 -28
- data/lib/VoucherifySdk/models/orders_get_response_body.rb +28 -28
- data/lib/VoucherifySdk/models/orders_import_create_request_body_item.rb +2 -2
- data/lib/VoucherifySdk/models/orders_update_request_body.rb +2 -2
- data/lib/VoucherifySdk/models/orders_update_response_body.rb +28 -28
- data/lib/VoucherifySdk/models/parameter_order_list_pending_points.rb +40 -0
- data/lib/VoucherifySdk/models/qualifications_option.rb +3 -3
- data/lib/VoucherifySdk/models/redeemable_loyalty_card.rb +1 -1
- data/lib/VoucherifySdk/models/redeemable_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/redemption_entry_order.rb +28 -28
- data/lib/VoucherifySdk/models/redemption_entry_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/redemption_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/redemptions_get_response_body_order.rb +28 -28
- data/lib/VoucherifySdk/models/redemptions_get_response_body_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_order.rb +27 -28
- data/lib/VoucherifySdk/models/redemptions_list_response_body_redemptions_item_voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/simple_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/templates_campaigns_campaign_setup_create_request_body.rb +10 -1
- data/lib/VoucherifySdk/models/validations_validate_response_body_redeemables_item_result_discount.rb +1 -0
- data/lib/VoucherifySdk/models/voucher_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/voucher_transaction.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details.rb +20 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_custom_event.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details_earning_rule.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_event_schema.rb +2 -2
- data/lib/VoucherifySdk/models/voucher_transaction_details_holder_loyalty_tier.rb +221 -0
- data/lib/VoucherifySdk/models/voucher_transaction_details_loyalty_tier.rb +3 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_rollback.rb +1 -1
- data/lib/VoucherifySdk/models/voucher_transaction_details_segment.rb +2 -0
- data/lib/VoucherifySdk/models/voucher_with_categories_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_create_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_disable_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_enable_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_get_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/models/vouchers_update_response_body_loyalty_card.rb +17 -6
- data/lib/VoucherifySdk/version.rb +1 -1
- data/lib/VoucherifySdk.rb +30 -0
- metadata +96 -36
@@ -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** |
|
11
|
-
| **initial_amount** | **Integer** |
|
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
|
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
|
|
@@ -4,7 +4,7 @@
|
|
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
|
| **exchange_ratio** | **Float** | The cash equivalent of the points defined in the points_ratio property. | [optional] |
|
10
10
|
| **points_ratio** | **Integer** | The number of loyalty points that will map to the predefined cash amount defined by the exchange_ratio property. | [optional] |
|
@@ -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
|
|
@@ -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** |
|
11
|
-
| **initial_amount** | **Integer** |
|
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
|
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** | [**RedemptionEntryOrderCustomer**](RedemptionEntryOrderCustomer.md) | | [optional] |
|
27
26
|
| **referrer** | [**RedemptionEntryOrderReferrer**](RedemptionEntryOrderReferrer.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
|
|
@@ -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
|
|
@@ -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** |
|
11
|
-
| **initial_amount** | **Integer** |
|
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
|
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** | [**RedemptionsGetResponseBodyOrderCustomer**](RedemptionsGetResponseBodyOrderCustomer.md) | | [optional] |
|
27
26
|
| **referrer** | [**RedemptionsGetResponseBodyOrderReferrer**](RedemptionsGetResponseBodyOrderReferrer.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
|
|
@@ -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
|
|
@@ -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** |
|
11
|
-
| **initial_amount** | **Integer** |
|
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
|
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** | [**RedemptionsListResponseBodyRedemptionsItemOrderCustomer**](RedemptionsListResponseBodyRedemptionsItemOrderCustomer.md) | | [optional] |
|
27
26
|
| **referrer** | [**RedemptionsListResponseBodyRedemptionsItemOrderReferrer**](RedemptionsListResponseBodyRedemptionsItemOrderReferrer.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
|
|
@@ -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/SimpleLoyaltyCard.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
|
|
@@ -20,5 +20,6 @@
|
|
20
20
|
| **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
|
21
21
|
| **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [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
|
| **voucher** | [**TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher**](TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher.md) | | [optional] |
|
24
25
|
|
@@ -11,7 +11,7 @@
|
|
11
11
|
| **effect** | **String** | | [optional] |
|
12
12
|
| **is_dynamic** | **Boolean** | Flag indicating whether the discount was calculated using a formula. | [optional] |
|
13
13
|
| **unit_off** | **Integer** | Number of units to be granted a full value discount. | [optional] |
|
14
|
-
| **unit_off_formula** | **String** |
|
14
|
+
| **unit_off_formula** | **String** | Formula used to calculate the number of units. | [optional] |
|
15
15
|
| **unit_type** | **String** | The product deemed as free, chosen from product inventory (e.g. time, items). | [optional] |
|
16
16
|
| **product** | [**ValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct**](ValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md) | | [optional] |
|
17
17
|
| **sku** | [**SimpleSkuDiscountUnit**](SimpleSkuDiscountUnit.md) | | [optional] |
|
data/docs/VoucherLoyaltyCard.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
|
|
@@ -14,6 +14,8 @@
|
|
14
14
|
| **rollback** | [**VoucherTransactionDetailsRollback**](VoucherTransactionDetailsRollback.md) | | [optional] |
|
15
15
|
| **custom_event** | [**VoucherTransactionDetailsCustomEvent**](VoucherTransactionDetailsCustomEvent.md) | | [optional] |
|
16
16
|
| **event_schema** | [**VoucherTransactionDetailsEventSchema**](VoucherTransactionDetailsEventSchema.md) | | [optional] |
|
17
|
+
| **holder_loyalty_tier** | [**VoucherTransactionDetailsHolderLoyaltyTier**](VoucherTransactionDetailsHolderLoyaltyTier.md) | | [optional] |
|
18
|
+
| **pending_points** | [**LoyaltyPendingPoints**](LoyaltyPendingPoints.md) | | [optional] |
|
17
19
|
| **reward** | [**VoucherTransactionDetailsReward**](VoucherTransactionDetailsReward.md) | | [optional] |
|
18
20
|
| **source_voucher** | [**SimpleVoucher**](SimpleVoucher.md) | | [optional] |
|
19
21
|
| **destination_voucher** | [**SimpleVoucher**](SimpleVoucher.md) | | [optional] |
|
@@ -4,6 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | Unique event
|
8
|
-
| **type** | **String** | Type of custom event. | [optional] |
|
7
|
+
| **id** | **String** | Unique identifier of the event. | [optional] |
|
8
|
+
| **type** | **String** | Type of the custom event. | [optional] |
|
9
9
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | Unique earning rule
|
7
|
+
| **id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | [optional] |
|
8
8
|
| **source** | [**VoucherTransactionDetailsEarningRuleSource**](VoucherTransactionDetailsEarningRuleSource.md) | | [optional] |
|
9
9
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | Unique metadata schema
|
8
|
-
| **name** | **String** | Type of custom event. | [optional] |
|
7
|
+
| **id** | **String** | Unique identifier of the metadata schema. | [optional] |
|
8
|
+
| **name** | **String** | Type of the custom event. | [optional] |
|
9
9
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VoucherifySdk::VoucherTransactionDetailsHolderLoyaltyTier
|
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
|
+
|
@@ -4,6 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** |
|
8
|
-
| **name** | **String** |
|
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
|
|
@@ -4,6 +4,6 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** |
|
8
|
-
| **name** | **String** |
|
7
|
+
| **id** | **String** | Unique identifier of the segment. | [optional] |
|
8
|
+
| **name** | **String** | Name of the segment. | [optional] |
|
9
9
|
|
@@ -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
|
|
@@ -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
|
|
@@ -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
|
|
@@ -80,8 +80,8 @@ module VoucherifySdk
|
|
80
80
|
# Retrieves a list of resources moved to the bin. The following resources can be moved to the bin: - campaigns - vouchers - products - SKUs To use this endpoint, you must have the following permissions: - vouchers.read - campaigns.read - products.read
|
81
81
|
# @param [Hash] opts the optional parameters
|
82
82
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
83
|
-
# @option opts [ParameterOrderListBin] :order Orders the bin entries according
|
84
|
-
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the
|
83
|
+
# @option opts [ParameterOrderListBin] :order Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
84
|
+
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
85
85
|
# @option opts [ParameterFiltersListBin] :filters Filters for listing bin entries.
|
86
86
|
# @return [TrashBinListResponseBody]
|
87
87
|
def list_bin_entries(opts = {})
|
@@ -93,8 +93,8 @@ module VoucherifySdk
|
|
93
93
|
# Retrieves a list of resources moved to the bin. The following resources can be moved to the bin: - campaigns - vouchers - products - SKUs To use this endpoint, you must have the following permissions: - vouchers.read - campaigns.read - products.read
|
94
94
|
# @param [Hash] opts the optional parameters
|
95
95
|
# @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
|
96
|
-
# @option opts [ParameterOrderListBin] :order Orders the bin entries according
|
97
|
-
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the
|
96
|
+
# @option opts [ParameterOrderListBin] :order Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
97
|
+
# @option opts [String] :starting_after_id A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
98
98
|
# @option opts [ParameterFiltersListBin] :filters Filters for listing bin entries.
|
99
99
|
# @return [Array<(TrashBinListResponseBody, Integer, Hash)>] TrashBinListResponseBody data, response status code and response headers
|
100
100
|
private def list_bin_entries_with_http_info(opts = {})
|