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
@@ -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] |
|
@@ -34,7 +34,7 @@
|
|
34
34
|
| **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional][default to 'campaign'] |
|
35
35
|
| **referral_program** | [**ReferralProgram**](ReferralProgram.md) | | [optional] |
|
36
36
|
| **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) | | [optional] |
|
37
|
+
| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional] |
|
37
38
|
| **promotion** | [**PromotionTiersList**](PromotionTiersList.md) | | [optional] |
|
38
39
|
| **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) | | [optional] |
|
39
|
-
| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) | | [optional] |
|
40
40
|
|
@@ -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
|
|
@@ -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** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct**](ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md) | | [optional] |
|
17
17
|
| **sku** | [**SimpleSkuDiscountUnit**](SimpleSkuDiscountUnit.md) | | [optional] |
|
data/docs/CustomerLoyalty.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **points** | **Integer** | Customer's loyalty points. | [optional] |
|
7
|
+
| **points** | **Integer** | Customer's loyalty points minus expired for all loyalty cards which the customer has. | [optional] |
|
8
8
|
| **referred_customers** | **Integer** | Total number of customers referred by the customer. | [optional] |
|
9
9
|
| **campaigns** | [**Hash<String, CustomerLoyaltyCampaignsEntry>**](CustomerLoyaltyCampaignsEntry.md) | Contains campaigns with details about point balances and how many customers were referred by the customer. | [optional] |
|
10
10
|
|
data/docs/Discount.md
CHANGED
@@ -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** | [**DiscountProduct**](DiscountProduct.md) | | [optional] |
|
17
17
|
| **sku** | [**SimpleSkuDiscountUnit**](SimpleSkuDiscountUnit.md) | | [optional] |
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **unit_off** | **Float** | Number of units to be granted a full value discount. | [optional] |
|
8
|
-
| **unit_off_formula** | **String** |
|
8
|
+
| **unit_off_formula** | **String** | Formula used to calculate the number of units. | [optional] |
|
9
9
|
| **effect** | **String** | Defines how the unit is added to the customer's order. | [optional] |
|
10
10
|
| **unit_type** | **String** | The product deemed as free, chosen from product inventory (e.g. time, items). | [optional] |
|
11
11
|
| **product** | [**SimpleProductDiscountUnit**](SimpleProductDiscountUnit.md) | | [optional] |
|
data/docs/EarningRule.md
CHANGED
@@ -11,6 +11,7 @@
|
|
11
11
|
| **custom_event** | [**EarningRuleCustomEvent**](EarningRuleCustomEvent.md) | | [optional] |
|
12
12
|
| **segment** | [**EarningRuleSegment**](EarningRuleSegment.md) | | [optional] |
|
13
13
|
| **loyalty_tier** | [**EarningRuleLoyaltyTier**](EarningRuleLoyaltyTier.md) | | [optional] |
|
14
|
+
| **pending_points** | [**EarningRulePendingPoints**](EarningRulePendingPoints.md) | | [optional] |
|
14
15
|
| **source** | [**EarningRuleSource**](EarningRuleSource.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] |
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VoucherifySdk::EarningRulePendingPoints
|
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/EventSource.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# VoucherifySdk::EventSource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **channel** | **String** | Determines the channel that initiated the event. | [optional] |
|
8
|
+
| **user** | [**EventSourceUser**](EventSourceUser.md) | | [optional] |
|
9
|
+
| **api_key** | [**EventSourceApiKey**](EventSourceApiKey.md) | | [optional] |
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VoucherifySdk::EventSourceApiKey
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Channel name in the application keys. | [optional] |
|
8
|
+
| **app_id** | **String** | Contains the application ID from the Voucherify API key pair. | [optional] |
|
9
|
+
|
data/docs/InapplicableTo.md
CHANGED
@@ -17,8 +17,9 @@
|
|
17
17
|
| **aggregated_quantity_limit** | **Integer** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional] |
|
18
18
|
| **amount_limit** | **Integer** | Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] |
|
19
19
|
| **aggregated_amount_limit** | **Integer** | Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) | [optional] |
|
20
|
-
| **order_item_indices** | **Array<Integer>** |
|
20
|
+
| **order_item_indices** | **Array<Integer>** | Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on. | [optional] |
|
21
|
+
| **order_item_units** | [**Array<InapplicableToOrderItemUnitsItem>**](InapplicableToOrderItemUnitsItem.md) | Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the `index` corresponds to the order line sent in the `order` object in the request. | [optional] |
|
21
22
|
| **repeat** | **Integer** | Determines the recurrence of the discount, e.g. `\"repeat\": 3` means that the discount is applied to every third item. | [optional] |
|
22
23
|
| **skip_initially** | **Integer** | Determines how many items are skipped before the discount is applied. | [optional] |
|
23
|
-
| **target** | **String** | Determines to which kinds of objects the discount is applicable. `
|
24
|
+
| **target** | **String** | Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line. | [optional] |
|
24
25
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VoucherifySdk::InapplicableToOrderItemUnitsItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **index** | **Integer** | Number assigned to the order line item in accordance with the order sent in the request. | [optional] |
|
8
|
+
| **units** | **Array<Integer>** | Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `\"skip_initially\": 1`, `\"repeat\": 3`. The counting of units starts from `1`. | [optional] |
|
9
|
+
|
data/docs/LoyaltiesApi.md
CHANGED
@@ -4,11 +4,13 @@ All URIs are relative to *https://api.voucherify.io*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**activate_member_pending_points**](LoyaltiesApi.md#activate_member_pending_points) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | Activate Member Pending Points |
|
7
8
|
| [**add_member**](LoyaltiesApi.md#add_member) | **POST** /v1/loyalties/{campaignId}/members | Add Member |
|
9
|
+
| [**cancel_member_pending_points**](LoyaltiesApi.md#cancel_member_pending_points) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | Cancel Member Pending Points |
|
8
10
|
| [**create_earning_rule**](LoyaltiesApi.md#create_earning_rule) | **POST** /v1/loyalties/{campaignId}/earning-rules | Create Earning Rule |
|
9
11
|
| [**create_in_bulk_loyalty_tiers**](LoyaltiesApi.md#create_in_bulk_loyalty_tiers) | **POST** /v1/loyalties/{campaignId}/tiers | Create loyalty tiers |
|
10
12
|
| [**create_loyalty_program**](LoyaltiesApi.md#create_loyalty_program) | **POST** /v1/loyalties | Create Loyalty Campaign |
|
11
|
-
| [**create_points_expiration_export**](LoyaltiesApi.md#create_points_expiration_export) | **POST** /v1/loyalties/{campaignId}/points-expiration/export |
|
13
|
+
| [**create_points_expiration_export**](LoyaltiesApi.md#create_points_expiration_export) | **POST** /v1/loyalties/{campaignId}/points-expiration/export | Export Loyalty Campaign Point Expiration |
|
12
14
|
| [**create_reward_assignment1**](LoyaltiesApi.md#create_reward_assignment1) | **POST** /v1/loyalties/{campaignId}/rewards | Create Reward Assignment |
|
13
15
|
| [**delete_earning_rule**](LoyaltiesApi.md#delete_earning_rule) | **DELETE** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule |
|
14
16
|
| [**delete_loyalty_program**](LoyaltiesApi.md#delete_loyalty_program) | **DELETE** /v1/loyalties/{campaignId} | Delete Loyalty Campaign |
|
@@ -25,6 +27,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
25
27
|
| [**get_reward_assignment1**](LoyaltiesApi.md#get_reward_assignment1) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Reward Assignment |
|
26
28
|
| [**get_reward_assignment2**](LoyaltiesApi.md#get_reward_assignment2) | **GET** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Reward Assignment |
|
27
29
|
| [**get_reward_details**](LoyaltiesApi.md#get_reward_details) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details |
|
30
|
+
| [**list_campaign_pending_points**](LoyaltiesApi.md#list_campaign_pending_points) | **GET** /v1/loyalties/{campaignId}/pending-points | List Campaign Pending Points |
|
28
31
|
| [**list_earning_rules**](LoyaltiesApi.md#list_earning_rules) | **GET** /v1/loyalties/{campaignId}/earning-rules | List Earning Rules |
|
29
32
|
| [**list_loyalty_card_transactions**](LoyaltiesApi.md#list_loyalty_card_transactions) | **GET** /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions |
|
30
33
|
| [**list_loyalty_card_transactions1**](LoyaltiesApi.md#list_loyalty_card_transactions1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions |
|
@@ -35,9 +38,11 @@ All URIs are relative to *https://api.voucherify.io*
|
|
35
38
|
| [**list_member_activity**](LoyaltiesApi.md#list_member_activity) | **GET** /v1/loyalties/members/{memberId}/activity | List Member Activity |
|
36
39
|
| [**list_member_activity1**](LoyaltiesApi.md#list_member_activity1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/activity | List Member Activity |
|
37
40
|
| [**list_member_loyalty_tier**](LoyaltiesApi.md#list_member_loyalty_tier) | **GET** /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers |
|
41
|
+
| [**list_member_pending_points**](LoyaltiesApi.md#list_member_pending_points) | **GET** /v1/loyalties/members/{memberId}/pending-points | List Member Pending Points |
|
42
|
+
| [**list_member_pending_points1**](LoyaltiesApi.md#list_member_pending_points1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/pending-points | List Member Pending Points |
|
38
43
|
| [**list_member_rewards**](LoyaltiesApi.md#list_member_rewards) | **GET** /v1/loyalties/members/{memberId}/rewards | List Member Rewards |
|
39
44
|
| [**list_members**](LoyaltiesApi.md#list_members) | **GET** /v1/loyalties/{campaignId}/members | List Members |
|
40
|
-
| [**list_points_expiration**](LoyaltiesApi.md#list_points_expiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration |
|
45
|
+
| [**list_points_expiration**](LoyaltiesApi.md#list_points_expiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | List Loyalty Card Point Expiration |
|
41
46
|
| [**list_reward_assignments1**](LoyaltiesApi.md#list_reward_assignments1) | **GET** /v1/loyalties/{campaignId}/reward-assignments | List Reward Assignments |
|
42
47
|
| [**list_reward_assignments2**](LoyaltiesApi.md#list_reward_assignments2) | **GET** /v1/loyalties/{campaignId}/rewards | List Reward Assignments |
|
43
48
|
| [**redeem_reward**](LoyaltiesApi.md#redeem_reward) | **POST** /v1/loyalties/members/{memberId}/redemption | Redeem Reward |
|
@@ -50,6 +55,66 @@ All URIs are relative to *https://api.voucherify.io*
|
|
50
55
|
| [**update_reward_assignment1**](LoyaltiesApi.md#update_reward_assignment1) | **PUT** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Update Reward Assignment |
|
51
56
|
|
52
57
|
|
58
|
+
## activate_member_pending_points
|
59
|
+
|
60
|
+
> <LoyaltiesMembersPendingPointsActivateResponseBody> activate_member_pending_points(member_id, pending_points_id)
|
61
|
+
|
62
|
+
Activate Member Pending Points
|
63
|
+
|
64
|
+
>🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member (with campaign ID, without campaign ID), List campaign pending points. This **POST** method does not require a request body.
|
65
|
+
|
66
|
+
### Examples
|
67
|
+
|
68
|
+
```ruby
|
69
|
+
require 'time'
|
70
|
+
require 'VoucherifySdk'
|
71
|
+
# setup authorization
|
72
|
+
VoucherifySdk.configure do |config|
|
73
|
+
# Configure API key authorization: X-App-Id
|
74
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
75
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
76
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
77
|
+
|
78
|
+
# Configure API key authorization: X-App-Token
|
79
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
80
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
81
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
82
|
+
end
|
83
|
+
|
84
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
85
|
+
member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
|
86
|
+
pending_points_id = 'pending_points_id_example' # String | Unique pending point identifier, assigned by Voucherify.
|
87
|
+
|
88
|
+
begin
|
89
|
+
# Activate Member Pending Points
|
90
|
+
result = api_instance.activate_member_pending_points(member_id, pending_points_id)
|
91
|
+
p result
|
92
|
+
rescue VoucherifySdk::ApiError => e
|
93
|
+
puts "Error when calling LoyaltiesApi->activate_member_pending_points: #{e}"
|
94
|
+
end
|
95
|
+
```
|
96
|
+
|
97
|
+
### Parameters
|
98
|
+
|
99
|
+
| Name | Type | Description | Notes |
|
100
|
+
| ---- | ---- | ----------- | ----- |
|
101
|
+
| **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
|
102
|
+
| **pending_points_id** | **String** | Unique pending point identifier, assigned by Voucherify. | |
|
103
|
+
|
104
|
+
### Return type
|
105
|
+
|
106
|
+
[**LoyaltiesMembersPendingPointsActivateResponseBody**](LoyaltiesMembersPendingPointsActivateResponseBody.md)
|
107
|
+
|
108
|
+
### Authorization
|
109
|
+
|
110
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
111
|
+
|
112
|
+
### HTTP request headers
|
113
|
+
|
114
|
+
- **Content-Type**: Not defined
|
115
|
+
- **Accept**: application/json
|
116
|
+
|
117
|
+
|
53
118
|
## add_member
|
54
119
|
|
55
120
|
> <LoyaltiesMembersCreateResponseBody> add_member(campaign_id, opts)
|
@@ -112,6 +177,65 @@ end
|
|
112
177
|
- **Accept**: application/json
|
113
178
|
|
114
179
|
|
180
|
+
## cancel_member_pending_points
|
181
|
+
|
182
|
+
> cancel_member_pending_points(member_id, pending_points_id)
|
183
|
+
|
184
|
+
Cancel Member Pending Points
|
185
|
+
|
186
|
+
>🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member (with campaign ID, without campaign ID), List campaign pending points. This **POST** method does not require a request body and it returns an empty, 204, response.
|
187
|
+
|
188
|
+
### Examples
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
require 'time'
|
192
|
+
require 'VoucherifySdk'
|
193
|
+
# setup authorization
|
194
|
+
VoucherifySdk.configure do |config|
|
195
|
+
# Configure API key authorization: X-App-Id
|
196
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
197
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
198
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
199
|
+
|
200
|
+
# Configure API key authorization: X-App-Token
|
201
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
202
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
203
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
204
|
+
end
|
205
|
+
|
206
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
207
|
+
member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
|
208
|
+
pending_points_id = 'pending_points_id_example' # String | Unique pending point identifier, assigned by Voucherify.
|
209
|
+
|
210
|
+
begin
|
211
|
+
# Cancel Member Pending Points
|
212
|
+
api_instance.cancel_member_pending_points(member_id, pending_points_id)
|
213
|
+
rescue VoucherifySdk::ApiError => e
|
214
|
+
puts "Error when calling LoyaltiesApi->cancel_member_pending_points: #{e}"
|
215
|
+
end
|
216
|
+
```
|
217
|
+
|
218
|
+
### Parameters
|
219
|
+
|
220
|
+
| Name | Type | Description | Notes |
|
221
|
+
| ---- | ---- | ----------- | ----- |
|
222
|
+
| **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
|
223
|
+
| **pending_points_id** | **String** | Unique pending point identifier, assigned by Voucherify. | |
|
224
|
+
|
225
|
+
### Return type
|
226
|
+
|
227
|
+
nil (empty response body)
|
228
|
+
|
229
|
+
### Authorization
|
230
|
+
|
231
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
232
|
+
|
233
|
+
### HTTP request headers
|
234
|
+
|
235
|
+
- **Content-Type**: Not defined
|
236
|
+
- **Accept**: Not defined
|
237
|
+
|
238
|
+
|
115
239
|
## create_earning_rule
|
116
240
|
|
117
241
|
> <Array<LoyaltiesEarningRulesCreateResponseBody>> create_earning_rule(campaign_id, opts)
|
@@ -300,7 +424,7 @@ end
|
|
300
424
|
|
301
425
|
> <LoyaltiesPointsExpirationExportCreateResponseBody> create_points_expiration_export(campaign_id, opts)
|
302
426
|
|
303
|
-
|
427
|
+
Export Loyalty Campaign Point Expiration
|
304
428
|
|
305
429
|
Schedule the generation of a points expiration CSV file for a particular campaign.
|
306
430
|
|
@@ -329,7 +453,7 @@ opts = {
|
|
329
453
|
}
|
330
454
|
|
331
455
|
begin
|
332
|
-
#
|
456
|
+
# Export Loyalty Campaign Point Expiration
|
333
457
|
result = api_instance.create_points_expiration_export(campaign_id, opts)
|
334
458
|
p result
|
335
459
|
rescue VoucherifySdk::ApiError => e
|
@@ -628,7 +752,7 @@ end
|
|
628
752
|
|
629
753
|
api_instance = VoucherifySdk::LoyaltiesApi.new
|
630
754
|
campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
|
631
|
-
earning_rule_id = 'earning_rule_id_example' # String | Unique earning rule
|
755
|
+
earning_rule_id = 'earning_rule_id_example' # String | Unique identifier of an earning rule, assigned by Voucherify.
|
632
756
|
|
633
757
|
begin
|
634
758
|
# Disable Earning Rule
|
@@ -644,7 +768,7 @@ end
|
|
644
768
|
| Name | Type | Description | Notes |
|
645
769
|
| ---- | ---- | ----------- | ----- |
|
646
770
|
| **campaign_id** | **String** | Unique campaign ID or name. | |
|
647
|
-
| **earning_rule_id** | **String** | Unique earning rule
|
771
|
+
| **earning_rule_id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | |
|
648
772
|
|
649
773
|
### Return type
|
650
774
|
|
@@ -688,7 +812,7 @@ end
|
|
688
812
|
|
689
813
|
api_instance = VoucherifySdk::LoyaltiesApi.new
|
690
814
|
campaign_id = 'campaign_id_example' # String | Unique campaign ID or name.
|
691
|
-
earning_rule_id = 'earning_rule_id_example' # String | Unique earning rule
|
815
|
+
earning_rule_id = 'earning_rule_id_example' # String | Unique identifier of an earning rule, assigned by Voucherify.
|
692
816
|
|
693
817
|
begin
|
694
818
|
# Enable Earning Rule
|
@@ -704,7 +828,7 @@ end
|
|
704
828
|
| Name | Type | Description | Notes |
|
705
829
|
| ---- | ---- | ----------- | ----- |
|
706
830
|
| **campaign_id** | **String** | Unique campaign ID or name. | |
|
707
|
-
| **earning_rule_id** | **String** | Unique earning rule
|
831
|
+
| **earning_rule_id** | **String** | Unique identifier of an earning rule, assigned by Voucherify. | |
|
708
832
|
|
709
833
|
### Return type
|
710
834
|
|
@@ -1322,6 +1446,72 @@ end
|
|
1322
1446
|
- **Accept**: application/json
|
1323
1447
|
|
1324
1448
|
|
1449
|
+
## list_campaign_pending_points
|
1450
|
+
|
1451
|
+
> <LoyaltiesPendingPointsListResponseBody> list_campaign_pending_points(campaign_id, opts)
|
1452
|
+
|
1453
|
+
List Campaign Pending Points
|
1454
|
+
|
1455
|
+
>🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned.
|
1456
|
+
|
1457
|
+
### Examples
|
1458
|
+
|
1459
|
+
```ruby
|
1460
|
+
require 'time'
|
1461
|
+
require 'VoucherifySdk'
|
1462
|
+
# setup authorization
|
1463
|
+
VoucherifySdk.configure do |config|
|
1464
|
+
# Configure API key authorization: X-App-Id
|
1465
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
1466
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1467
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
1468
|
+
|
1469
|
+
# Configure API key authorization: X-App-Token
|
1470
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
1471
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1472
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
1473
|
+
end
|
1474
|
+
|
1475
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
1476
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID.
|
1477
|
+
opts = {
|
1478
|
+
limit: 56, # Integer | Limit the number of the pending point entries that the API returns in the response.
|
1479
|
+
order: VoucherifySdk::ParameterOrderListPendingPoints::ID, # ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
1480
|
+
starting_after_id: 'starting_after_id_example' # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
1481
|
+
}
|
1482
|
+
|
1483
|
+
begin
|
1484
|
+
# List Campaign Pending Points
|
1485
|
+
result = api_instance.list_campaign_pending_points(campaign_id, opts)
|
1486
|
+
p result
|
1487
|
+
rescue VoucherifySdk::ApiError => e
|
1488
|
+
puts "Error when calling LoyaltiesApi->list_campaign_pending_points: #{e}"
|
1489
|
+
end
|
1490
|
+
```
|
1491
|
+
|
1492
|
+
### Parameters
|
1493
|
+
|
1494
|
+
| Name | Type | Description | Notes |
|
1495
|
+
| ---- | ---- | ----------- | ----- |
|
1496
|
+
| **campaign_id** | **String** | Unique campaign ID. | |
|
1497
|
+
| **limit** | **Integer** | Limit the number of the pending point entries that the API returns in the response. | [optional] |
|
1498
|
+
| **order** | [**ParameterOrderListPendingPoints**](.md) | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
1499
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
|
1500
|
+
|
1501
|
+
### Return type
|
1502
|
+
|
1503
|
+
[**LoyaltiesPendingPointsListResponseBody**](LoyaltiesPendingPointsListResponseBody.md)
|
1504
|
+
|
1505
|
+
### Authorization
|
1506
|
+
|
1507
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
1508
|
+
|
1509
|
+
### HTTP request headers
|
1510
|
+
|
1511
|
+
- **Content-Type**: Not defined
|
1512
|
+
- **Accept**: application/json
|
1513
|
+
|
1514
|
+
|
1325
1515
|
## list_earning_rules
|
1326
1516
|
|
1327
1517
|
> <LoyaltiesEarningRulesListResponseBody> list_earning_rules(campaign_id, opts)
|
@@ -1968,6 +2158,140 @@ end
|
|
1968
2158
|
- **Accept**: application/json
|
1969
2159
|
|
1970
2160
|
|
2161
|
+
## list_member_pending_points
|
2162
|
+
|
2163
|
+
> <LoyaltiesMembersPendingPointsListResponseBody> list_member_pending_points(member_id, opts)
|
2164
|
+
|
2165
|
+
List Member Pending Points
|
2166
|
+
|
2167
|
+
>🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. 📘 Alternative endpoint This endpoint is an alternative to this endpoint. The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned.
|
2168
|
+
|
2169
|
+
### Examples
|
2170
|
+
|
2171
|
+
```ruby
|
2172
|
+
require 'time'
|
2173
|
+
require 'VoucherifySdk'
|
2174
|
+
# setup authorization
|
2175
|
+
VoucherifySdk.configure do |config|
|
2176
|
+
# Configure API key authorization: X-App-Id
|
2177
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
2178
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2179
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
2180
|
+
|
2181
|
+
# Configure API key authorization: X-App-Token
|
2182
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
2183
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2184
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
2185
|
+
end
|
2186
|
+
|
2187
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
2188
|
+
member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
|
2189
|
+
opts = {
|
2190
|
+
limit: 56, # Integer | Limit the number of the pending point entries that the API returns in the response.
|
2191
|
+
order: VoucherifySdk::ParameterOrderListPendingPoints::ID, # ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
2192
|
+
starting_after_id: 'starting_after_id_example' # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
2193
|
+
}
|
2194
|
+
|
2195
|
+
begin
|
2196
|
+
# List Member Pending Points
|
2197
|
+
result = api_instance.list_member_pending_points(member_id, opts)
|
2198
|
+
p result
|
2199
|
+
rescue VoucherifySdk::ApiError => e
|
2200
|
+
puts "Error when calling LoyaltiesApi->list_member_pending_points: #{e}"
|
2201
|
+
end
|
2202
|
+
```
|
2203
|
+
|
2204
|
+
### Parameters
|
2205
|
+
|
2206
|
+
| Name | Type | Description | Notes |
|
2207
|
+
| ---- | ---- | ----------- | ----- |
|
2208
|
+
| **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
|
2209
|
+
| **limit** | **Integer** | Limit the number of the pending point entries that the API returns in the response. | [optional] |
|
2210
|
+
| **order** | [**ParameterOrderListPendingPoints**](.md) | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
2211
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
|
2212
|
+
|
2213
|
+
### Return type
|
2214
|
+
|
2215
|
+
[**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md)
|
2216
|
+
|
2217
|
+
### Authorization
|
2218
|
+
|
2219
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
2220
|
+
|
2221
|
+
### HTTP request headers
|
2222
|
+
|
2223
|
+
- **Content-Type**: Not defined
|
2224
|
+
- **Accept**: application/json
|
2225
|
+
|
2226
|
+
|
2227
|
+
## list_member_pending_points1
|
2228
|
+
|
2229
|
+
> <LoyaltiesMembersPendingPointsListResponseBody> list_member_pending_points1(campaign_id, member_id, opts)
|
2230
|
+
|
2231
|
+
List Member Pending Points
|
2232
|
+
|
2233
|
+
>🚧 Beta endpoint The endpoint is behind a feature flag as it is still in development. Contact [Voucherify support](https://www.voucherify.io/contact-support) to unlock the feature for your organization. All current parameters and fields are listed and described. Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned.
|
2234
|
+
|
2235
|
+
### Examples
|
2236
|
+
|
2237
|
+
```ruby
|
2238
|
+
require 'time'
|
2239
|
+
require 'VoucherifySdk'
|
2240
|
+
# setup authorization
|
2241
|
+
VoucherifySdk.configure do |config|
|
2242
|
+
# Configure API key authorization: X-App-Id
|
2243
|
+
config.api_key['X-App-Id'] = 'YOUR API KEY'
|
2244
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2245
|
+
# config.api_key_prefix['X-App-Id'] = 'Bearer'
|
2246
|
+
|
2247
|
+
# Configure API key authorization: X-App-Token
|
2248
|
+
config.api_key['X-App-Token'] = 'YOUR API KEY'
|
2249
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2250
|
+
# config.api_key_prefix['X-App-Token'] = 'Bearer'
|
2251
|
+
end
|
2252
|
+
|
2253
|
+
api_instance = VoucherifySdk::LoyaltiesApi.new
|
2254
|
+
campaign_id = 'campaign_id_example' # String | Unique campaign ID.
|
2255
|
+
member_id = 'member_id_example' # String | Unique loyalty card code assigned to a particular customer.
|
2256
|
+
opts = {
|
2257
|
+
limit: 56, # Integer | Limit the number of the pending point entries that the API returns in the response.
|
2258
|
+
order: VoucherifySdk::ParameterOrderListPendingPoints::ID, # ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order.
|
2259
|
+
starting_after_id: 'starting_after_id_example' # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
|
2260
|
+
}
|
2261
|
+
|
2262
|
+
begin
|
2263
|
+
# List Member Pending Points
|
2264
|
+
result = api_instance.list_member_pending_points1(campaign_id, member_id, opts)
|
2265
|
+
p result
|
2266
|
+
rescue VoucherifySdk::ApiError => e
|
2267
|
+
puts "Error when calling LoyaltiesApi->list_member_pending_points1: #{e}"
|
2268
|
+
end
|
2269
|
+
```
|
2270
|
+
|
2271
|
+
### Parameters
|
2272
|
+
|
2273
|
+
| Name | Type | Description | Notes |
|
2274
|
+
| ---- | ---- | ----------- | ----- |
|
2275
|
+
| **campaign_id** | **String** | Unique campaign ID. | |
|
2276
|
+
| **member_id** | **String** | Unique loyalty card code assigned to a particular customer. | |
|
2277
|
+
| **limit** | **Integer** | Limit the number of the pending point entries that the API returns in the response. | [optional] |
|
2278
|
+
| **order** | [**ParameterOrderListPendingPoints**](.md) | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
|
2279
|
+
| **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
|
2280
|
+
|
2281
|
+
### Return type
|
2282
|
+
|
2283
|
+
[**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md)
|
2284
|
+
|
2285
|
+
### Authorization
|
2286
|
+
|
2287
|
+
[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
|
2288
|
+
|
2289
|
+
### HTTP request headers
|
2290
|
+
|
2291
|
+
- **Content-Type**: Not defined
|
2292
|
+
- **Accept**: application/json
|
2293
|
+
|
2294
|
+
|
1971
2295
|
## list_member_rewards
|
1972
2296
|
|
1973
2297
|
> <LoyaltiesMembersRewardsListResponseBody> list_member_rewards(member_id, opts)
|
@@ -2110,7 +2434,7 @@ end
|
|
2110
2434
|
|
2111
2435
|
> <LoyaltiesMembersPointsExpirationListResponseBody> list_points_expiration(campaign_id, member_id, opts)
|
2112
2436
|
|
2113
|
-
|
2437
|
+
List Loyalty Card Point Expiration
|
2114
2438
|
|
2115
2439
|
Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.
|
2116
2440
|
|
@@ -2141,7 +2465,7 @@ opts = {
|
|
2141
2465
|
}
|
2142
2466
|
|
2143
2467
|
begin
|
2144
|
-
#
|
2468
|
+
# List Loyalty Card Point Expiration
|
2145
2469
|
result = api_instance.list_points_expiration(campaign_id, member_id, opts)
|
2146
2470
|
p result
|
2147
2471
|
rescue VoucherifySdk::ApiError => e
|
@@ -20,6 +20,7 @@
|
|
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
|
| **validation_rules** | **Array<String>** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] |
|
24
25
|
| **campaign_type** | **String** | Type of campaign. | [optional][default to 'LOYALTY_PROGRAM'] |
|
25
26
|
| **voucher** | [**CampaignLoyaltyVoucher**](CampaignLoyaltyVoucher.md) | | [optional] |
|
@@ -11,6 +11,7 @@
|
|
11
11
|
| **custom_event** | [**LoyaltiesEarningRulesCreateResponseBodyCustomEvent**](LoyaltiesEarningRulesCreateResponseBodyCustomEvent.md) | | [optional] |
|
12
12
|
| **segment** | [**LoyaltiesEarningRulesCreateResponseBodySegment**](LoyaltiesEarningRulesCreateResponseBodySegment.md) | | [optional] |
|
13
13
|
| **loyalty_tier** | [**LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier**](LoyaltiesEarningRulesCreateResponseBodyLoyaltyTier.md) | | [optional] |
|
14
|
+
| **pending_points** | [**LoyaltiesEarningRulesCreateResponseBodyPendingPoints**](LoyaltiesEarningRulesCreateResponseBodyPendingPoints.md) | | [optional] |
|
14
15
|
| **source** | [**LoyaltiesEarningRulesCreateResponseBodySource**](LoyaltiesEarningRulesCreateResponseBodySource.md) | | [optional] |
|
15
16
|
| **object** | **String** | The type of the object represented by JSON. Default is earning_rule. | [optional][default to 'earning_rule'] |
|
16
17
|
| **automation_id** | **String** | For internal use by Voucherify. | [optional] |
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VoucherifySdk::LoyaltiesEarningRulesCreateResponseBodyPendingPoints
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **period_type** | **String** | Defines the type of the period during which the points are in the pending state. Currently, only `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
|
+
|