talon_one 13.0.0 → 14.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +98 -14
- data/docs/AchievementBlockReference.md +23 -0
- data/docs/AddedDeductedPointsBalancesAction.md +7 -1
- data/docs/AddedDeductedPointsNotification.md +7 -1
- data/docs/ApplicationCustomer.md +3 -1
- data/docs/ApplicationEvent.md +1 -1
- data/docs/AttributeBlockReference.md +25 -0
- data/docs/AudienceBlockReference.md +23 -0
- data/docs/AwardGiveawayBlock.md +1 -3
- data/docs/AwardItemBlock.md +1 -1
- data/docs/AwardLoyaltyPointsAllItemsTarget.md +17 -0
- data/docs/AwardLoyaltyPointsBlock.md +45 -0
- data/docs/AwardLoyaltyPointsBlockProgram.md +21 -0
- data/docs/AwardLoyaltyPointsBundleTarget.md +19 -0
- data/docs/AwardLoyaltyPointsCartTarget.md +17 -0
- data/docs/AwardLoyaltyPointsGlobalFilterTarget.md +19 -0
- data/docs/AwardLoyaltyPointsSelectorTarget.md +19 -0
- data/docs/BestPriorPrice.md +1 -1
- data/docs/BestPriorPriceRequest.md +1 -1
- data/docs/BoostLoyaltyTierEffectProps.md +27 -0
- data/docs/Bundle.md +1 -1
- data/docs/Campaign.md +1 -1
- data/docs/CampaignEligibilityDetails.md +2 -2
- data/docs/CampaignEvaluationTreeChangedMessage.md +2 -2
- data/docs/CampaignVersions.md +1 -1
- data/docs/CardAddedDeductedPointsNotification.md +7 -1
- data/docs/CatalogRuleset.md +21 -0
- data/docs/CheckAchievementBlock.md +1 -1
- data/docs/CheckAudienceBlock.md +2 -2
- data/docs/CheckCouponBlock.md +2 -2
- data/docs/CheckLoyaltyBalanceBlock.md +2 -2
- data/docs/CheckLoyaltyBalanceBlockProgram.md +2 -2
- data/docs/CheckReferralBlock.md +2 -2
- data/docs/CheckTierBlock.md +2 -2
- data/docs/CouponReservation.md +21 -0
- data/docs/CouponWithReservations.md +61 -0
- data/docs/CustomEffectBlockReference.md +21 -0
- data/docs/CustomerAchievementHistoryEntry.md +27 -0
- data/docs/CustomerProfileIntegrationRequestV2.md +3 -1
- data/docs/CustomerProfileIntegrationResponseV2.md +1 -1
- data/docs/CustomerProfileReward.md +2 -2
- data/docs/CustomerReservation.md +39 -0
- data/docs/DigitalPass.md +1 -1
- data/docs/EffectAcceptCoupon.md +53 -0
- data/docs/EffectAcceptReferral.md +53 -0
- data/docs/EffectAddFreeItem.md +53 -0
- data/docs/EffectAddLoyaltyPoints.md +53 -0
- data/docs/EffectAddNegativeLoyaltyPoints.md +51 -0
- data/docs/EffectAddToAudience.md +53 -0
- data/docs/EffectAwardGiveaway.md +53 -0
- data/docs/EffectBoostLoyaltyTier.md +53 -0
- data/docs/EffectCallApi.md +53 -0
- data/docs/EffectChangeLoyaltyTierLevel.md +53 -0
- data/docs/EffectCouponCreated.md +53 -0
- data/docs/EffectCustomEffect.md +53 -0
- data/docs/EffectDeductLoyaltyPoints.md +53 -0
- data/docs/EffectEntity.md +4 -2
- data/docs/EffectError.md +53 -0
- data/docs/EffectExtendLoyaltyPointsExpiryDate.md +53 -0
- data/docs/EffectIncreaseAchievementProgress.md +53 -0
- data/docs/EffectIncreaseAchievementProgressPerItem.md +53 -0
- data/docs/EffectJoinLoyaltyProgram.md +53 -0
- data/docs/EffectOffsetNegativeLoyaltyPoints.md +51 -0
- data/docs/EffectRedeemReferral.md +53 -0
- data/docs/EffectReferralCreated.md +53 -0
- data/docs/EffectRejectCoupon.md +53 -0
- data/docs/EffectRejectReferral.md +53 -0
- data/docs/EffectRemoveFromAudience.md +53 -0
- data/docs/EffectReserveCoupon.md +53 -0
- data/docs/EffectRollbackAddedLoyaltyPoints.md +53 -0
- data/docs/EffectRollbackCoupon.md +53 -0
- data/docs/EffectRollbackDeductedLoyaltyPoints.md +53 -0
- data/docs/EffectRollbackDiscount.md +53 -0
- data/docs/EffectRollbackIncreasedAchievementProgress.md +53 -0
- data/docs/EffectRollbackIncreasedAchievementProgressPerItem.md +53 -0
- data/docs/EffectRollbackReferral.md +53 -0
- data/docs/EffectRollbackTierBoost.md +53 -0
- data/docs/EffectRollbackUseReward.md +53 -0
- data/docs/EffectSet.md +53 -0
- data/docs/EffectSetDiscount.md +53 -0
- data/docs/EffectSetDiscountPerAdditionalCost.md +53 -0
- data/docs/EffectSetDiscountPerAdditionalCostPerItem.md +53 -0
- data/docs/EffectSetDiscountPerItem.md +53 -0
- data/docs/EffectSetLoyaltyPointsExpiryDate.md +53 -0
- data/docs/EffectShowBundleMetadata.md +53 -0
- data/docs/EffectShowNotification.md +53 -0
- data/docs/EffectStartAchievementProgress.md +53 -0
- data/docs/EffectUnlockReward.md +53 -0
- data/docs/EffectUseReward.md +53 -0
- data/docs/EffectWillAwardGiveaway.md +53 -0
- data/docs/Environment.md +1 -1
- data/docs/Experiment.md +3 -1
- data/docs/ExperimentBlueprint.md +41 -0
- data/docs/ExperimentBlueprintVariant.md +23 -0
- data/docs/ExperimentCopyExperiment.md +4 -2
- data/docs/ExperimentVariant.md +3 -1
- data/docs/ExpiringCardPointsData.md +7 -1
- data/docs/ExpiringPointsData.md +7 -1
- data/docs/GiveawayPoolBlockReference.md +19 -0
- data/docs/GiveawaysPool.md +6 -6
- data/docs/History.md +1 -1
- data/docs/IncreaseAchievementProgressPerItemEffectProps.md +37 -0
- data/docs/InlineResponse2001.md +1 -1
- data/docs/InlineResponse20010.md +1 -1
- data/docs/InlineResponse20011.md +1 -1
- data/docs/InlineResponse20012.md +3 -3
- data/docs/InlineResponse20013.md +3 -3
- data/docs/InlineResponse20014.md +3 -3
- data/docs/InlineResponse20015.md +1 -1
- data/docs/InlineResponse20016.md +1 -1
- data/docs/InlineResponse20017.md +3 -3
- data/docs/InlineResponse20018.md +1 -1
- data/docs/InlineResponse20019.md +3 -3
- data/docs/InlineResponse20020.md +3 -3
- data/docs/InlineResponse20021.md +2 -2
- data/docs/InlineResponse20022.md +3 -5
- data/docs/InlineResponse20023.md +3 -3
- data/docs/InlineResponse20024.md +4 -2
- data/docs/InlineResponse20025.md +5 -3
- data/docs/InlineResponse20026.md +3 -5
- data/docs/InlineResponse20027.md +2 -4
- data/docs/InlineResponse20028.md +3 -5
- data/docs/InlineResponse20029.md +5 -3
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse20030.md +4 -2
- data/docs/InlineResponse20031.md +3 -1
- data/docs/InlineResponse20032.md +2 -4
- data/docs/InlineResponse20033.md +1 -1
- data/docs/InlineResponse20034.md +3 -3
- data/docs/InlineResponse20035.md +2 -2
- data/docs/InlineResponse20036.md +2 -2
- data/docs/InlineResponse20037.md +3 -3
- data/docs/InlineResponse20038.md +1 -1
- data/docs/InlineResponse20039.md +3 -3
- data/docs/InlineResponse2004.md +5 -3
- data/docs/InlineResponse20040.md +1 -3
- data/docs/InlineResponse20041.md +5 -3
- data/docs/InlineResponse20042.md +1 -1
- data/docs/InlineResponse20043.md +5 -3
- data/docs/InlineResponse20044.md +1 -1
- data/docs/InlineResponse20045.md +2 -4
- data/docs/InlineResponse20046.md +1 -1
- data/docs/InlineResponse20047.md +1 -1
- data/docs/InlineResponse20048.md +4 -4
- data/docs/InlineResponse20049.md +3 -3
- data/docs/InlineResponse2005.md +1 -1
- data/docs/InlineResponse20050.md +4 -2
- data/docs/InlineResponse20051.md +6 -2
- data/docs/InlineResponse20052.md +1 -1
- data/docs/InlineResponse20053.md +2 -4
- data/docs/InlineResponse20054.md +2 -4
- data/docs/InlineResponse20055.md +4 -2
- data/docs/InlineResponse20056.md +4 -4
- data/docs/InlineResponse20057.md +19 -0
- data/docs/InlineResponse20058.md +17 -0
- data/docs/InlineResponse20059.md +19 -0
- data/docs/InlineResponse20059Catalog.md +19 -0
- data/docs/InlineResponse2006.md +1 -1
- data/docs/InlineResponse2007.md +1 -1
- data/docs/InlineResponse2008.md +3 -3
- data/docs/InlineResponse2009.md +3 -3
- data/docs/IntegrationApi.md +84 -19
- data/docs/IntegrationCustomerSessionResponse.md +1 -1
- data/docs/IntegrationEventV2Request.md +3 -1
- data/docs/IntegrationEventV2Response.md +1 -1
- data/docs/IntegrationEventV3Request.md +2 -0
- data/docs/IntegrationEventV3Response.md +1 -1
- data/docs/IntegrationHubEventPayloadLoyaltyProfileBasedPointsChangedNotificationAction.md +7 -1
- data/docs/IntegrationResponse.md +1 -1
- data/docs/IntegrationStateV2.md +1 -1
- data/docs/IntegrationUnlockRewardRequest.md +2 -2
- data/docs/IntegrationUnlockRewardResponse.md +21 -0
- data/docs/LedgerTransactionLogEntryManagementAPI.md +49 -0
- data/docs/LoyaltyLedgerEntry.md +3 -1
- data/docs/ManagementApi.md +433 -149
- data/docs/NewDigitalPass.md +1 -1
- data/docs/NewExperiment.md +4 -2
- data/docs/NewExperimentBlueprint.md +25 -0
- data/docs/NewExperimentVariant.md +4 -2
- data/docs/NewGiveawaysPool.md +3 -3
- data/docs/NewPriceAdjustment.md +1 -1
- data/docs/NewReward.md +5 -1
- data/docs/OutboundLog.md +39 -0
- data/docs/OutboundLogBase.md +33 -0
- data/docs/OutboundLogRequest.md +23 -0
- data/docs/OutboundLogResponse.md +22 -0
- data/docs/OutboundLogs.md +19 -0
- data/docs/OutboundMessage.md +45 -0
- data/docs/OutboundMessageResponse.md +26 -0
- data/docs/OutboundMessages.md +19 -0
- data/docs/PendingActivePointsData.md +7 -1
- data/docs/RedeemLoyaltyPointsBlock.md +1 -3
- data/docs/RedeemLoyaltyPointsBlockProgram.md +2 -2
- data/docs/ReopenSessionResponse.md +1 -1
- data/docs/Revision.md +16 -16
- data/docs/RevisionActivation.md +2 -2
- data/docs/RevisionVersion.md +13 -13
- data/docs/Reward.md +4 -0
- data/docs/RewardEligibility.md +1 -1
- data/docs/RoleV2.md +1 -1
- data/docs/RoleV2ApplicationDetails.md +3 -3
- data/docs/RoleV2PermissionSet.md +1 -1
- data/docs/RoleV2Readonly.md +1 -1
- data/docs/RoleV2RolesGroup.md +4 -4
- data/docs/RollbackIncreasedAchievementProgressPerItemEffectProps.md +35 -0
- data/docs/RollbackTierBoostEffectProps.md +23 -0
- data/docs/RuleEligibility.md +2 -2
- data/docs/RuleEligibilityFailureDetails.md +4 -0
- data/docs/RuleFailureReason.md +1 -1
- data/docs/RulesetV2.md +2 -2
- data/docs/ShowNotificationBlock.md +1 -3
- data/docs/StartAchievementProgressEffectProps.md +2 -2
- data/docs/StrikethroughLabelingNotification.md +1 -1
- data/docs/SupportBalances.md +21 -0
- data/docs/SupportRequest.md +2 -2
- data/docs/SupportRequestInput.md +2 -2
- data/docs/Tier.md +6 -2
- data/docs/TierBlockReference.md +23 -0
- data/docs/TierDowngradeData.md +5 -1
- data/docs/TierUpgradeData.md +5 -1
- data/docs/TierWillDowngradeData.md +5 -1
- data/docs/TriggerCustomEffectBlock.md +1 -1
- data/docs/TriggerWebhookBlock.md +1 -1
- data/docs/UnlockRewardEffectProps.md +2 -2
- data/docs/UpdateAchievementProgressBlock.md +3 -3
- data/docs/UpdateAttributeValueBlock.md +1 -1
- data/docs/UpdateAudienceMembershipBlock.md +1 -1
- data/docs/UpdateExperiment.md +1 -1
- data/docs/UpdateExperimentBlueprint.md +25 -0
- data/docs/UpdateExperimentVariant.md +4 -2
- data/docs/UpdateLoyaltyPointsExpiryBlock.md +33 -0
- data/docs/UpdateLoyaltyPointsExpiryBlockProgram.md +21 -0
- data/docs/UpdateReward.md +5 -1
- data/docs/WebhookBlockReference.md +19 -0
- data/lib/talon_one/api/integration_api.rb +113 -27
- data/lib/talon_one/api/management_api.rb +504 -210
- data/lib/talon_one/models/achievement_block_reference.rb +243 -0
- data/lib/talon_one/models/add_free_item_effect_props.rb +1 -1
- data/lib/talon_one/models/added_deducted_points_balances_action.rb +34 -4
- data/lib/talon_one/models/added_deducted_points_notification.rb +34 -4
- data/lib/talon_one/models/application_customer.rb +16 -4
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/attribute_block_reference.rb +263 -0
- data/lib/talon_one/models/audience_block_reference.rb +243 -0
- data/lib/talon_one/models/award_giveaway_block.rb +2 -14
- data/lib/talon_one/models/award_item_block.rb +1 -1
- data/lib/talon_one/models/award_loyalty_points_all_items_target.rb +247 -0
- data/lib/talon_one/models/award_loyalty_points_block.rb +418 -0
- data/lib/talon_one/models/award_loyalty_points_block_program.rb +233 -0
- data/lib/talon_one/models/award_loyalty_points_bundle_target.rb +262 -0
- data/lib/talon_one/models/award_loyalty_points_cart_target.rb +247 -0
- data/lib/talon_one/models/award_loyalty_points_global_filter_target.rb +262 -0
- data/lib/talon_one/models/award_loyalty_points_selector_target.rb +262 -0
- data/lib/talon_one/models/best_prior_price.rb +1 -1
- data/lib/talon_one/models/best_prior_price_request.rb +1 -1
- data/lib/talon_one/models/boost_loyalty_tier_effect_props.rb +283 -0
- data/lib/talon_one/models/bundle.rb +0 -5
- data/lib/talon_one/models/campaign.rb +1 -1
- data/lib/talon_one/models/campaign_evaluation_tree_changed_message.rb +7 -2
- data/lib/talon_one/models/campaign_versions.rb +1 -1
- data/lib/talon_one/models/card_added_deducted_points_notification.rb +34 -4
- data/lib/talon_one/models/catalog_ruleset.rb +237 -0
- data/lib/talon_one/models/check_achievement_block.rb +1 -1
- data/lib/talon_one/models/check_audience_block.rb +2 -7
- data/lib/talon_one/models/check_coupon_block.rb +35 -1
- data/lib/talon_one/models/check_loyalty_balance_block.rb +2 -2
- data/lib/talon_one/models/check_loyalty_balance_block_program.rb +0 -10
- data/lib/talon_one/models/check_referral_block.rb +35 -1
- data/lib/talon_one/models/check_tier_block.rb +3 -3
- data/lib/talon_one/models/coupon_reservation.rb +237 -0
- data/lib/talon_one/models/coupon_with_reservations.rb +575 -0
- data/lib/talon_one/models/custom_effect_block_reference.rb +233 -0
- data/lib/talon_one/models/customer_achievement_history_entry.rb +307 -0
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +16 -4
- data/lib/talon_one/models/customer_profile_integration_response_v2.rb +1 -1
- data/lib/talon_one/models/customer_profile_reward.rb +25 -25
- data/lib/talon_one/models/customer_reservation.rb +380 -0
- data/lib/talon_one/models/digital_pass.rb +1 -1
- data/lib/talon_one/models/effect_accept_coupon.rb +451 -0
- data/lib/talon_one/models/effect_accept_referral.rb +451 -0
- data/lib/talon_one/models/effect_add_free_item.rb +451 -0
- data/lib/talon_one/models/effect_add_loyalty_points.rb +451 -0
- data/lib/talon_one/models/effect_add_negative_loyalty_points.rb +437 -0
- data/lib/talon_one/models/effect_add_to_audience.rb +451 -0
- data/lib/talon_one/models/effect_award_giveaway.rb +451 -0
- data/lib/talon_one/models/effect_boost_loyalty_tier.rb +451 -0
- data/lib/talon_one/models/effect_call_api.rb +451 -0
- data/lib/talon_one/models/effect_change_loyalty_tier_level.rb +451 -0
- data/lib/talon_one/models/effect_coupon_created.rb +451 -0
- data/lib/talon_one/models/effect_custom_effect.rb +451 -0
- data/lib/talon_one/models/effect_deduct_loyalty_points.rb +451 -0
- data/lib/talon_one/models/effect_entity.rb +15 -5
- data/lib/talon_one/models/effect_error.rb +451 -0
- data/lib/talon_one/models/effect_extend_loyalty_points_expiry_date.rb +451 -0
- data/lib/talon_one/models/effect_increase_achievement_progress.rb +451 -0
- data/lib/talon_one/models/effect_increase_achievement_progress_per_item.rb +451 -0
- data/lib/talon_one/models/effect_join_loyalty_program.rb +451 -0
- data/lib/talon_one/models/effect_offset_negative_loyalty_points.rb +437 -0
- data/lib/talon_one/models/effect_redeem_referral.rb +451 -0
- data/lib/talon_one/models/effect_referral_created.rb +451 -0
- data/lib/talon_one/models/effect_reject_coupon.rb +451 -0
- data/lib/talon_one/models/effect_reject_referral.rb +451 -0
- data/lib/talon_one/models/effect_remove_from_audience.rb +451 -0
- data/lib/talon_one/models/effect_reserve_coupon.rb +451 -0
- data/lib/talon_one/models/effect_rollback_added_loyalty_points.rb +451 -0
- data/lib/talon_one/models/effect_rollback_coupon.rb +451 -0
- data/lib/talon_one/models/effect_rollback_deducted_loyalty_points.rb +451 -0
- data/lib/talon_one/models/effect_rollback_discount.rb +451 -0
- data/lib/talon_one/models/effect_rollback_increased_achievement_progress.rb +451 -0
- data/lib/talon_one/models/effect_rollback_increased_achievement_progress_per_item.rb +451 -0
- data/lib/talon_one/models/effect_rollback_referral.rb +451 -0
- data/lib/talon_one/models/effect_rollback_tier_boost.rb +451 -0
- data/lib/talon_one/models/effect_rollback_use_reward.rb +451 -0
- data/lib/talon_one/models/effect_set.rb +451 -0
- data/lib/talon_one/models/effect_set_discount.rb +451 -0
- data/lib/talon_one/models/effect_set_discount_per_additional_cost.rb +451 -0
- data/lib/talon_one/models/effect_set_discount_per_additional_cost_per_item.rb +451 -0
- data/lib/talon_one/models/effect_set_discount_per_item.rb +451 -0
- data/lib/talon_one/models/effect_set_loyalty_points_expiry_date.rb +451 -0
- data/lib/talon_one/models/effect_show_bundle_metadata.rb +451 -0
- data/lib/talon_one/models/effect_show_notification.rb +451 -0
- data/lib/talon_one/models/effect_start_achievement_progress.rb +451 -0
- data/lib/talon_one/models/effect_unlock_reward.rb +451 -0
- data/lib/talon_one/models/effect_use_reward.rb +451 -0
- data/lib/talon_one/models/effect_will_award_giveaway.rb +451 -0
- data/lib/talon_one/models/environment.rb +1 -1
- data/lib/talon_one/models/experiment.rb +24 -2
- data/lib/talon_one/models/experiment_blueprint.rb +427 -0
- data/lib/talon_one/models/experiment_blueprint_variant.rb +313 -0
- data/lib/talon_one/models/experiment_copy_experiment.rb +24 -7
- data/lib/talon_one/models/experiment_variant.rb +14 -4
- data/lib/talon_one/models/expiring_card_points_data.rb +34 -4
- data/lib/talon_one/models/expiring_points_data.rb +34 -4
- data/lib/talon_one/models/giveaway_pool_block_reference.rb +223 -0
- data/lib/talon_one/models/giveaways_pool.rb +7 -7
- data/lib/talon_one/models/history.rb +1 -1
- data/lib/talon_one/models/increase_achievement_progress_per_item_effect_props.rb +343 -0
- data/lib/talon_one/models/inline_response2001.rb +1 -1
- data/lib/talon_one/models/inline_response20010.rb +1 -1
- data/lib/talon_one/models/inline_response20011.rb +1 -1
- data/lib/talon_one/models/inline_response20012.rb +11 -11
- data/lib/talon_one/models/inline_response20013.rb +11 -11
- data/lib/talon_one/models/inline_response20014.rb +11 -11
- data/lib/talon_one/models/inline_response20015.rb +1 -1
- data/lib/talon_one/models/inline_response20016.rb +1 -1
- data/lib/talon_one/models/inline_response20017.rb +11 -11
- data/lib/talon_one/models/inline_response20018.rb +1 -1
- data/lib/talon_one/models/inline_response20019.rb +11 -11
- data/lib/talon_one/models/inline_response20020.rb +11 -11
- data/lib/talon_one/models/inline_response20021.rb +1 -3
- data/lib/talon_one/models/inline_response20022.rb +7 -11
- data/lib/talon_one/models/inline_response20023.rb +3 -1
- data/lib/talon_one/models/inline_response20024.rb +11 -7
- data/lib/talon_one/models/inline_response20025.rb +11 -7
- data/lib/talon_one/models/inline_response20026.rb +7 -11
- data/lib/talon_one/models/inline_response20027.rb +7 -11
- data/lib/talon_one/models/inline_response20028.rb +7 -11
- data/lib/talon_one/models/inline_response20029.rb +11 -7
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- data/lib/talon_one/models/inline_response20030.rb +11 -7
- data/lib/talon_one/models/inline_response20031.rb +11 -2
- data/lib/talon_one/models/inline_response20032.rb +7 -11
- data/lib/talon_one/models/inline_response20033.rb +1 -1
- data/lib/talon_one/models/inline_response20034.rb +8 -13
- data/lib/talon_one/models/inline_response20035.rb +1 -1
- data/lib/talon_one/models/inline_response20036.rb +6 -1
- data/lib/talon_one/models/inline_response20037.rb +13 -8
- data/lib/talon_one/models/inline_response20038.rb +1 -1
- data/lib/talon_one/models/inline_response20039.rb +8 -13
- data/lib/talon_one/models/inline_response2004.rb +11 -7
- data/lib/talon_one/models/inline_response20040.rb +2 -11
- data/lib/talon_one/models/inline_response20041.rb +11 -7
- data/lib/talon_one/models/inline_response20042.rb +1 -1
- data/lib/talon_one/models/inline_response20043.rb +11 -7
- data/lib/talon_one/models/inline_response20044.rb +1 -1
- data/lib/talon_one/models/inline_response20045.rb +7 -11
- data/lib/talon_one/models/inline_response20046.rb +1 -1
- data/lib/talon_one/models/inline_response20047.rb +1 -1
- data/lib/talon_one/models/inline_response20048.rb +11 -11
- data/lib/talon_one/models/inline_response20049.rb +13 -8
- data/lib/talon_one/models/inline_response2005.rb +1 -1
- data/lib/talon_one/models/inline_response20050.rb +23 -2
- data/lib/talon_one/models/inline_response20051.rb +25 -2
- data/lib/talon_one/models/inline_response20052.rb +1 -1
- data/lib/talon_one/models/inline_response20053.rb +2 -16
- data/lib/talon_one/models/inline_response20054.rb +2 -21
- data/lib/talon_one/models/inline_response20055.rb +11 -2
- data/lib/talon_one/models/inline_response20056.rb +17 -18
- data/lib/talon_one/models/inline_response20057.rb +227 -0
- data/lib/talon_one/models/inline_response20058.rb +213 -0
- data/lib/talon_one/models/inline_response20059.rb +223 -0
- data/lib/talon_one/models/inline_response20059_catalog.rb +229 -0
- data/lib/talon_one/models/inline_response2006.rb +1 -1
- data/lib/talon_one/models/inline_response2007.rb +1 -1
- data/lib/talon_one/models/inline_response2008.rb +11 -11
- data/lib/talon_one/models/inline_response2009.rb +11 -11
- data/lib/talon_one/models/integration_customer_session_response.rb +1 -1
- data/lib/talon_one/models/integration_event_v2_request.rb +16 -4
- data/lib/talon_one/models/integration_event_v2_response.rb +1 -1
- data/lib/talon_one/models/integration_event_v3_request.rb +13 -1
- data/lib/talon_one/models/integration_event_v3_response.rb +1 -1
- data/lib/talon_one/models/integration_hub_event_payload_loyalty_profile_based_points_changed_notification_action.rb +34 -4
- data/lib/talon_one/models/integration_response.rb +1 -1
- data/lib/talon_one/models/integration_state_v2.rb +1 -1
- data/lib/talon_one/models/integration_unlock_reward_request.rb +25 -25
- data/lib/talon_one/models/integration_unlock_reward_response.rb +233 -0
- data/lib/talon_one/models/label_target_audience.rb +1 -1
- data/lib/talon_one/models/label_target_none.rb +1 -1
- data/lib/talon_one/models/ledger_transaction_log_entry_management_api.rb +554 -0
- data/lib/talon_one/models/loyalty_card_batch.rb +28 -0
- data/lib/talon_one/models/loyalty_ledger_entry.rb +14 -4
- data/lib/talon_one/models/new_coupons.rb +28 -0
- data/lib/talon_one/models/new_digital_pass.rb +1 -1
- data/lib/talon_one/models/new_experiment.rb +24 -7
- data/lib/talon_one/models/new_experiment_blueprint.rb +292 -0
- data/lib/talon_one/models/new_experiment_variant.rb +20 -10
- data/lib/talon_one/models/new_giveaways_pool.rb +3 -3
- data/lib/talon_one/models/new_integration_hub_coupons.rb +28 -0
- data/lib/talon_one/models/new_price_adjustment.rb +1 -1
- data/lib/talon_one/models/new_reward.rb +24 -4
- data/lib/talon_one/models/outbound_log.rb +336 -0
- data/lib/talon_one/models/outbound_log_base.rb +297 -0
- data/lib/talon_one/models/outbound_log_request.rb +260 -0
- data/lib/talon_one/models/outbound_log_response.rb +228 -0
- data/lib/talon_one/models/outbound_logs.rb +242 -0
- data/lib/talon_one/models/outbound_message.rb +378 -0
- data/lib/talon_one/models/outbound_message_response.rb +258 -0
- data/lib/talon_one/models/outbound_messages.rb +242 -0
- data/lib/talon_one/models/pending_active_points_data.rb +34 -4
- data/lib/talon_one/models/redeem_loyalty_points_block.rb +4 -16
- data/lib/talon_one/models/redeem_loyalty_points_block_program.rb +0 -10
- data/lib/talon_one/models/reopen_session_response.rb +1 -1
- data/lib/talon_one/models/revision.rb +8 -0
- data/lib/talon_one/models/revision_activation.rb +1 -0
- data/lib/talon_one/models/revision_version.rb +7 -0
- data/lib/talon_one/models/reward.rb +21 -1
- data/lib/talon_one/models/role_v2.rb +2 -1
- data/lib/talon_one/models/role_v2_application_details.rb +1 -0
- data/lib/talon_one/models/role_v2_permission_set.rb +1 -1
- data/lib/talon_one/models/role_v2_permissions.rb +1 -0
- data/lib/talon_one/models/role_v2_readonly.rb +1 -1
- data/lib/talon_one/models/role_v2_roles_group.rb +4 -3
- data/lib/talon_one/models/roles_v2_thresholds.rb +1 -0
- data/lib/talon_one/models/rollback_increased_achievement_progress_per_item_effect_props.rb +333 -0
- data/lib/talon_one/models/rollback_tier_boost_effect_props.rb +258 -0
- data/lib/talon_one/models/rule_eligibility_failure_details.rb +21 -1
- data/lib/talon_one/models/rule_failure_reason.rb +1 -1
- data/lib/talon_one/models/show_notification_block.rb +7 -14
- data/lib/talon_one/models/start_achievement_progress_effect_props.rb +3 -3
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +1 -1
- data/lib/talon_one/models/support_balances.rb +233 -0
- data/lib/talon_one/models/support_request.rb +2 -2
- data/lib/talon_one/models/support_request_input.rb +2 -2
- data/lib/talon_one/models/tier.rb +38 -4
- data/lib/talon_one/models/tier_block_reference.rb +251 -0
- data/lib/talon_one/models/tier_downgrade_data.rb +60 -4
- data/lib/talon_one/models/tier_upgrade_data.rb +60 -4
- data/lib/talon_one/models/tier_will_downgrade_data.rb +60 -4
- data/lib/talon_one/models/trigger_custom_effect_block.rb +1 -1
- data/lib/talon_one/models/trigger_webhook_block.rb +1 -1
- data/lib/talon_one/models/unlock_reward_effect_props.rb +25 -25
- data/lib/talon_one/models/update_achievement_progress_block.rb +3 -3
- data/lib/talon_one/models/update_attribute_value_block.rb +1 -1
- data/lib/talon_one/models/update_audience_membership_block.rb +1 -1
- data/lib/talon_one/models/update_experiment.rb +1 -6
- data/lib/talon_one/models/update_experiment_blueprint.rb +285 -0
- data/lib/talon_one/models/update_experiment_variant.rb +20 -10
- data/lib/talon_one/models/update_loyalty_points_expiry_block.rb +367 -0
- data/lib/talon_one/models/update_loyalty_points_expiry_block_program.rb +233 -0
- data/lib/talon_one/models/update_reward.rb +24 -4
- data/lib/talon_one/models/webhook_block_reference.rb +223 -0
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +90 -11
- data/spec/api/integration_api_spec.rb +26 -10
- data/spec/api/management_api_spec.rb +136 -77
- data/spec/models/achievement_block_reference_spec.rb +59 -0
- data/spec/models/added_deducted_points_balances_action_spec.rb +18 -0
- data/spec/models/added_deducted_points_notification_spec.rb +18 -0
- data/spec/models/application_customer_spec.rb +6 -0
- data/spec/models/attribute_block_reference_spec.rb +65 -0
- data/spec/models/audience_block_reference_spec.rb +59 -0
- data/spec/models/award_giveaway_block_spec.rb +0 -6
- data/spec/models/award_loyalty_points_all_items_target_spec.rb +45 -0
- data/spec/models/award_loyalty_points_block_program_spec.rb +53 -0
- data/spec/models/award_loyalty_points_block_spec.rb +129 -0
- data/spec/models/award_loyalty_points_bundle_target_spec.rb +51 -0
- data/spec/models/award_loyalty_points_cart_target_spec.rb +45 -0
- data/spec/models/award_loyalty_points_global_filter_target_spec.rb +51 -0
- data/spec/models/award_loyalty_points_selector_target_spec.rb +51 -0
- data/spec/models/boost_loyalty_tier_effect_props_spec.rb +71 -0
- data/spec/models/campaign_evaluation_tree_changed_message_spec.rb +1 -1
- data/spec/models/card_added_deducted_points_notification_spec.rb +18 -0
- data/spec/models/catalog_ruleset_spec.rb +53 -0
- data/spec/models/check_coupon_block_spec.rb +4 -0
- data/spec/models/check_referral_block_spec.rb +4 -0
- data/spec/models/coupon_reservation_spec.rb +53 -0
- data/spec/models/coupon_with_reservations_spec.rb +173 -0
- data/spec/models/custom_effect_block_reference_spec.rb +53 -0
- data/spec/models/customer_achievement_history_entry_spec.rb +75 -0
- data/spec/models/customer_profile_integration_request_v2_spec.rb +6 -0
- data/spec/models/customer_profile_reward_spec.rb +1 -1
- data/spec/models/customer_reservation_spec.rb +107 -0
- data/spec/models/effect_accept_coupon_spec.rb +153 -0
- data/spec/models/effect_accept_referral_spec.rb +153 -0
- data/spec/models/effect_add_free_item_spec.rb +153 -0
- data/spec/models/effect_add_loyalty_points_spec.rb +153 -0
- data/spec/models/effect_add_negative_loyalty_points_spec.rb +147 -0
- data/spec/models/effect_add_to_audience_spec.rb +153 -0
- data/spec/models/effect_award_giveaway_spec.rb +153 -0
- data/spec/models/effect_boost_loyalty_tier_spec.rb +153 -0
- data/spec/models/effect_call_api_spec.rb +153 -0
- data/spec/models/effect_change_loyalty_tier_level_spec.rb +153 -0
- data/spec/models/effect_coupon_created_spec.rb +153 -0
- data/spec/models/effect_custom_effect_spec.rb +153 -0
- data/spec/models/effect_deduct_loyalty_points_spec.rb +153 -0
- data/spec/models/effect_entity_spec.rb +6 -0
- data/spec/models/effect_error_spec.rb +153 -0
- data/spec/models/effect_extend_loyalty_points_expiry_date_spec.rb +153 -0
- data/spec/models/effect_increase_achievement_progress_per_item_spec.rb +153 -0
- data/spec/models/effect_increase_achievement_progress_spec.rb +153 -0
- data/spec/models/effect_join_loyalty_program_spec.rb +153 -0
- data/spec/models/effect_offset_negative_loyalty_points_spec.rb +147 -0
- data/spec/models/effect_redeem_referral_spec.rb +153 -0
- data/spec/models/effect_referral_created_spec.rb +153 -0
- data/spec/models/effect_reject_coupon_spec.rb +153 -0
- data/spec/models/effect_reject_referral_spec.rb +153 -0
- data/spec/models/effect_remove_from_audience_spec.rb +153 -0
- data/spec/models/effect_reserve_coupon_spec.rb +153 -0
- data/spec/models/effect_rollback_added_loyalty_points_spec.rb +153 -0
- data/spec/models/effect_rollback_coupon_spec.rb +153 -0
- data/spec/models/effect_rollback_deducted_loyalty_points_spec.rb +153 -0
- data/spec/models/effect_rollback_discount_spec.rb +153 -0
- data/spec/models/effect_rollback_increased_achievement_progress_per_item_spec.rb +153 -0
- data/spec/models/effect_rollback_increased_achievement_progress_spec.rb +153 -0
- data/spec/models/effect_rollback_referral_spec.rb +153 -0
- data/spec/models/effect_rollback_tier_boost_spec.rb +153 -0
- data/spec/models/effect_rollback_use_reward_spec.rb +153 -0
- data/spec/models/effect_set_discount_per_additional_cost_per_item_spec.rb +153 -0
- data/spec/models/effect_set_discount_per_additional_cost_spec.rb +153 -0
- data/spec/models/effect_set_discount_per_item_spec.rb +153 -0
- data/spec/models/effect_set_discount_spec.rb +153 -0
- data/spec/models/effect_set_loyalty_points_expiry_date_spec.rb +153 -0
- data/spec/models/effect_set_spec.rb +153 -0
- data/spec/models/effect_show_bundle_metadata_spec.rb +153 -0
- data/spec/models/effect_show_notification_spec.rb +153 -0
- data/spec/models/effect_start_achievement_progress_spec.rb +153 -0
- data/spec/models/effect_unlock_reward_spec.rb +153 -0
- data/spec/models/effect_use_reward_spec.rb +153 -0
- data/spec/models/effect_will_award_giveaway_spec.rb +153 -0
- data/spec/models/experiment_blueprint_spec.rb +121 -0
- data/spec/models/experiment_blueprint_variant_spec.rb +59 -0
- data/spec/models/experiment_copy_experiment_spec.rb +10 -0
- data/spec/models/experiment_spec.rb +10 -0
- data/spec/models/experiment_variant_spec.rb +6 -0
- data/spec/models/expiring_card_points_data_spec.rb +18 -0
- data/spec/models/expiring_points_data_spec.rb +18 -0
- data/spec/models/giveaway_pool_block_reference_spec.rb +47 -0
- data/spec/models/increase_achievement_progress_per_item_effect_props_spec.rb +101 -0
- data/spec/models/inline_response20012_spec.rb +1 -1
- data/spec/models/inline_response20013_spec.rb +1 -1
- data/spec/models/inline_response20014_spec.rb +1 -1
- data/spec/models/inline_response20017_spec.rb +1 -1
- data/spec/models/inline_response20019_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +1 -1
- data/spec/models/inline_response20022_spec.rb +0 -6
- data/spec/models/inline_response20024_spec.rb +6 -0
- data/spec/models/inline_response20025_spec.rb +6 -0
- data/spec/models/inline_response20026_spec.rb +0 -6
- data/spec/models/inline_response20027_spec.rb +0 -6
- data/spec/models/inline_response20028_spec.rb +0 -6
- data/spec/models/inline_response20029_spec.rb +6 -0
- data/spec/models/inline_response20030_spec.rb +6 -0
- data/spec/models/inline_response20031_spec.rb +6 -0
- data/spec/models/inline_response20032_spec.rb +0 -6
- data/spec/models/inline_response20034_spec.rb +1 -1
- data/spec/models/inline_response20037_spec.rb +1 -1
- data/spec/models/inline_response20039_spec.rb +1 -1
- data/spec/models/inline_response20040_spec.rb +0 -6
- data/spec/models/inline_response20041_spec.rb +6 -0
- data/spec/models/inline_response20043_spec.rb +6 -0
- data/spec/models/inline_response20045_spec.rb +0 -6
- data/spec/models/inline_response20048_spec.rb +2 -2
- data/spec/models/inline_response20049_spec.rb +1 -1
- data/spec/models/inline_response2004_spec.rb +6 -0
- data/spec/models/inline_response20050_spec.rb +6 -0
- data/spec/models/inline_response20051_spec.rb +12 -0
- data/spec/models/inline_response20053_spec.rb +0 -6
- data/spec/models/inline_response20054_spec.rb +0 -6
- data/spec/models/inline_response20055_spec.rb +6 -0
- data/spec/models/inline_response20056_spec.rb +2 -2
- data/spec/models/inline_response20057_spec.rb +47 -0
- data/spec/models/inline_response20058_spec.rb +41 -0
- data/spec/models/inline_response20059_catalog_spec.rb +47 -0
- data/spec/models/inline_response20059_spec.rb +47 -0
- data/spec/models/inline_response2008_spec.rb +1 -1
- data/spec/models/inline_response2009_spec.rb +1 -1
- data/spec/models/integration_event_v2_request_spec.rb +6 -0
- data/spec/models/integration_event_v3_request_spec.rb +7 -1
- data/spec/models/integration_hub_event_payload_loyalty_profile_based_points_changed_notification_action_spec.rb +18 -0
- data/spec/models/integration_unlock_reward_request_spec.rb +1 -1
- data/spec/models/integration_unlock_reward_response_spec.rb +53 -0
- data/spec/models/ledger_transaction_log_entry_management_api_spec.rb +141 -0
- data/spec/models/loyalty_ledger_entry_spec.rb +6 -0
- data/spec/models/new_experiment_blueprint_spec.rb +69 -0
- data/spec/models/new_experiment_spec.rb +10 -0
- data/spec/models/new_experiment_variant_spec.rb +6 -0
- data/spec/models/new_reward_spec.rb +12 -0
- data/spec/models/outbound_log_base_spec.rb +89 -0
- data/spec/models/outbound_log_request_spec.rb +59 -0
- data/spec/models/outbound_log_response_spec.rb +47 -0
- data/spec/models/outbound_log_spec.rb +107 -0
- data/spec/models/outbound_logs_spec.rb +47 -0
- data/spec/models/outbound_message_response_spec.rb +59 -0
- data/spec/models/outbound_message_spec.rb +125 -0
- data/spec/models/outbound_messages_spec.rb +47 -0
- data/spec/models/pending_active_points_data_spec.rb +18 -0
- data/spec/models/redeem_loyalty_points_block_spec.rb +0 -6
- data/spec/models/reward_spec.rb +12 -0
- data/spec/models/rollback_increased_achievement_progress_per_item_effect_props_spec.rb +95 -0
- data/spec/models/rollback_tier_boost_effect_props_spec.rb +59 -0
- data/spec/models/rule_eligibility_failure_details_spec.rb +12 -0
- data/spec/models/show_notification_block_spec.rb +0 -6
- data/spec/models/support_balances_spec.rb +53 -0
- data/spec/models/tier_block_reference_spec.rb +59 -0
- data/spec/models/tier_downgrade_data_spec.rb +16 -0
- data/spec/models/tier_spec.rb +16 -0
- data/spec/models/tier_upgrade_data_spec.rb +16 -0
- data/spec/models/tier_will_downgrade_data_spec.rb +16 -0
- data/spec/models/unlock_reward_effect_props_spec.rb +1 -1
- data/spec/models/update_experiment_blueprint_spec.rb +69 -0
- data/spec/models/update_experiment_variant_spec.rb +6 -0
- data/spec/models/update_loyalty_points_expiry_block_program_spec.rb +53 -0
- data/spec/models/update_loyalty_points_expiry_block_spec.rb +97 -0
- data/spec/models/update_reward_spec.rb +12 -0
- data/spec/models/webhook_block_reference_spec.rb +47 -0
- metadata +361 -1
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::AwardLoyaltyPointsBlockProgram
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The ID of the loyalty program. |
|
|
8
|
+
**name** | **String** | The internal name of the loyalty program. | [optional] [readonly]
|
|
9
|
+
**title** | **String** | The display name of the loyalty program. | [optional] [readonly]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::AwardLoyaltyPointsBlockProgram.new(id: 10,
|
|
17
|
+
name: MainProgram,
|
|
18
|
+
title: Main Loyalty Program)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::AwardLoyaltyPointsBundleTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | A target discriminator of type `bundle`. |
|
|
8
|
+
**name** | **String** | Name of the bundle the points target. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::AwardLoyaltyPointsBundleTarget.new(type: null,
|
|
16
|
+
name: BogoBundle)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::AwardLoyaltyPointsCartTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | A target discriminator of type `cart`. |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::AwardLoyaltyPointsCartTarget.new(type: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::AwardLoyaltyPointsGlobalFilterTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | A target discriminator of type `globalFilter`. |
|
|
8
|
+
**name** | **String** | The name of the Application-level cart item filter the points target. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::AwardLoyaltyPointsGlobalFilterTarget.new(type: null,
|
|
16
|
+
name: PremiumItems)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::AwardLoyaltyPointsSelectorTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | A target discriminator of type `selector`. |
|
|
8
|
+
**name** | **String** | The name of the selector binding the points target. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::AwardLoyaltyPointsSelectorTarget.new(type: null,
|
|
16
|
+
name: ElectronicsItems)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/BestPriorPrice.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**id** | **Integer** | The ID of the historical price. |
|
|
8
8
|
**sku** | **String** | sku |
|
|
9
9
|
**observed_at** | **DateTime** | The date and time when the price was observed. |
|
|
10
|
-
**context_ids** | **Array<String>** | The identifiers of the relevant context at the time the price was observed. Includes the context IDs of any price adjustments and of the campaigns that influenced the final price. |
|
|
10
|
+
**context_ids** | **Array<String>** | The identifiers of the relevant context (the sales events, e.g. \"Spring Sale\", \"Summer Sale\") at the time the price was observed. Includes the context IDs of any price adjustments and of the campaigns that influenced the final price. |
|
|
11
11
|
**price** | **Float** | Price of the item. |
|
|
12
12
|
**metadata** | [**BestPriorPriceMetadata**](BestPriorPriceMetadata.md) | |
|
|
13
13
|
**target** | [**Object**](.md) | |
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**skus** | **Array<String>** | List of product SKUs to check when determining the best prior price. |
|
|
8
8
|
**timeframe_end_date** | **DateTime** | The end date and time that defines the latest time for retrieving historical SKU prices. |
|
|
9
9
|
**timeframe** | **String** | The number of days prior to the timeframeEndDate. Only prices within this look back period are considered for the best prior price evaluation. |
|
|
10
|
-
**timeframe_end_date_type** | **String** | Sets the timeframe for retrieving historical pricing data. Can be one of the following values: - `strict`: The timeframe ends at the `timeframeEndDate` value. - `price`: The timeframe ends at the start of current price value and takes the prices prior to the start of the current price value into account. - `sale`: The timeframe ends at the start of current `contextId`
|
|
10
|
+
**timeframe_end_date_type** | **String** | Sets the timeframe for retrieving historical pricing data. Can be one of the following values: - `strict`: The timeframe ends at the `timeframeEndDate` value. - `price`: The timeframe ends at the start of current price value and takes the prices prior to the start of the current price value into account. - `sale`: The timeframe ends at the start of the current sales event, as defined by the `contextId`. It takes the prices prior to the current sale event into account. |
|
|
11
11
|
**target** | [**BestPriorTarget**](BestPriorTarget.md) | | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# TalonOne::BoostLoyaltyTierEffectProps
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**program_id** | **Integer** | The ID of the loyalty program. |
|
|
8
|
+
**sub_ledger_id** | **String** | The ID of the subledger within the loyalty program. |
|
|
9
|
+
**tier_name** | **String** | The name of the tier to which the customer is temporarily boosted. |
|
|
10
|
+
**reason** | **String** | A reason for the tier boost. | [optional]
|
|
11
|
+
**expiry_date** | **DateTime** | The date when the tier boost expires. |
|
|
12
|
+
**boost_uuid** | **String** | The unique identifier of the tier boost. Used to match the boost to its rollback effect when a session is cancelled. |
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'TalonOne'
|
|
18
|
+
|
|
19
|
+
instance = TalonOne::BoostLoyaltyTierEffectProps.new(program_id: null,
|
|
20
|
+
sub_ledger_id: null,
|
|
21
|
+
tier_name: null,
|
|
22
|
+
reason: null,
|
|
23
|
+
expiry_date: null,
|
|
24
|
+
boost_uuid: 27b16dbb-fbc7-4c02-99b1-b21b8a94c186)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
data/docs/Bundle.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **String** | An identifier derived from the bundle content. |
|
|
7
|
+
**id** | **String** | An identifier derived from the bundle content. | [optional] [readonly]
|
|
8
8
|
**name** | **String** | The name of the bundle. |
|
|
9
9
|
**type** | **String** | A binding of type `bundle`. |
|
|
10
10
|
**sources** | **Array<String>** | The selector sources of bundle items. Each source is expressed as a `{{$selectorName}}` reference. |
|
data/docs/Campaign.md
CHANGED
|
@@ -53,7 +53,7 @@ Name | Type | Description | Notes
|
|
|
53
53
|
**revision_frontend_state** | **String** | The campaign revision state displayed in the Campaign Manager. | [optional]
|
|
54
54
|
**active_revision_id** | **Integer** | ID of the revision that was last activated on this campaign. | [optional]
|
|
55
55
|
**active_revision_version_id** | **Integer** | ID of the revision version that is active on the campaign. | [optional]
|
|
56
|
-
**version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign
|
|
56
|
+
**version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign. Starts from `0` for a new campaign. | [optional]
|
|
57
57
|
**current_revision_id** | **Integer** | ID of the revision currently being modified for the campaign. | [optional]
|
|
58
58
|
**current_revision_version_id** | **Integer** | ID of the latest version applied on the current revision. | [optional]
|
|
59
59
|
**stage_revision** | **Boolean** | Flag for determining whether we use current revision when sending requests with staging API key. | [optional] [default to false]
|
|
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::CampaignEligibilityDetails.new(passed:
|
|
17
|
-
coupon_code:
|
|
16
|
+
instance = TalonOne::CampaignEligibilityDetails.new(passed: false,
|
|
17
|
+
coupon_code: XMAS-20-2021,
|
|
18
18
|
details: null)
|
|
19
19
|
```
|
|
20
20
|
|
|
@@ -6,14 +6,14 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**notification_type** | **String** | The type of the notification |
|
|
8
8
|
**total_result_size** | **Integer** | The total size of the result set. |
|
|
9
|
-
**data** | [**Array<ApplicationNotification>**](ApplicationNotification.md) | The array of changes. |
|
|
9
|
+
**data** | [**Array<ApplicationNotification>**](ApplicationNotification.md) | The array of changes. |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::CampaignEvaluationTreeChangedMessage.new(notification_type:
|
|
16
|
+
instance = TalonOne::CampaignEvaluationTreeChangedMessage.new(notification_type: CampaignEvaluationTreeChanged,
|
|
17
17
|
total_result_size: null,
|
|
18
18
|
data: null)
|
|
19
19
|
```
|
data/docs/CampaignVersions.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**revision_frontend_state** | **String** | The campaign revision state displayed in the Campaign Manager. | [optional]
|
|
8
8
|
**active_revision_id** | **Integer** | ID of the revision that was last activated on this campaign. | [optional]
|
|
9
9
|
**active_revision_version_id** | **Integer** | ID of the revision version that is active on the campaign. | [optional]
|
|
10
|
-
**version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign
|
|
10
|
+
**version** | **Integer** | Incrementing number representing how many revisions have been activated on this campaign. Starts from `0` for a new campaign. | [optional]
|
|
11
11
|
**current_revision_id** | **Integer** | ID of the revision currently being modified for the campaign. | [optional]
|
|
12
12
|
**current_revision_version_id** | **Integer** | ID of the latest version applied on the current revision. | [optional]
|
|
13
13
|
**stage_revision** | **Boolean** | Flag for determining whether we use current revision when sending requests with staging API key. | [optional] [default to false]
|
|
@@ -20,6 +20,9 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**reason** | **String** | The reason for the points addition or deduction. |
|
|
21
21
|
**start_date** | **DateTime** | The start date for loyalty points. | [optional]
|
|
22
22
|
**transaction_uuid** | **String** | The identifier of the transaction in the loyalty ledger. |
|
|
23
|
+
**created** | **DateTime** | The timestamp when the loyalty transaction occurred. | [optional]
|
|
24
|
+
**awaits_activation** | **Boolean** | Indicates whether the points have an action-based start date. This property is returned only for point transactions with an action-based start date. | [optional]
|
|
25
|
+
**validity_duration** | **String** | The duration for which the points remain active, relative to the activation date. **Note**: This only applies to points for which `AwaitsActivation` is `true` and `ExpiryDate` is not set. | [optional]
|
|
23
26
|
|
|
24
27
|
## Code Sample
|
|
25
28
|
|
|
@@ -41,7 +44,10 @@ instance = TalonOne::CardAddedDeductedPointsNotification.new(card_identifier: 12
|
|
|
41
44
|
operation: null,
|
|
42
45
|
reason: Compensation,
|
|
43
46
|
start_date: 2023-01-24T14:15:22Z,
|
|
44
|
-
transaction_uuid: null
|
|
47
|
+
transaction_uuid: null,
|
|
48
|
+
created: 2023-01-24T14:15:22Z,
|
|
49
|
+
awaits_activation: false,
|
|
50
|
+
validity_duration: 30D)
|
|
45
51
|
```
|
|
46
52
|
|
|
47
53
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::CatalogRuleset
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**rules** | [**Array<CatalogRule>**](CatalogRule.md) | Array of rule templates in this ruleset. Rules only contain title (no description, as description is at the catalog entry level). |
|
|
8
|
+
**bindings** | [**Array<Binding>**](Binding.md) | An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. | [optional]
|
|
9
|
+
**rb_version** | **String** | The version of the rulebuilder used to create this ruleset. | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::CatalogRuleset.new(rules: null,
|
|
17
|
+
bindings: [],
|
|
18
|
+
rb_version: v2)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**type** | **String** | Identifies the block variant and determines which additional properties are present in it. |
|
|
9
9
|
**tags** | **Array<String>** | Semantic labels attached to this block. | [optional] [readonly]
|
|
10
10
|
**operator** | **String** | The comparison operator applied to the achievement. |
|
|
11
|
-
**achievement** | [**
|
|
11
|
+
**achievement** | [**AchievementBlockReference**](AchievementBlockReference.md) | |
|
|
12
12
|
**on_failure** | **Array<Object>** | Promotion blocks evaluated when this block fails or returns false. | [optional]
|
|
13
13
|
|
|
14
14
|
## Code Sample
|
data/docs/CheckAudienceBlock.md
CHANGED
|
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**type** | **String** | Identifies the block variant and determines which additional properties are present in it. |
|
|
9
9
|
**tags** | **Array<String>** | Semantic labels attached to this block. | [optional] [readonly]
|
|
10
10
|
**operator** | **String** | An indicator of how the block compares its elements. |
|
|
11
|
-
**profile** | **String** | The customer profile to check against the audience. `Current` targets the customer in the current session; `Advocate` targets the person who invited their friend via referral program. |
|
|
12
|
-
**audience** | [**
|
|
11
|
+
**profile** | **String** | The customer profile to check against the audience. `Current` targets the customer in the current session; `Advocate` targets the person who invited their friend via referral program. Only applies to the `member` and `not(member)` operators; ignored for `justJoined` and `justLeft`. | [optional]
|
|
12
|
+
**audience** | [**AudienceBlockReference**](AudienceBlockReference.md) | |
|
|
13
13
|
**on_failure** | **Array<Object>** | Promotion blocks evaluated when this block fails or returns false. | [optional]
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
data/docs/CheckCouponBlock.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **String** | Unique identifier for this block. | [optional] [readonly]
|
|
8
|
-
**type** | **String** |
|
|
8
|
+
**type** | **String** | A block discriminator of type `checkCoupon`. |
|
|
9
9
|
**tags** | **Array<String>** | Semantic labels attached to this block. | [optional] [readonly]
|
|
10
10
|
**redeem** | **Boolean** | When `true`, the coupon code is redeemed. |
|
|
11
11
|
**on_failure** | **Array<Object>** | Promotion blocks evaluated when this block fails or returns false. | [optional]
|
|
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
require 'TalonOne'
|
|
17
17
|
|
|
18
18
|
instance = TalonOne::CheckCouponBlock.new(id: a1b2c3d4-e5f6-7890-abcd-ef1234567890,
|
|
19
|
-
type:
|
|
19
|
+
type: checkCoupon,
|
|
20
20
|
tags: null,
|
|
21
21
|
redeem: true,
|
|
22
22
|
on_failure: null)
|
|
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**tags** | **Array<String>** | Semantic labels attached to this block. | [optional] [readonly]
|
|
10
10
|
**operator** | **String** | An indicator of how the block compares the balance to the value. |
|
|
11
11
|
**program** | [**CheckLoyaltyBalanceBlockProgram**](CheckLoyaltyBalanceBlockProgram.md) | |
|
|
12
|
-
**subledger** | **String** | The name of the subledger to check the balance of. Can be empty if this block checks the loyalty program's main ledger balance instead of a subledger. |
|
|
13
|
-
**balance** | **String** | The type of balance to check: - `current` is the sum of currently active points - `pending` is the sum of pending points. - `negative` is the sum of negative points. - `tentativeCurrent` is the tentative points balance within the current open customer session. |
|
|
12
|
+
**subledger** | **String** | The name of the subledger to check the balance of. Can be empty if this block checks the loyalty program's main ledger balance instead of a subledger. A subledger can only be used when the loyalty program has subledgers enabled. |
|
|
13
|
+
**balance** | **String** | The type of balance to check: - `current` is the sum of currently active points - `pending` is the sum of pending points. - `negative` is the sum of negative points. It cannot be used with a subledger. - `tentativeCurrent` is the tentative points balance within the current open customer session. |
|
|
14
14
|
**value** | **Float** | The numeric value to compare the balance against. |
|
|
15
15
|
**on_failure** | **Array<Object>** | Promotion blocks evaluated when this block fails or returns false. | [optional]
|
|
16
16
|
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **Integer** | The ID of the loyalty program. |
|
|
8
|
-
**name** | **String** | The internal name of the loyalty program. |
|
|
9
|
-
**title** | **String** | The display name of the loyalty program. |
|
|
8
|
+
**name** | **String** | The internal name of the loyalty program. | [optional] [readonly]
|
|
9
|
+
**title** | **String** | The display name of the loyalty program. | [optional] [readonly]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
data/docs/CheckReferralBlock.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **String** | Unique identifier for this block. | [optional] [readonly]
|
|
8
|
-
**type** | **String** |
|
|
8
|
+
**type** | **String** | A block discriminator of type `checkReferral`. |
|
|
9
9
|
**tags** | **Array<String>** | Semantic labels attached to this block. | [optional] [readonly]
|
|
10
10
|
**redeem** | **Boolean** | When `true`, the referral code is redeemed. |
|
|
11
11
|
**on_failure** | **Array<Object>** | Promotion blocks evaluated when this block fails or returns false. | [optional]
|
|
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
require 'TalonOne'
|
|
17
17
|
|
|
18
18
|
instance = TalonOne::CheckReferralBlock.new(id: a1b2c3d4-e5f6-7890-abcd-ef1234567890,
|
|
19
|
-
type:
|
|
19
|
+
type: checkReferral,
|
|
20
20
|
tags: null,
|
|
21
21
|
redeem: true,
|
|
22
22
|
on_failure: null)
|
data/docs/CheckTierBlock.md
CHANGED
|
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**type** | **String** | Identifies the block variant and determines which additional properties are present in it. |
|
|
9
9
|
**tags** | **Array<String>** | Semantic labels attached to this block. | [optional] [readonly]
|
|
10
10
|
**operator** | **String** | An indicator of how the block compares its elements. |
|
|
11
|
-
**subledger** | **String** | The name of the subledger to check
|
|
12
|
-
**tier** | [**
|
|
11
|
+
**subledger** | **String** | The name of the subledger to check a customer's tier in. Can be empty if this block checks the loyalty program's main ledger instead of a subledger. A subledger can only be used when the loyalty program that the tier is in has subledgers enabled. To specify the main ledger, provide an empty string (\"\"). |
|
|
12
|
+
**tier** | [**TierBlockReference**](TierBlockReference.md) | |
|
|
13
13
|
**on_failure** | **Array<Object>** | Promotion blocks evaluated when this block fails or returns false. | [optional]
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::CouponReservation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**coupon_id** | **Integer** | The internal ID of the coupon that was reserved. |
|
|
8
|
+
**recipient_integration_id** | **String** | The integration identifier of the customer for whom this coupon was reserved. |
|
|
9
|
+
**created_at** | **DateTime** | Timestamp when the coupon reservation was created. | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::CouponReservation.new(coupon_id: 6,
|
|
17
|
+
recipient_integration_id: URNGV8294NV,
|
|
18
|
+
created_at: 2026-08-10T10:00Z)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# TalonOne::CouponWithReservations
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The internal ID of the coupon. |
|
|
8
|
+
**created** | **DateTime** | The time the coupon was created. |
|
|
9
|
+
**campaign_id** | **Integer** | The ID of the campaign that owns this entity. |
|
|
10
|
+
**value** | **String** | The coupon code. |
|
|
11
|
+
**usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
|
|
12
|
+
**discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
|
|
13
|
+
**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
|
|
14
|
+
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
15
|
+
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional]
|
|
16
|
+
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional]
|
|
17
|
+
**usage_counter** | **Integer** | The number of times the coupon has been successfully redeemed. |
|
|
18
|
+
**discount_counter** | **Float** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional]
|
|
19
|
+
**discount_remainder** | **Float** | The remaining discount this coupon can give. | [optional]
|
|
20
|
+
**reservation_counter** | **Float** | The number of times this coupon has been reserved. | [optional]
|
|
21
|
+
**attributes** | [**Object**](.md) | Custom attributes associated with this coupon. | [optional]
|
|
22
|
+
**referral_id** | **Integer** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional]
|
|
23
|
+
**recipient_integration_id** | **String** | The Integration ID of the customer that is allowed to redeem this coupon. | [optional]
|
|
24
|
+
**import_id** | **Integer** | The ID of the Import which created this coupon. | [optional]
|
|
25
|
+
**reservation** | **Boolean** | Defines the reservation type: - `true`: The coupon can be reserved for multiple customers. - `false`: The coupon can be reserved only for one customer. It is a personal code. | [optional] [default to true]
|
|
26
|
+
**batch_id** | **String** | The id of the batch the coupon belongs to. | [optional]
|
|
27
|
+
**is_reservation_mandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to false]
|
|
28
|
+
**implicitly_reserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional]
|
|
29
|
+
**reservations** | [**Array<CouponReservation>**](CouponReservation.md) | The customer profile and timestamp of each reservation. | [optional]
|
|
30
|
+
|
|
31
|
+
## Code Sample
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
require 'TalonOne'
|
|
35
|
+
|
|
36
|
+
instance = TalonOne::CouponWithReservations.new(id: 6,
|
|
37
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
38
|
+
campaign_id: 211,
|
|
39
|
+
value: XMAS-20-2021,
|
|
40
|
+
usage_limit: 100,
|
|
41
|
+
discount_limit: 30.0,
|
|
42
|
+
reservation_limit: 45,
|
|
43
|
+
start_date: 2020-01-24T14:15:22Z,
|
|
44
|
+
expiry_date: 2023-08-24T14:15:22Z,
|
|
45
|
+
limits: null,
|
|
46
|
+
usage_counter: 10,
|
|
47
|
+
discount_counter: 10.0,
|
|
48
|
+
discount_remainder: 5.0,
|
|
49
|
+
reservation_counter: 1.0,
|
|
50
|
+
attributes: null,
|
|
51
|
+
referral_id: 326632952,
|
|
52
|
+
recipient_integration_id: URNGV8294NV,
|
|
53
|
+
import_id: 4,
|
|
54
|
+
reservation: false,
|
|
55
|
+
batch_id: 32535-43255,
|
|
56
|
+
is_reservation_mandatory: false,
|
|
57
|
+
implicitly_reserved: false,
|
|
58
|
+
reservations: null)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::CustomEffectBlockReference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The unique identifier of the custom effect. |
|
|
8
|
+
**name** | **String** | The name of the custom effect, as used in API requests. | [optional] [readonly]
|
|
9
|
+
**title** | **String** | The display name of the custom effect. | [optional] [readonly]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::CustomEffectBlockReference.new(id: 1,
|
|
17
|
+
name: sendEmail,
|
|
18
|
+
title: Send email)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# TalonOne::CustomerAchievementHistoryEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**status** | **String** | The status of the achievement. |
|
|
8
|
+
**progress** | **Float** | The current progress of the customer in the achievement. |
|
|
9
|
+
**start_date** | **DateTime** | Timestamp at which the customer started the achievement. | [optional]
|
|
10
|
+
**completion_date** | **DateTime** | Timestamp at which point the customer completed the achievement. | [optional]
|
|
11
|
+
**end_date** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. | [optional]
|
|
12
|
+
**progress_tracker_id** | **Integer** | The ID of the customer's progress tracker for this achievement. |
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'TalonOne'
|
|
18
|
+
|
|
19
|
+
instance = TalonOne::CustomerAchievementHistoryEntry.new(status: completed,
|
|
20
|
+
progress: 10.0,
|
|
21
|
+
start_date: null,
|
|
22
|
+
completion_date: null,
|
|
23
|
+
end_date: null,
|
|
24
|
+
progress_tracker_id: 42)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
|
|
9
9
|
**response_content** | **Array<String>** | Extends the response with the chosen data entities. Use this property to get as much data back as needed from one request instead of sending extra requests to other endpoints. | [optional]
|
|
10
10
|
**audiences_changes** | [**ProfileAudiencesChanges**](ProfileAudiencesChanges.md) | | [optional]
|
|
11
|
+
**reward_integration_ids** | **Array<String>** | The integration IDs of the unlocked rewards that can be used in this request. | [optional]
|
|
11
12
|
|
|
12
13
|
## Code Sample
|
|
13
14
|
|
|
@@ -17,7 +18,8 @@ require 'TalonOne'
|
|
|
17
18
|
instance = TalonOne::CustomerProfileIntegrationRequestV2.new(attributes: {"Language":"english","ShippingCountry":"DE"},
|
|
18
19
|
evaluable_campaign_ids: [10, 12],
|
|
19
20
|
response_content: [triggeredCampaigns, customerProfile],
|
|
20
|
-
audiences_changes: null
|
|
21
|
+
audiences_changes: null,
|
|
22
|
+
reward_integration_ids: [5c0b5e6d-3f8a-4c2b-9f1e-2a7d6b4c8e90])
|
|
21
23
|
```
|
|
22
24
|
|
|
23
25
|
|
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**campaign_eligibility** | [**Array<CampaignEligibility>**](CampaignEligibility.md) | | [optional]
|
|
13
13
|
**awarded_giveaways** | [**Array<Giveaway>**](Giveaway.md) | | [optional]
|
|
14
14
|
**rewards** | [**Array<RewardWithUnlocks>**](RewardWithUnlocks.md) | The rewards for the customer profile. | [optional]
|
|
15
|
-
**effects** |
|
|
15
|
+
**effects** | **Array<Object>** | The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
|
|
16
16
|
**created_coupons** | [**Array<Coupon>**](Coupon.md) | |
|
|
17
17
|
**created_referrals** | [**Array<Referral>**](Referral.md) | |
|
|
18
18
|
|
|
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**used_at** | **DateTime** | The date and time when the reward was used. | [optional]
|
|
18
18
|
**used_by_profile_integration_id** | **String** | The integration ID of the customer profile that used the reward. For rewards unlocked with a loyalty card, this can be any customer profile linked to that loyalty card. Only returned when the reward has been used. | [optional]
|
|
19
19
|
**loyalty_program_id** | **Integer** | The ID of the loyalty program that the loyalty card belongs to. Only returned for rewards unlocked with a loyalty card. | [optional]
|
|
20
|
-
**
|
|
20
|
+
**loyalty_card_id** | **String** | The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. | [optional]
|
|
21
21
|
|
|
22
22
|
## Code Sample
|
|
23
23
|
|
|
@@ -37,7 +37,7 @@ instance = TalonOne::CustomerProfileReward.new(id: 6,
|
|
|
37
37
|
used_at: 2026-07-02T10:30Z,
|
|
38
38
|
used_by_profile_integration_id: customer2840,
|
|
39
39
|
loyalty_program_id: 9,
|
|
40
|
-
|
|
40
|
+
loyalty_card_id: summer-loyalty-card-0543)
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# TalonOne::CustomerReservation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The internal ID of the customer profile. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
|
+
**integration_id** | **String** | The integration ID set by your integration layer. |
|
|
10
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
|
|
11
|
+
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
|
12
|
+
**closed_sessions** | **Integer** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). |
|
|
13
|
+
**total_sales** | **Float** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
|
|
14
|
+
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED. Always returns `null`.** A list of loyalty programs joined by the customer. | [optional]
|
|
15
|
+
**audience_memberships** | [**Array<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
|
|
16
|
+
**last_activity** | **DateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field. |
|
|
17
|
+
**sandbox** | **Boolean** | An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
|
|
18
|
+
**reserved_at** | **DateTime** | Timestamp when the coupon reservation was created. | [optional]
|
|
19
|
+
|
|
20
|
+
## Code Sample
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'TalonOne'
|
|
24
|
+
|
|
25
|
+
instance = TalonOne::CustomerReservation.new(id: 6,
|
|
26
|
+
created: 2020-02-07T08:15:22Z,
|
|
27
|
+
integration_id: URNGV8294NV,
|
|
28
|
+
attributes: {"Language":"english","ShippingCountry":"DE"},
|
|
29
|
+
account_id: 31,
|
|
30
|
+
closed_sessions: 3,
|
|
31
|
+
total_sales: 299.99,
|
|
32
|
+
loyalty_memberships: null,
|
|
33
|
+
audience_memberships: null,
|
|
34
|
+
last_activity: 2020-02-08T14:15:20Z,
|
|
35
|
+
sandbox: false,
|
|
36
|
+
reserved_at: 2026-08-10T10:00Z)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
|
data/docs/DigitalPass.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**pass_id** | **String** | The ID of the generated digital pass. |
|
|
8
8
|
**pass_template_id** | **String** | The ID of the digital pass template used to generate the pass. |
|
|
9
|
-
**status** | **String** | The status of the digital pass. |
|
|
9
|
+
**status** | **String** | The status of the digital pass. `created` indicates that the pass was generated and is ready to be added to a wallet. |
|
|
10
10
|
**pass_url** | **String** | The URL you can use to let the customer add the digital pass to their wallet. |
|
|
11
11
|
|
|
12
12
|
## Code Sample
|