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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e9d44f510906953bea75ca74d5c36d5d8815380d35cdd1c3d8b40baae16981d1
|
|
4
|
+
data.tar.gz: a0187999744b1911fce11af0588614f568ec7ba5716608e815a1742f1a5ef3a3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7115ed41a5df82b5c073fd657111afcc69aecd0f72503d73f840aa6c3f43af8cfd9352f762de90d11d620b5bf89d5ee3d797001ad91a847f7efc8d10cc1cbce3
|
|
7
|
+
data.tar.gz: 554b93fbd4722d873957e9ef8fd7ae256160941c76fbc8a84cef625108cb9b4848a9af9343ec830e87b0e06a10426928db8b2d73835b15cad2ace20d7dde42d3
|
data/README.md
CHANGED
|
@@ -14,7 +14,7 @@ This SDK supports all of the operations of Talon.One's Integration API and Manag
|
|
|
14
14
|
Add this to the Gemfile:
|
|
15
15
|
|
|
16
16
|
```shell
|
|
17
|
-
gem 'talon_one', '~>
|
|
17
|
+
gem 'talon_one', '~> 14.0.0'
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
### Build a gem
|
|
@@ -30,10 +30,10 @@ gem build talon_one.gemspec
|
|
|
30
30
|
To install the gem locally:
|
|
31
31
|
|
|
32
32
|
```shell
|
|
33
|
-
gem install ./talon_one-
|
|
33
|
+
gem install ./talon_one-14.0.0.gem
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
For development, run `gem install --dev ./talon_one-
|
|
36
|
+
For development, run `gem install --dev ./talon_one-14.0.0.gem` to install the development dependencies.
|
|
37
37
|
|
|
38
38
|
### RubyGems
|
|
39
39
|
|
|
@@ -193,6 +193,7 @@ Class | Method | HTTP request | Description
|
|
|
193
193
|
*TalonOne::IntegrationApi* | [**get_customer_achievement_history**](docs/IntegrationApi.md#get_customer_achievement_history) | **GET** /v1/customer_profiles/{integrationId}/achievements/{achievementId} | List customer's achievement history
|
|
194
194
|
*TalonOne::IntegrationApi* | [**get_customer_achievements**](docs/IntegrationApi.md#get_customer_achievements) | **GET** /v1/customer_profiles/{integrationId}/achievements | List customer's available achievements
|
|
195
195
|
*TalonOne::IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data
|
|
196
|
+
*TalonOne::IntegrationApi* | [**get_customer_rewards**](docs/IntegrationApi.md#get_customer_rewards) | **GET** /v1/customer_profiles/{integrationId}/rewards | List customer's rewards
|
|
196
197
|
*TalonOne::IntegrationApi* | [**get_customer_session**](docs/IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session
|
|
197
198
|
*TalonOne::IntegrationApi* | [**get_event_v3**](docs/IntegrationApi.md#get_event_v3) | **GET** /v3/events/{integrationId} | Get advanced event
|
|
198
199
|
*TalonOne::IntegrationApi* | [**get_loyalty_balances**](docs/IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty balances
|
|
@@ -229,6 +230,7 @@ Class | Method | HTTP request | Description
|
|
|
229
230
|
*TalonOne::ManagementApi* | [**create_additional_cost**](docs/ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Create additional cost
|
|
230
231
|
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute
|
|
231
232
|
*TalonOne::ManagementApi* | [**create_batch_loyalty_cards**](docs/ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards
|
|
233
|
+
*TalonOne::ManagementApi* | [**create_campaign**](docs/ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create campaign
|
|
232
234
|
*TalonOne::ManagementApi* | [**create_campaign_from_template**](docs/ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template
|
|
233
235
|
*TalonOne::ManagementApi* | [**create_campaign_store_budget**](docs/ManagementApi.md#create_campaign_store_budget) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Create campaign store budget
|
|
234
236
|
*TalonOne::ManagementApi* | [**create_collection**](docs/ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection
|
|
@@ -320,6 +322,7 @@ Class | Method | HTTP request | Description
|
|
|
320
322
|
*TalonOne::ManagementApi* | [**get_collection**](docs/ManagementApi.md#get_collection) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Get campaign-level collection
|
|
321
323
|
*TalonOne::ManagementApi* | [**get_collection_items**](docs/ManagementApi.md#get_collection_items) | **GET** /v1/collections/{collectionId}/items | Get collection items
|
|
322
324
|
*TalonOne::ManagementApi* | [**get_coupons_without_total_count**](docs/ManagementApi.md#get_coupons_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List coupons
|
|
325
|
+
*TalonOne::ManagementApi* | [**get_current_revision**](docs/ManagementApi.md#get_current_revision) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/revisions/current | Get current revision version
|
|
323
326
|
*TalonOne::ManagementApi* | [**get_customer_activity_report**](docs/ManagementApi.md#get_customer_activity_report) | **GET** /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get customer's activity report
|
|
324
327
|
*TalonOne::ManagementApi* | [**get_customer_activity_reports_without_total_count**](docs/ManagementApi.md#get_customer_activity_reports_without_total_count) | **GET** /v1/applications/{applicationId}/customer_activity_reports/no_total | Get Activity Reports for Application Customers
|
|
325
328
|
*TalonOne::ManagementApi* | [**get_customer_analytics**](docs/ManagementApi.md#get_customer_analytics) | **GET** /v1/applications/{applicationId}/customers/{customerId}/analytics | Get customer's analytics report
|
|
@@ -331,6 +334,7 @@ Class | Method | HTTP request | Description
|
|
|
331
334
|
*TalonOne::ManagementApi* | [**get_event_types**](docs/ManagementApi.md#get_event_types) | **GET** /v1/event_types | List event types
|
|
332
335
|
*TalonOne::ManagementApi* | [**get_experiment**](docs/ManagementApi.md#get_experiment) | **GET** /v1/applications/{applicationId}/experiments/{experimentId} | Get experiment in Application
|
|
333
336
|
*TalonOne::ManagementApi* | [**get_exports**](docs/ManagementApi.md#get_exports) | **GET** /v1/exports | Get exports
|
|
337
|
+
*TalonOne::ManagementApi* | [**get_giveaways_pool**](docs/ManagementApi.md#get_giveaways_pool) | **GET** /v1/giveaways/pools/{poolId} | Get giveaway pool
|
|
334
338
|
*TalonOne::ManagementApi* | [**get_loyalty_card**](docs/ManagementApi.md#get_loyalty_card) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card
|
|
335
339
|
*TalonOne::ManagementApi* | [**get_loyalty_card_transaction_logs**](docs/ManagementApi.md#get_loyalty_card_transaction_logs) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions (Management API)
|
|
336
340
|
*TalonOne::ManagementApi* | [**get_loyalty_cards**](docs/ManagementApi.md#get_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards | List loyalty cards
|
|
@@ -376,6 +380,7 @@ Class | Method | HTTP request | Description
|
|
|
376
380
|
*TalonOne::ManagementApi* | [**list_collections**](docs/ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
|
|
377
381
|
*TalonOne::ManagementApi* | [**list_collections_in_application**](docs/ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
|
378
382
|
*TalonOne::ManagementApi* | [**list_experiments**](docs/ManagementApi.md#list_experiments) | **GET** /v1/applications/{applicationId}/experiments | List experiments
|
|
383
|
+
*TalonOne::ManagementApi* | [**list_giveaways_pool**](docs/ManagementApi.md#list_giveaways_pool) | **GET** /v1/giveaways/pools | List giveaway pools
|
|
379
384
|
*TalonOne::ManagementApi* | [**list_stores**](docs/ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
|
|
380
385
|
*TalonOne::ManagementApi* | [**okta_event_handler_challenge**](docs/ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
|
|
381
386
|
*TalonOne::ManagementApi* | [**price_history**](docs/ManagementApi.md#price_history) | **POST** /v1/applications/{applicationId}/price_history | Get summary of price history
|
|
@@ -437,6 +442,7 @@ Class | Method | HTTP request | Description
|
|
|
437
442
|
- [TalonOne::AchievementAdditionalPropertiesV2](docs/AchievementAdditionalPropertiesV2.md)
|
|
438
443
|
- [TalonOne::AchievementBase](docs/AchievementBase.md)
|
|
439
444
|
- [TalonOne::AchievementBaseV2](docs/AchievementBaseV2.md)
|
|
445
|
+
- [TalonOne::AchievementBlockReference](docs/AchievementBlockReference.md)
|
|
440
446
|
- [TalonOne::AchievementProgress](docs/AchievementProgress.md)
|
|
441
447
|
- [TalonOne::AchievementProgressWithDefinition](docs/AchievementProgressWithDefinition.md)
|
|
442
448
|
- [TalonOne::AchievementReference](docs/AchievementReference.md)
|
|
@@ -489,10 +495,12 @@ Class | Method | HTTP request | Description
|
|
|
489
495
|
- [TalonOne::AsyncCouponDeletionJobResponse](docs/AsyncCouponDeletionJobResponse.md)
|
|
490
496
|
- [TalonOne::AsyncCouponsData](docs/AsyncCouponsData.md)
|
|
491
497
|
- [TalonOne::Attribute](docs/Attribute.md)
|
|
498
|
+
- [TalonOne::AttributeBlockReference](docs/AttributeBlockReference.md)
|
|
492
499
|
- [TalonOne::AttributesMandatory](docs/AttributesMandatory.md)
|
|
493
500
|
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
|
|
494
501
|
- [TalonOne::Audience](docs/Audience.md)
|
|
495
502
|
- [TalonOne::AudienceAnalytics](docs/AudienceAnalytics.md)
|
|
503
|
+
- [TalonOne::AudienceBlockReference](docs/AudienceBlockReference.md)
|
|
496
504
|
- [TalonOne::AudienceCustomer](docs/AudienceCustomer.md)
|
|
497
505
|
- [TalonOne::AudienceIntegrationID](docs/AudienceIntegrationID.md)
|
|
498
506
|
- [TalonOne::AudienceMembership](docs/AudienceMembership.md)
|
|
@@ -509,6 +517,13 @@ Class | Method | HTTP request | Description
|
|
|
509
517
|
- [TalonOne::AwardGiveawayBlock](docs/AwardGiveawayBlock.md)
|
|
510
518
|
- [TalonOne::AwardGiveawayEffectProps](docs/AwardGiveawayEffectProps.md)
|
|
511
519
|
- [TalonOne::AwardItemBlock](docs/AwardItemBlock.md)
|
|
520
|
+
- [TalonOne::AwardLoyaltyPointsAllItemsTarget](docs/AwardLoyaltyPointsAllItemsTarget.md)
|
|
521
|
+
- [TalonOne::AwardLoyaltyPointsBlock](docs/AwardLoyaltyPointsBlock.md)
|
|
522
|
+
- [TalonOne::AwardLoyaltyPointsBlockProgram](docs/AwardLoyaltyPointsBlockProgram.md)
|
|
523
|
+
- [TalonOne::AwardLoyaltyPointsBundleTarget](docs/AwardLoyaltyPointsBundleTarget.md)
|
|
524
|
+
- [TalonOne::AwardLoyaltyPointsCartTarget](docs/AwardLoyaltyPointsCartTarget.md)
|
|
525
|
+
- [TalonOne::AwardLoyaltyPointsGlobalFilterTarget](docs/AwardLoyaltyPointsGlobalFilterTarget.md)
|
|
526
|
+
- [TalonOne::AwardLoyaltyPointsSelectorTarget](docs/AwardLoyaltyPointsSelectorTarget.md)
|
|
512
527
|
- [TalonOne::BaseBlock](docs/BaseBlock.md)
|
|
513
528
|
- [TalonOne::BaseCampaign](docs/BaseCampaign.md)
|
|
514
529
|
- [TalonOne::BaseLoyaltyProgram](docs/BaseLoyaltyProgram.md)
|
|
@@ -525,6 +540,7 @@ Class | Method | HTTP request | Description
|
|
|
525
540
|
- [TalonOne::BetweenCheckAttributeBlock](docs/BetweenCheckAttributeBlock.md)
|
|
526
541
|
- [TalonOne::Binding](docs/Binding.md)
|
|
527
542
|
- [TalonOne::Blueprint](docs/Blueprint.md)
|
|
543
|
+
- [TalonOne::BoostLoyaltyTierEffectProps](docs/BoostLoyaltyTierEffectProps.md)
|
|
528
544
|
- [TalonOne::BulkApplicationNotification](docs/BulkApplicationNotification.md)
|
|
529
545
|
- [TalonOne::BulkOperationOnCampaigns](docs/BulkOperationOnCampaigns.md)
|
|
530
546
|
- [TalonOne::Bundle](docs/Bundle.md)
|
|
@@ -601,17 +617,16 @@ Class | Method | HTTP request | Description
|
|
|
601
617
|
- [TalonOne::CatalogActionRemoveMany](docs/CatalogActionRemoveMany.md)
|
|
602
618
|
- [TalonOne::CatalogItem](docs/CatalogItem.md)
|
|
603
619
|
- [TalonOne::CatalogRule](docs/CatalogRule.md)
|
|
620
|
+
- [TalonOne::CatalogRuleset](docs/CatalogRuleset.md)
|
|
604
621
|
- [TalonOne::CatalogSyncRequest](docs/CatalogSyncRequest.md)
|
|
605
622
|
- [TalonOne::CatalogsStrikethroughNotificationPolicy](docs/CatalogsStrikethroughNotificationPolicy.md)
|
|
606
623
|
- [TalonOne::Change](docs/Change.md)
|
|
607
624
|
- [TalonOne::ChangeLoyaltyTierLevelEffectProps](docs/ChangeLoyaltyTierLevelEffectProps.md)
|
|
608
625
|
- [TalonOne::ChangeProfilePassword](docs/ChangeProfilePassword.md)
|
|
609
626
|
- [TalonOne::CheckAchievementBlock](docs/CheckAchievementBlock.md)
|
|
610
|
-
- [TalonOne::CheckAchievementBlockAchievement](docs/CheckAchievementBlockAchievement.md)
|
|
611
627
|
- [TalonOne::CheckAttributeBlock](docs/CheckAttributeBlock.md)
|
|
612
628
|
- [TalonOne::CheckAttributeBlockBase](docs/CheckAttributeBlockBase.md)
|
|
613
629
|
- [TalonOne::CheckAudienceBlock](docs/CheckAudienceBlock.md)
|
|
614
|
-
- [TalonOne::CheckAudienceBlockAudience](docs/CheckAudienceBlockAudience.md)
|
|
615
630
|
- [TalonOne::CheckBudgetBlock](docs/CheckBudgetBlock.md)
|
|
616
631
|
- [TalonOne::CheckCouponBlock](docs/CheckCouponBlock.md)
|
|
617
632
|
- [TalonOne::CheckEventBlock](docs/CheckEventBlock.md)
|
|
@@ -620,7 +635,6 @@ Class | Method | HTTP request | Description
|
|
|
620
635
|
- [TalonOne::CheckLoyaltyCardBlock](docs/CheckLoyaltyCardBlock.md)
|
|
621
636
|
- [TalonOne::CheckReferralBlock](docs/CheckReferralBlock.md)
|
|
622
637
|
- [TalonOne::CheckTierBlock](docs/CheckTierBlock.md)
|
|
623
|
-
- [TalonOne::CheckTierBlockTier](docs/CheckTierBlockTier.md)
|
|
624
638
|
- [TalonOne::CodeGeneratorSettings](docs/CodeGeneratorSettings.md)
|
|
625
639
|
- [TalonOne::Collection](docs/Collection.md)
|
|
626
640
|
- [TalonOne::CollectionItem](docs/CollectionItem.md)
|
|
@@ -637,10 +651,12 @@ Class | Method | HTTP request | Description
|
|
|
637
651
|
- [TalonOne::CouponFailureSummary](docs/CouponFailureSummary.md)
|
|
638
652
|
- [TalonOne::CouponLimitConfigs](docs/CouponLimitConfigs.md)
|
|
639
653
|
- [TalonOne::CouponRejectionReason](docs/CouponRejectionReason.md)
|
|
654
|
+
- [TalonOne::CouponReservation](docs/CouponReservation.md)
|
|
640
655
|
- [TalonOne::CouponReservations](docs/CouponReservations.md)
|
|
641
656
|
- [TalonOne::CouponSearch](docs/CouponSearch.md)
|
|
642
657
|
- [TalonOne::CouponValue](docs/CouponValue.md)
|
|
643
658
|
- [TalonOne::CouponWithApplication](docs/CouponWithApplication.md)
|
|
659
|
+
- [TalonOne::CouponWithReservations](docs/CouponWithReservations.md)
|
|
644
660
|
- [TalonOne::CouponsNotificationData](docs/CouponsNotificationData.md)
|
|
645
661
|
- [TalonOne::CouponsNotificationPolicy](docs/CouponsNotificationPolicy.md)
|
|
646
662
|
- [TalonOne::CreateAchievement](docs/CreateAchievement.md)
|
|
@@ -654,8 +670,10 @@ Class | Method | HTTP request | Description
|
|
|
654
670
|
- [TalonOne::CreateTemplateCampaign](docs/CreateTemplateCampaign.md)
|
|
655
671
|
- [TalonOne::CreateTemplateCampaignResponse](docs/CreateTemplateCampaignResponse.md)
|
|
656
672
|
- [TalonOne::CustomEffect](docs/CustomEffect.md)
|
|
673
|
+
- [TalonOne::CustomEffectBlockReference](docs/CustomEffectBlockReference.md)
|
|
657
674
|
- [TalonOne::CustomEffectProps](docs/CustomEffectProps.md)
|
|
658
675
|
- [TalonOne::CustomerAchievement](docs/CustomerAchievement.md)
|
|
676
|
+
- [TalonOne::CustomerAchievementHistoryEntry](docs/CustomerAchievementHistoryEntry.md)
|
|
659
677
|
- [TalonOne::CustomerActivityReport](docs/CustomerActivityReport.md)
|
|
660
678
|
- [TalonOne::CustomerAnalytics](docs/CustomerAnalytics.md)
|
|
661
679
|
- [TalonOne::CustomerInventory](docs/CustomerInventory.md)
|
|
@@ -668,6 +686,7 @@ Class | Method | HTTP request | Description
|
|
|
668
686
|
- [TalonOne::CustomerProfileReward](docs/CustomerProfileReward.md)
|
|
669
687
|
- [TalonOne::CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
|
|
670
688
|
- [TalonOne::CustomerProfileUpdateV2Response](docs/CustomerProfileUpdateV2Response.md)
|
|
689
|
+
- [TalonOne::CustomerReservation](docs/CustomerReservation.md)
|
|
671
690
|
- [TalonOne::CustomerReward](docs/CustomerReward.md)
|
|
672
691
|
- [TalonOne::CustomerSession](docs/CustomerSession.md)
|
|
673
692
|
- [TalonOne::CustomerSessionV2](docs/CustomerSessionV2.md)
|
|
@@ -678,8 +697,53 @@ Class | Method | HTTP request | Description
|
|
|
678
697
|
- [TalonOne::DeleteUserRequest](docs/DeleteUserRequest.md)
|
|
679
698
|
- [TalonOne::DigitalPass](docs/DigitalPass.md)
|
|
680
699
|
- [TalonOne::DiscardRisksRequest](docs/DiscardRisksRequest.md)
|
|
681
|
-
- [TalonOne::
|
|
700
|
+
- [TalonOne::EffectAcceptCoupon](docs/EffectAcceptCoupon.md)
|
|
701
|
+
- [TalonOne::EffectAcceptReferral](docs/EffectAcceptReferral.md)
|
|
702
|
+
- [TalonOne::EffectAddFreeItem](docs/EffectAddFreeItem.md)
|
|
703
|
+
- [TalonOne::EffectAddLoyaltyPoints](docs/EffectAddLoyaltyPoints.md)
|
|
704
|
+
- [TalonOne::EffectAddNegativeLoyaltyPoints](docs/EffectAddNegativeLoyaltyPoints.md)
|
|
705
|
+
- [TalonOne::EffectAddToAudience](docs/EffectAddToAudience.md)
|
|
706
|
+
- [TalonOne::EffectAwardGiveaway](docs/EffectAwardGiveaway.md)
|
|
707
|
+
- [TalonOne::EffectBoostLoyaltyTier](docs/EffectBoostLoyaltyTier.md)
|
|
708
|
+
- [TalonOne::EffectCallApi](docs/EffectCallApi.md)
|
|
709
|
+
- [TalonOne::EffectChangeLoyaltyTierLevel](docs/EffectChangeLoyaltyTierLevel.md)
|
|
710
|
+
- [TalonOne::EffectCouponCreated](docs/EffectCouponCreated.md)
|
|
711
|
+
- [TalonOne::EffectCustomEffect](docs/EffectCustomEffect.md)
|
|
712
|
+
- [TalonOne::EffectDeductLoyaltyPoints](docs/EffectDeductLoyaltyPoints.md)
|
|
682
713
|
- [TalonOne::EffectEntity](docs/EffectEntity.md)
|
|
714
|
+
- [TalonOne::EffectError](docs/EffectError.md)
|
|
715
|
+
- [TalonOne::EffectExtendLoyaltyPointsExpiryDate](docs/EffectExtendLoyaltyPointsExpiryDate.md)
|
|
716
|
+
- [TalonOne::EffectIncreaseAchievementProgress](docs/EffectIncreaseAchievementProgress.md)
|
|
717
|
+
- [TalonOne::EffectIncreaseAchievementProgressPerItem](docs/EffectIncreaseAchievementProgressPerItem.md)
|
|
718
|
+
- [TalonOne::EffectJoinLoyaltyProgram](docs/EffectJoinLoyaltyProgram.md)
|
|
719
|
+
- [TalonOne::EffectOffsetNegativeLoyaltyPoints](docs/EffectOffsetNegativeLoyaltyPoints.md)
|
|
720
|
+
- [TalonOne::EffectRedeemReferral](docs/EffectRedeemReferral.md)
|
|
721
|
+
- [TalonOne::EffectReferralCreated](docs/EffectReferralCreated.md)
|
|
722
|
+
- [TalonOne::EffectRejectCoupon](docs/EffectRejectCoupon.md)
|
|
723
|
+
- [TalonOne::EffectRejectReferral](docs/EffectRejectReferral.md)
|
|
724
|
+
- [TalonOne::EffectRemoveFromAudience](docs/EffectRemoveFromAudience.md)
|
|
725
|
+
- [TalonOne::EffectReserveCoupon](docs/EffectReserveCoupon.md)
|
|
726
|
+
- [TalonOne::EffectRollbackAddedLoyaltyPoints](docs/EffectRollbackAddedLoyaltyPoints.md)
|
|
727
|
+
- [TalonOne::EffectRollbackCoupon](docs/EffectRollbackCoupon.md)
|
|
728
|
+
- [TalonOne::EffectRollbackDeductedLoyaltyPoints](docs/EffectRollbackDeductedLoyaltyPoints.md)
|
|
729
|
+
- [TalonOne::EffectRollbackDiscount](docs/EffectRollbackDiscount.md)
|
|
730
|
+
- [TalonOne::EffectRollbackIncreasedAchievementProgress](docs/EffectRollbackIncreasedAchievementProgress.md)
|
|
731
|
+
- [TalonOne::EffectRollbackIncreasedAchievementProgressPerItem](docs/EffectRollbackIncreasedAchievementProgressPerItem.md)
|
|
732
|
+
- [TalonOne::EffectRollbackReferral](docs/EffectRollbackReferral.md)
|
|
733
|
+
- [TalonOne::EffectRollbackTierBoost](docs/EffectRollbackTierBoost.md)
|
|
734
|
+
- [TalonOne::EffectRollbackUseReward](docs/EffectRollbackUseReward.md)
|
|
735
|
+
- [TalonOne::EffectSet](docs/EffectSet.md)
|
|
736
|
+
- [TalonOne::EffectSetDiscount](docs/EffectSetDiscount.md)
|
|
737
|
+
- [TalonOne::EffectSetDiscountPerAdditionalCost](docs/EffectSetDiscountPerAdditionalCost.md)
|
|
738
|
+
- [TalonOne::EffectSetDiscountPerAdditionalCostPerItem](docs/EffectSetDiscountPerAdditionalCostPerItem.md)
|
|
739
|
+
- [TalonOne::EffectSetDiscountPerItem](docs/EffectSetDiscountPerItem.md)
|
|
740
|
+
- [TalonOne::EffectSetLoyaltyPointsExpiryDate](docs/EffectSetLoyaltyPointsExpiryDate.md)
|
|
741
|
+
- [TalonOne::EffectShowBundleMetadata](docs/EffectShowBundleMetadata.md)
|
|
742
|
+
- [TalonOne::EffectShowNotification](docs/EffectShowNotification.md)
|
|
743
|
+
- [TalonOne::EffectStartAchievementProgress](docs/EffectStartAchievementProgress.md)
|
|
744
|
+
- [TalonOne::EffectUnlockReward](docs/EffectUnlockReward.md)
|
|
745
|
+
- [TalonOne::EffectUseReward](docs/EffectUseReward.md)
|
|
746
|
+
- [TalonOne::EffectWillAwardGiveaway](docs/EffectWillAwardGiveaway.md)
|
|
683
747
|
- [TalonOne::EmailEntity](docs/EmailEntity.md)
|
|
684
748
|
- [TalonOne::EmbeddedAnalyticsConfiguration](docs/EmbeddedAnalyticsConfiguration.md)
|
|
685
749
|
- [TalonOne::EmbeddedAnalyticsConfigurationDashboards](docs/EmbeddedAnalyticsConfigurationDashboards.md)
|
|
@@ -704,6 +768,8 @@ Class | Method | HTTP request | Description
|
|
|
704
768
|
- [TalonOne::EventV3RequestEntity](docs/EventV3RequestEntity.md)
|
|
705
769
|
- [TalonOne::ExcludePriceObservationsRequest](docs/ExcludePriceObservationsRequest.md)
|
|
706
770
|
- [TalonOne::Experiment](docs/Experiment.md)
|
|
771
|
+
- [TalonOne::ExperimentBlueprint](docs/ExperimentBlueprint.md)
|
|
772
|
+
- [TalonOne::ExperimentBlueprintVariant](docs/ExperimentBlueprintVariant.md)
|
|
707
773
|
- [TalonOne::ExperimentCampaignCopy](docs/ExperimentCampaignCopy.md)
|
|
708
774
|
- [TalonOne::ExperimentConfidenceTimeline](docs/ExperimentConfidenceTimeline.md)
|
|
709
775
|
- [TalonOne::ExperimentConfidenceTimelineDataPoint](docs/ExperimentConfidenceTimelineDataPoint.md)
|
|
@@ -760,9 +826,9 @@ Class | Method | HTTP request | Description
|
|
|
760
826
|
- [TalonOne::GeoJSONPolygon](docs/GeoJSONPolygon.md)
|
|
761
827
|
- [TalonOne::GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md)
|
|
762
828
|
- [TalonOne::Giveaway](docs/Giveaway.md)
|
|
829
|
+
- [TalonOne::GiveawayPoolBlockReference](docs/GiveawayPoolBlockReference.md)
|
|
763
830
|
- [TalonOne::GiveawayPoolNotification](docs/GiveawayPoolNotification.md)
|
|
764
831
|
- [TalonOne::GiveawayPoolNotificationData](docs/GiveawayPoolNotificationData.md)
|
|
765
|
-
- [TalonOne::GiveawayPoolReference](docs/GiveawayPoolReference.md)
|
|
766
832
|
- [TalonOne::GiveawaysPool](docs/GiveawaysPool.md)
|
|
767
833
|
- [TalonOne::GroupBlock](docs/GroupBlock.md)
|
|
768
834
|
- [TalonOne::HiddenConditionsEffects](docs/HiddenConditionsEffects.md)
|
|
@@ -771,6 +837,7 @@ Class | Method | HTTP request | Description
|
|
|
771
837
|
- [TalonOne::Import](docs/Import.md)
|
|
772
838
|
- [TalonOne::ImportEntity](docs/ImportEntity.md)
|
|
773
839
|
- [TalonOne::IncreaseAchievementProgressEffectProps](docs/IncreaseAchievementProgressEffectProps.md)
|
|
840
|
+
- [TalonOne::IncreaseAchievementProgressPerItemEffectProps](docs/IncreaseAchievementProgressPerItemEffectProps.md)
|
|
774
841
|
- [TalonOne::InfluencingCampaignDetails](docs/InfluencingCampaignDetails.md)
|
|
775
842
|
- [TalonOne::InlineResponse200](docs/InlineResponse200.md)
|
|
776
843
|
- [TalonOne::InlineResponse2001](docs/InlineResponse2001.md)
|
|
@@ -825,7 +892,10 @@ Class | Method | HTTP request | Description
|
|
|
825
892
|
- [TalonOne::InlineResponse20054](docs/InlineResponse20054.md)
|
|
826
893
|
- [TalonOne::InlineResponse20055](docs/InlineResponse20055.md)
|
|
827
894
|
- [TalonOne::InlineResponse20056](docs/InlineResponse20056.md)
|
|
828
|
-
- [TalonOne::
|
|
895
|
+
- [TalonOne::InlineResponse20057](docs/InlineResponse20057.md)
|
|
896
|
+
- [TalonOne::InlineResponse20058](docs/InlineResponse20058.md)
|
|
897
|
+
- [TalonOne::InlineResponse20059](docs/InlineResponse20059.md)
|
|
898
|
+
- [TalonOne::InlineResponse20059Catalog](docs/InlineResponse20059Catalog.md)
|
|
829
899
|
- [TalonOne::InlineResponse2006](docs/InlineResponse2006.md)
|
|
830
900
|
- [TalonOne::InlineResponse2007](docs/InlineResponse2007.md)
|
|
831
901
|
- [TalonOne::InlineResponse2008](docs/InlineResponse2008.md)
|
|
@@ -868,6 +938,7 @@ Class | Method | HTTP request | Description
|
|
|
868
938
|
- [TalonOne::IntegrationStateV2](docs/IntegrationStateV2.md)
|
|
869
939
|
- [TalonOne::IntegrationStoreEntity](docs/IntegrationStoreEntity.md)
|
|
870
940
|
- [TalonOne::IntegrationUnlockRewardRequest](docs/IntegrationUnlockRewardRequest.md)
|
|
941
|
+
- [TalonOne::IntegrationUnlockRewardResponse](docs/IntegrationUnlockRewardResponse.md)
|
|
871
942
|
- [TalonOne::InventoryCoupon](docs/InventoryCoupon.md)
|
|
872
943
|
- [TalonOne::InventoryReferral](docs/InventoryReferral.md)
|
|
873
944
|
- [TalonOne::ItemAttribute](docs/ItemAttribute.md)
|
|
@@ -878,6 +949,7 @@ Class | Method | HTTP request | Description
|
|
|
878
949
|
- [TalonOne::LedgerInfo](docs/LedgerInfo.md)
|
|
879
950
|
- [TalonOne::LedgerPointsEntryIntegrationAPI](docs/LedgerPointsEntryIntegrationAPI.md)
|
|
880
951
|
- [TalonOne::LedgerTransactionLogEntryIntegrationAPI](docs/LedgerTransactionLogEntryIntegrationAPI.md)
|
|
952
|
+
- [TalonOne::LedgerTransactionLogEntryManagementAPI](docs/LedgerTransactionLogEntryManagementAPI.md)
|
|
881
953
|
- [TalonOne::LibraryAttribute](docs/LibraryAttribute.md)
|
|
882
954
|
- [TalonOne::LimitConfig](docs/LimitConfig.md)
|
|
883
955
|
- [TalonOne::LimitCounter](docs/LimitCounter.md)
|
|
@@ -978,6 +1050,7 @@ Class | Method | HTTP request | Description
|
|
|
978
1050
|
- [TalonOne::NewEventType](docs/NewEventType.md)
|
|
979
1051
|
- [TalonOne::NewEventV3Entity](docs/NewEventV3Entity.md)
|
|
980
1052
|
- [TalonOne::NewExperiment](docs/NewExperiment.md)
|
|
1053
|
+
- [TalonOne::NewExperimentBlueprint](docs/NewExperimentBlueprint.md)
|
|
981
1054
|
- [TalonOne::NewExperimentVariant](docs/NewExperimentVariant.md)
|
|
982
1055
|
- [TalonOne::NewExperimentVariantArray](docs/NewExperimentVariantArray.md)
|
|
983
1056
|
- [TalonOne::NewExternalInvitation](docs/NewExternalInvitation.md)
|
|
@@ -1023,6 +1096,14 @@ Class | Method | HTTP request | Description
|
|
|
1023
1096
|
- [TalonOne::OktaEventPayloadData](docs/OktaEventPayloadData.md)
|
|
1024
1097
|
- [TalonOne::OktaEventTarget](docs/OktaEventTarget.md)
|
|
1025
1098
|
- [TalonOne::OneTimeCode](docs/OneTimeCode.md)
|
|
1099
|
+
- [TalonOne::OutboundLog](docs/OutboundLog.md)
|
|
1100
|
+
- [TalonOne::OutboundLogBase](docs/OutboundLogBase.md)
|
|
1101
|
+
- [TalonOne::OutboundLogRequest](docs/OutboundLogRequest.md)
|
|
1102
|
+
- [TalonOne::OutboundLogResponse](docs/OutboundLogResponse.md)
|
|
1103
|
+
- [TalonOne::OutboundLogs](docs/OutboundLogs.md)
|
|
1104
|
+
- [TalonOne::OutboundMessage](docs/OutboundMessage.md)
|
|
1105
|
+
- [TalonOne::OutboundMessageResponse](docs/OutboundMessageResponse.md)
|
|
1106
|
+
- [TalonOne::OutboundMessages](docs/OutboundMessages.md)
|
|
1026
1107
|
- [TalonOne::OutgoingIntegrationBrazePolicy](docs/OutgoingIntegrationBrazePolicy.md)
|
|
1027
1108
|
- [TalonOne::OutgoingIntegrationCleverTapPolicy](docs/OutgoingIntegrationCleverTapPolicy.md)
|
|
1028
1109
|
- [TalonOne::OutgoingIntegrationConfiguration](docs/OutgoingIntegrationConfiguration.md)
|
|
@@ -1109,7 +1190,9 @@ Class | Method | HTTP request | Description
|
|
|
1109
1190
|
- [TalonOne::RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md)
|
|
1110
1191
|
- [TalonOne::RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
|
|
1111
1192
|
- [TalonOne::RollbackIncreasedAchievementProgressEffectProps](docs/RollbackIncreasedAchievementProgressEffectProps.md)
|
|
1193
|
+
- [TalonOne::RollbackIncreasedAchievementProgressPerItemEffectProps](docs/RollbackIncreasedAchievementProgressPerItemEffectProps.md)
|
|
1112
1194
|
- [TalonOne::RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
|
|
1195
|
+
- [TalonOne::RollbackTierBoostEffectProps](docs/RollbackTierBoostEffectProps.md)
|
|
1113
1196
|
- [TalonOne::RollbackUseRewardEffectProps](docs/RollbackUseRewardEffectProps.md)
|
|
1114
1197
|
- [TalonOne::Rule](docs/Rule.md)
|
|
1115
1198
|
- [TalonOne::RuleEligibility](docs/RuleEligibility.md)
|
|
@@ -1176,6 +1259,7 @@ Class | Method | HTTP request | Description
|
|
|
1176
1259
|
- [TalonOne::StrikethroughSetDiscountPerItemMemberEffectProps](docs/StrikethroughSetDiscountPerItemMemberEffectProps.md)
|
|
1177
1260
|
- [TalonOne::StrikethroughTrigger](docs/StrikethroughTrigger.md)
|
|
1178
1261
|
- [TalonOne::SummaryCampaignStoreBudget](docs/SummaryCampaignStoreBudget.md)
|
|
1262
|
+
- [TalonOne::SupportBalances](docs/SupportBalances.md)
|
|
1179
1263
|
- [TalonOne::SupportCustomerProfile](docs/SupportCustomerProfile.md)
|
|
1180
1264
|
- [TalonOne::SupportRequest](docs/SupportRequest.md)
|
|
1181
1265
|
- [TalonOne::SupportRequestInput](docs/SupportRequestInput.md)
|
|
@@ -1186,6 +1270,7 @@ Class | Method | HTTP request | Description
|
|
|
1186
1270
|
- [TalonOne::TemplateLimitConfig](docs/TemplateLimitConfig.md)
|
|
1187
1271
|
- [TalonOne::TemplateParameter](docs/TemplateParameter.md)
|
|
1188
1272
|
- [TalonOne::Tier](docs/Tier.md)
|
|
1273
|
+
- [TalonOne::TierBlockReference](docs/TierBlockReference.md)
|
|
1189
1274
|
- [TalonOne::TierDowngradeData](docs/TierDowngradeData.md)
|
|
1190
1275
|
- [TalonOne::TierDowngradeNotification](docs/TierDowngradeNotification.md)
|
|
1191
1276
|
- [TalonOne::TierDowngradeNotificationPolicy](docs/TierDowngradeNotificationPolicy.md)
|
|
@@ -1199,10 +1284,8 @@ Class | Method | HTTP request | Description
|
|
|
1199
1284
|
- [TalonOne::TimePoint](docs/TimePoint.md)
|
|
1200
1285
|
- [TalonOne::TransferLoyaltyCard](docs/TransferLoyaltyCard.md)
|
|
1201
1286
|
- [TalonOne::TriggerCustomEffectBlock](docs/TriggerCustomEffectBlock.md)
|
|
1202
|
-
- [TalonOne::TriggerCustomEffectBlockCustomEffect](docs/TriggerCustomEffectBlockCustomEffect.md)
|
|
1203
1287
|
- [TalonOne::TriggerCustomEffectBlockTarget](docs/TriggerCustomEffectBlockTarget.md)
|
|
1204
1288
|
- [TalonOne::TriggerWebhookBlock](docs/TriggerWebhookBlock.md)
|
|
1205
|
-
- [TalonOne::TriggerWebhookBlockWebhook](docs/TriggerWebhookBlockWebhook.md)
|
|
1206
1289
|
- [TalonOne::TriggerWebhookEffectProps](docs/TriggerWebhookEffectProps.md)
|
|
1207
1290
|
- [TalonOne::TwoFAConfig](docs/TwoFAConfig.md)
|
|
1208
1291
|
- [TalonOne::UnaryCheckAttributeBlock](docs/UnaryCheckAttributeBlock.md)
|
|
@@ -1210,18 +1293,15 @@ Class | Method | HTTP request | Description
|
|
|
1210
1293
|
- [TalonOne::UpdateAccount](docs/UpdateAccount.md)
|
|
1211
1294
|
- [TalonOne::UpdateAchievement](docs/UpdateAchievement.md)
|
|
1212
1295
|
- [TalonOne::UpdateAchievementProgressBlock](docs/UpdateAchievementProgressBlock.md)
|
|
1213
|
-
- [TalonOne::UpdateAchievementProgressBlockAchievement](docs/UpdateAchievementProgressBlockAchievement.md)
|
|
1214
1296
|
- [TalonOne::UpdateAchievementV2](docs/UpdateAchievementV2.md)
|
|
1215
1297
|
- [TalonOne::UpdateApplication](docs/UpdateApplication.md)
|
|
1216
1298
|
- [TalonOne::UpdateApplicationAPIKey](docs/UpdateApplicationAPIKey.md)
|
|
1217
1299
|
- [TalonOne::UpdateApplicationCIF](docs/UpdateApplicationCIF.md)
|
|
1218
1300
|
- [TalonOne::UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md)
|
|
1219
1301
|
- [TalonOne::UpdateAttributeValueBlock](docs/UpdateAttributeValueBlock.md)
|
|
1220
|
-
- [TalonOne::UpdateAttributeValueBlockAttribute](docs/UpdateAttributeValueBlockAttribute.md)
|
|
1221
1302
|
- [TalonOne::UpdateAttributeValueBlockTarget](docs/UpdateAttributeValueBlockTarget.md)
|
|
1222
1303
|
- [TalonOne::UpdateAudience](docs/UpdateAudience.md)
|
|
1223
1304
|
- [TalonOne::UpdateAudienceMembershipBlock](docs/UpdateAudienceMembershipBlock.md)
|
|
1224
|
-
- [TalonOne::UpdateAudienceMembershipBlockAudience](docs/UpdateAudienceMembershipBlockAudience.md)
|
|
1225
1305
|
- [TalonOne::UpdateBlueprint](docs/UpdateBlueprint.md)
|
|
1226
1306
|
- [TalonOne::UpdateCampaign](docs/UpdateCampaign.md)
|
|
1227
1307
|
- [TalonOne::UpdateCampaignCollection](docs/UpdateCampaignCollection.md)
|
|
@@ -1234,11 +1314,14 @@ Class | Method | HTTP request | Description
|
|
|
1234
1314
|
- [TalonOne::UpdateCouponBatch](docs/UpdateCouponBatch.md)
|
|
1235
1315
|
- [TalonOne::UpdateCouponsData](docs/UpdateCouponsData.md)
|
|
1236
1316
|
- [TalonOne::UpdateExperiment](docs/UpdateExperiment.md)
|
|
1317
|
+
- [TalonOne::UpdateExperimentBlueprint](docs/UpdateExperimentBlueprint.md)
|
|
1237
1318
|
- [TalonOne::UpdateExperimentVariant](docs/UpdateExperimentVariant.md)
|
|
1238
1319
|
- [TalonOne::UpdateExperimentVariantArray](docs/UpdateExperimentVariantArray.md)
|
|
1239
1320
|
- [TalonOne::UpdateExperimentVariantName](docs/UpdateExperimentVariantName.md)
|
|
1240
1321
|
- [TalonOne::UpdateLoyaltyCard](docs/UpdateLoyaltyCard.md)
|
|
1241
1322
|
- [TalonOne::UpdateLoyaltyCardRequest](docs/UpdateLoyaltyCardRequest.md)
|
|
1323
|
+
- [TalonOne::UpdateLoyaltyPointsExpiryBlock](docs/UpdateLoyaltyPointsExpiryBlock.md)
|
|
1324
|
+
- [TalonOne::UpdateLoyaltyPointsExpiryBlockProgram](docs/UpdateLoyaltyPointsExpiryBlockProgram.md)
|
|
1242
1325
|
- [TalonOne::UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md)
|
|
1243
1326
|
- [TalonOne::UpdateLoyaltyProgramTier](docs/UpdateLoyaltyProgramTier.md)
|
|
1244
1327
|
- [TalonOne::UpdatePicklist](docs/UpdatePicklist.md)
|
|
@@ -1262,6 +1345,7 @@ Class | Method | HTTP request | Description
|
|
|
1262
1345
|
- [TalonOne::WebhookAuthenticationDataBasic](docs/WebhookAuthenticationDataBasic.md)
|
|
1263
1346
|
- [TalonOne::WebhookAuthenticationDataCustom](docs/WebhookAuthenticationDataCustom.md)
|
|
1264
1347
|
- [TalonOne::WebhookAuthenticationWebhookRef](docs/WebhookAuthenticationWebhookRef.md)
|
|
1348
|
+
- [TalonOne::WebhookBlockReference](docs/WebhookBlockReference.md)
|
|
1265
1349
|
- [TalonOne::WebhookWithOutgoingIntegrationDetails](docs/WebhookWithOutgoingIntegrationDetails.md)
|
|
1266
1350
|
- [TalonOne::WillAwardGiveawayEffectProps](docs/WillAwardGiveawayEffectProps.md)
|
|
1267
1351
|
- [TalonOne::WithinCheckAttributeBlock](docs/WithinCheckAttributeBlock.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::AchievementBlockReference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The ID of the achievement. |
|
|
8
|
+
**title** | **String** | The display name for the achievement in the Campaign Manager. | [optional] [readonly]
|
|
9
|
+
**name** | **String** | The internal name of the achievement used in API requests. | [optional] [readonly]
|
|
10
|
+
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] [readonly]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::AchievementBlockReference.new(id: 42,
|
|
18
|
+
title: 50% off on 50th purchase.,
|
|
19
|
+
name: Order50Discount,
|
|
20
|
+
target: 50.0)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -10,6 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**start_date** | **DateTime** | The start date for loyalty points. | [optional]
|
|
11
11
|
**expiry_date** | **DateTime** | The expiration date for loyalty points. | [optional]
|
|
12
12
|
**transaction_uuid** | **String** | The identifier of the transaction in the loyalty ledger. |
|
|
13
|
+
**created** | **DateTime** | The timestamp when the loyalty transaction occurred. | [optional]
|
|
14
|
+
**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]
|
|
15
|
+
**validity_duration** | **String** | The duration for which the points remain active, calculated relative to their start date. **Note**: This only applies to points for which `AwaitsActivation` is `true` and `ExpiryDate` is not set. | [optional]
|
|
13
16
|
|
|
14
17
|
## Code Sample
|
|
15
18
|
|
|
@@ -21,7 +24,10 @@ instance = TalonOne::AddedDeductedPointsBalancesAction.new(amount: 10.99,
|
|
|
21
24
|
operation: null,
|
|
22
25
|
start_date: 2023-01-24T14:15:22Z,
|
|
23
26
|
expiry_date: 2024-01-24T14:15:22Z,
|
|
24
|
-
transaction_uuid: null
|
|
27
|
+
transaction_uuid: null,
|
|
28
|
+
created: 2023-01-24T14:15:22Z,
|
|
29
|
+
awaits_activation: false,
|
|
30
|
+
validity_duration: 30D)
|
|
25
31
|
```
|
|
26
32
|
|
|
27
33
|
|
|
@@ -18,6 +18,9 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**reason** | **String** | The reason for the points addition or deduction. |
|
|
19
19
|
**start_date** | **DateTime** | The start date for loyalty points. | [optional]
|
|
20
20
|
**transaction_uuid** | **String** | The identifier of the transaction in the loyalty ledger. |
|
|
21
|
+
**created** | **DateTime** | The timestamp when the loyalty transaction occurred. | [optional]
|
|
22
|
+
**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]
|
|
23
|
+
**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]
|
|
21
24
|
|
|
22
25
|
## Code Sample
|
|
23
26
|
|
|
@@ -37,7 +40,10 @@ instance = TalonOne::AddedDeductedPointsNotification.new(employee_name: Franzisk
|
|
|
37
40
|
operation: null,
|
|
38
41
|
reason: Compensation,
|
|
39
42
|
start_date: 2023-01-24T14:15:22Z,
|
|
40
|
-
transaction_uuid: null
|
|
43
|
+
transaction_uuid: null,
|
|
44
|
+
created: 2023-01-24T14:15:22Z,
|
|
45
|
+
awaits_activation: false,
|
|
46
|
+
validity_duration: 30D)
|
|
41
47
|
```
|
|
42
48
|
|
|
43
49
|
|
data/docs/ApplicationCustomer.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
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
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
18
|
**advocate_integration_id** | **String** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional]
|
|
19
|
+
**loyalty_program_join_dates** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | The dates on which the customer joined the profile-based loyalty programs they are part of. Returned only when the `withLoyaltyMemberships` query parameter is `true`. | [optional]
|
|
19
20
|
|
|
20
21
|
## Code Sample
|
|
21
22
|
|
|
@@ -33,7 +34,8 @@ instance = TalonOne::ApplicationCustomer.new(id: 6,
|
|
|
33
34
|
audience_memberships: null,
|
|
34
35
|
last_activity: 2020-02-08T14:15:20Z,
|
|
35
36
|
sandbox: false,
|
|
36
|
-
advocate_integration_id: null
|
|
37
|
+
advocate_integration_id: null,
|
|
38
|
+
loyalty_program_join_dates: null)
|
|
37
39
|
```
|
|
38
40
|
|
|
39
41
|
|
data/docs/ApplicationEvent.md
CHANGED
|
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**session_id** | **Integer** | The globally unique Talon.One ID of the session that contains this event. | [optional]
|
|
15
15
|
**type** | **String** | The name of the event. Must be a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#custom-events), not a built-in event. |
|
|
16
16
|
**attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. |
|
|
17
|
-
**effects** |
|
|
17
|
+
**effects** | **Array<Object>** | An array containing the effects that were applied as a result of this event. |
|
|
18
18
|
**rule_failure_reasons** | [**Array<RuleFailureReason>**](RuleFailureReason.md) | An array containing the rule failure reasons which happened during this event. | [optional]
|
|
19
19
|
|
|
20
20
|
## Code Sample
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# TalonOne::AttributeBlockReference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The internal ID of the attribute. Reverts to `0` when the attribute is deleted or does not exist. |
|
|
8
|
+
**entity** | **String** | The entity type that owns the attribute. Reverts to an empty string when the attribute is deleted or does not exist. |
|
|
9
|
+
**name** | **String** | The attribute name as used in API requests. |
|
|
10
|
+
**title** | **String** | The human-readable name of the attribute. | [optional] [readonly]
|
|
11
|
+
**type** | **String** | The data type of the attribute. | [optional] [readonly]
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'TalonOne'
|
|
17
|
+
|
|
18
|
+
instance = TalonOne::AttributeBlockReference.new(id: 100,
|
|
19
|
+
entity: profile,
|
|
20
|
+
name: City,
|
|
21
|
+
title: City,
|
|
22
|
+
type: string)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::AudienceBlockReference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The ID of the audience. |
|
|
8
|
+
**name** | **String** | The display name of the audience. | [optional] [readonly]
|
|
9
|
+
**integration** | **String** | The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, `mParticle`, `Segment`, `Shopify`, `Braze`, or `Iterable`. **Note:** If you do not integrate with any of these platforms, do not use this property. | [optional]
|
|
10
|
+
**integration_id** | **String** | The ID of this audience in the third-party integration. **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property. | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::AudienceBlockReference.new(id: 42,
|
|
18
|
+
name: Travel audience,
|
|
19
|
+
integration: mparticle,
|
|
20
|
+
integration_id: 382370BKDB946)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
data/docs/AwardGiveawayBlock.md
CHANGED
|
@@ -7,9 +7,8 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**id** | **String** | Unique identifier for this block. | [optional] [readonly]
|
|
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
|
-
**giveaway_pool** | [**
|
|
10
|
+
**giveaway_pool** | [**GiveawayPoolBlockReference**](GiveawayPoolBlockReference.md) | |
|
|
11
11
|
**profile** | **String** | The customer profile to award the giveaway to. `Current` targets the customer in the current session; `Advocate` targets the person who invited their friend via referral program. |
|
|
12
|
-
**on_failure** | **Array<Object>** | Blocks evaluated when this block fails or returns false. | [optional]
|
|
13
12
|
**on_error** | **Hash<String, Array<Object>>** | Named error handlers evaluated when a specific error occurs. | [optional]
|
|
14
13
|
|
|
15
14
|
## Code Sample
|
|
@@ -22,7 +21,6 @@ instance = TalonOne::AwardGiveawayBlock.new(id: a1b2c3d4-e5f6-7890-abcd-ef123456
|
|
|
22
21
|
tags: null,
|
|
23
22
|
giveaway_pool: null,
|
|
24
23
|
profile: Current,
|
|
25
|
-
on_failure: null,
|
|
26
24
|
on_error: null)
|
|
27
25
|
```
|
|
28
26
|
|
data/docs/AwardItemBlock.md
CHANGED
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**sku** | **String** | The stock keeping unit of the item to award. |
|
|
11
11
|
**name** | **String** | The display name of the item to award. |
|
|
12
12
|
**quantity** | **String** | The number of items to award. Supports template placeholders (e.g. \"{{$Session.Total / 2}}\") for dynamic quantities. |
|
|
13
|
-
**partial** | **Boolean** | When set to `true`, applies a partial item reward if the remaining budget is insufficient to award the full reward. | [optional]
|
|
13
|
+
**partial** | **Boolean** | When set to `true`, applies a partial item reward if the remaining budget is insufficient to award the full reward. When omitted, the Application's partial discounts setting applies. | [optional]
|
|
14
14
|
**on_failure** | **Array<Object>** | Blocks evaluated when this block fails or returns false. | [optional]
|
|
15
15
|
**on_error** | **Hash<String, Array<Object>>** | Named error handlers evaluated when a specific error occurs. | [optional]
|
|
16
16
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::AwardLoyaltyPointsAllItemsTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | A target discriminator of type `allItems`. |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::AwardLoyaltyPointsAllItemsTarget.new(type: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# TalonOne::AwardLoyaltyPointsBlock
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | Unique identifier for this block. | [optional] [readonly]
|
|
8
|
+
**type** | **String** | Identifies the block variant and determines which additional properties are present in it. |
|
|
9
|
+
**tags** | **Array<String>** | Semantic labels attached to this block. | [optional] [readonly]
|
|
10
|
+
**name** | **String** | The human-readable label attached to the awarded points. |
|
|
11
|
+
**program** | [**AwardLoyaltyPointsBlockProgram**](AwardLoyaltyPointsBlockProgram.md) | |
|
|
12
|
+
**recipient** | **String** | The customer profile that receives the points. `Current` targets the customer in the current session; `Advocate` targets the person who invited their friend via referral program. |
|
|
13
|
+
**subledger** | **String** | The name of the subledger to add points to. Can be empty if this block adds points to the loyalty program's main ledger instead of a subledger. |
|
|
14
|
+
**target** | [**Object**](.md) | Identifies the scope over which loyalty points are awarded. The `type` field selects the target variant. |
|
|
15
|
+
**value** | [**Object**](.md) | Number of points to award. Either a numeric scalar or a `{{expression}}` string that resolves to a number at evaluation time. |
|
|
16
|
+
**partial** | **Boolean** | When `true`, applies a partial points reward when the requested value exceeds the configured budget. | [optional]
|
|
17
|
+
**awaits_activation** | **Boolean** | When `true`, the awarded points require manual or delayed activation before becoming active. Mutually exclusive with `startDate`. | [optional]
|
|
18
|
+
**start_date** | [**Object**](.md) | Timestamp at which the awarded points become active. Mutually exclusive with `awaitsActivation`. | [optional]
|
|
19
|
+
**validity_duration** | **String** | Relative duration (e.g. `30D`) after which the awarded points expire. Mutually exclusive with `expiryDate`. | [optional]
|
|
20
|
+
**expiry_date** | [**Object**](.md) | Timestamp at which the awarded points expire. Mutually exclusive with `validityDuration`. | [optional]
|
|
21
|
+
**pending_duration** | **String** | Relative duration (e.g. `3D`) the awarded points remain pending before activation. | [optional]
|
|
22
|
+
|
|
23
|
+
## Code Sample
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'TalonOne'
|
|
27
|
+
|
|
28
|
+
instance = TalonOne::AwardLoyaltyPointsBlock.new(id: a1b2c3d4-e5f6-7890-abcd-ef1234567890,
|
|
29
|
+
type: null,
|
|
30
|
+
tags: null,
|
|
31
|
+
name: Bonus,
|
|
32
|
+
program: null,
|
|
33
|
+
recipient: Current,
|
|
34
|
+
subledger: main,
|
|
35
|
+
target: null,
|
|
36
|
+
value: null,
|
|
37
|
+
partial: false,
|
|
38
|
+
awaits_activation: false,
|
|
39
|
+
start_date: 2026-12-24T14:15:22Z,
|
|
40
|
+
validity_duration: 30D,
|
|
41
|
+
expiry_date: 2026-12-31T00:00:00Z,
|
|
42
|
+
pending_duration: 3D)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
|