talon_one 2.4.0 → 2.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Makefile +43 -0
- data/README.md +198 -160
- data/docs/Account.md +3 -3
- data/docs/AccountAdditionalCost.md +6 -4
- data/docs/AccountAnalytics.md +20 -18
- data/docs/AccountEntity.md +1 -1
- data/docs/AddFreeItemEffectProps.md +1 -1
- data/docs/AddLoyaltyPointsEffectProps.md +17 -9
- data/docs/AdditionalCost.md +1 -1
- data/docs/Application.md +22 -18
- data/docs/ApplicationAPIKey.md +9 -9
- data/docs/ApplicationApiHealth.md +1 -1
- data/docs/ApplicationCustomer.md +10 -8
- data/docs/ApplicationCustomerEntity.md +1 -1
- data/docs/ApplicationEntity.md +1 -1
- data/docs/ApplicationEvent.md +4 -4
- data/docs/ApplicationNotification.md +17 -0
- data/docs/ApplicationReferee.md +1 -1
- data/docs/ApplicationSession.md +13 -11
- data/docs/AsyncCouponCreationResponse.md +17 -0
- data/docs/Attribute.md +10 -4
- data/docs/Audience.md +9 -9
- data/docs/BaseLoyaltyProgram.md +29 -0
- data/docs/Binding.md +6 -4
- data/docs/BulkApplicationNotification.md +19 -0
- data/docs/BulkCampaignNotification.md +19 -0
- data/docs/Campaign.md +26 -18
- data/docs/CampaignCollection.md +37 -0
- data/docs/CampaignCollectionWithoutPayload.md +35 -0
- data/docs/CampaignCopy.md +2 -2
- data/docs/CampaignCreatedNotification.md +17 -0
- data/docs/CampaignDeletedNotification.md +17 -0
- data/docs/CampaignEditedNotification.md +19 -0
- data/docs/CampaignEntity.md +1 -1
- data/docs/CampaignGroup.md +4 -4
- data/docs/CampaignNotification.md +17 -0
- data/docs/CampaignPrioritiesChangedNotification.md +21 -0
- data/docs/CampaignPrioritiesV2.md +21 -0
- data/docs/CampaignRulesetChangedNotification.md +21 -0
- data/docs/CampaignSet.md +3 -3
- data/docs/CampaignSetIDs.md +17 -0
- data/docs/CampaignSetV2.md +25 -0
- data/docs/CampaignStateChangedNotification.md +21 -0
- data/docs/CampaignTemplate.md +59 -0
- data/docs/CampaignTemplateCollection.md +19 -0
- data/docs/CampaignTemplateParams.md +21 -0
- data/docs/CartItem.md +20 -14
- data/docs/Catalog.md +33 -0
- data/docs/Change.md +2 -2
- data/docs/CodeGeneratorSettings.md +4 -4
- data/docs/Collection.md +39 -0
- data/docs/CollectionWithoutPayload.md +37 -0
- data/docs/Coupon.md +17 -15
- data/docs/CouponConstraints.md +3 -3
- data/docs/CouponCreationJob.md +57 -0
- data/docs/CouponLimitConfigs.md +17 -0
- data/docs/CouponRejectionReason.md +3 -3
- data/docs/CouponReservations.md +1 -1
- data/docs/CouponValue.md +2 -2
- data/docs/CreateApplicationAPIKey.md +4 -4
- data/docs/CreateTemplateCampaign.md +29 -0
- data/docs/CreateTemplateCampaignResponse.md +21 -0
- data/docs/CustomEffect.md +6 -6
- data/docs/CustomEffectProps.md +4 -2
- data/docs/CustomerActivityReport.md +2 -2
- data/docs/CustomerInventory.md +2 -2
- data/docs/CustomerProfile.md +11 -9
- data/docs/CustomerProfileAudienceRequestItem.md +6 -6
- data/docs/CustomerProfileIntegrationRequestV2.md +3 -3
- data/docs/CustomerProfileSearchQuery.md +1 -1
- data/docs/CustomerSession.md +10 -8
- data/docs/CustomerSessionV2.md +26 -20
- data/docs/DeductLoyaltyPointsEffectProps.md +5 -1
- data/docs/Effect.md +6 -6
- data/docs/EffectEntity.md +6 -6
- data/docs/EmailEntity.md +1 -1
- data/docs/Entity.md +2 -2
- data/docs/Environment.md +7 -5
- data/docs/ErrorResponseWithStatus.md +21 -0
- data/docs/Event.md +10 -10
- data/docs/EventType.md +4 -18
- data/docs/EventV2.md +21 -0
- data/docs/Export.md +3 -3
- data/docs/Giveaway.md +3 -3
- data/docs/GiveawaysPool.md +3 -3
- data/docs/Import.md +7 -7
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +2 -4
- data/docs/InlineResponse20012.md +3 -3
- data/docs/InlineResponse20013.md +4 -2
- data/docs/InlineResponse20014.md +1 -1
- data/docs/InlineResponse20015.md +2 -2
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +2 -2
- data/docs/InlineResponse20018.md +3 -3
- data/docs/InlineResponse20019.md +3 -5
- data/docs/InlineResponse20020.md +5 -3
- data/docs/InlineResponse20021.md +4 -2
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +1 -1
- data/docs/InlineResponse20027.md +2 -4
- data/docs/InlineResponse20028.md +1 -1
- data/docs/InlineResponse20029.md +4 -2
- data/docs/InlineResponse20030.md +19 -0
- data/docs/InlineResponse20031.md +19 -0
- data/docs/InlineResponse2008.md +5 -3
- data/docs/InlineResponse2009.md +4 -2
- data/docs/IntegrationApi.md +462 -179
- data/docs/IntegrationCustomerSessionResponse.md +17 -0
- data/docs/IntegrationEntity.md +2 -2
- data/docs/IntegrationEvent.md +4 -4
- data/docs/IntegrationEventV2Request.md +23 -0
- data/docs/IntegrationProfileEntity.md +2 -2
- data/docs/IntegrationRequest.md +2 -2
- data/docs/IntegrationStateV2.md +6 -2
- data/docs/InventoryCoupon.md +19 -17
- data/docs/InventoryReferral.md +43 -0
- data/docs/LedgerEntry.md +6 -6
- data/docs/LedgerInfo.md +31 -0
- data/docs/LimitConfig.md +8 -6
- data/docs/LimitCounter.md +45 -0
- data/docs/LoginParams.md +2 -2
- data/docs/Loyalty.md +4 -2
- data/docs/LoyaltyCard.md +35 -0
- data/docs/LoyaltyCardProfileRegistration.md +19 -0
- data/docs/LoyaltyCardRegistration.md +17 -0
- data/docs/LoyaltyDashboardData.md +33 -0
- data/docs/LoyaltyDashboardPointsBreakdown.md +19 -0
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyLedgerEntry.md +3 -1
- data/docs/LoyaltyMembership.md +1 -1
- data/docs/LoyaltyProgram.md +21 -13
- data/docs/LoyaltyProgramBalance.md +10 -10
- data/docs/LoyaltyProgramEntity.md +1 -1
- data/docs/LoyaltyProgramLedgers.md +5 -5
- data/docs/LoyaltyProjection.md +21 -0
- data/docs/LoyaltyProjectionData.md +23 -0
- data/docs/LoyaltyStatistics.md +16 -6
- data/docs/LoyaltySubLedger.md +13 -11
- data/docs/LoyaltyTier.md +5 -5
- data/docs/ManagementApi.md +1627 -1247
- data/docs/ModelReturn.md +37 -0
- data/docs/MultipleAttribute.md +17 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +3 -3
- data/docs/MultipleNewAttribute.md +17 -0
- data/docs/MutableEntity.md +1 -1
- data/docs/NewAccountSignUp.md +2 -2
- data/docs/NewAdditionalCost.md +3 -1
- data/docs/NewApplication.md +18 -14
- data/docs/NewApplicationAPIKey.md +11 -11
- data/docs/NewAttribute.md +4 -0
- data/docs/NewAudience.md +6 -6
- data/docs/NewCampaign.md +14 -14
- data/docs/NewCampaignCollection.md +19 -0
- data/docs/NewCampaignSet.md +1 -1
- data/docs/NewCampaignSetV2.md +21 -0
- data/docs/NewCampaignTemplate.md +41 -0
- data/docs/NewCatalog.md +21 -0
- data/docs/NewCollection.md +21 -0
- data/docs/NewCouponCreationJob.md +29 -0
- data/docs/NewCoupons.md +12 -10
- data/docs/NewCouponsForMultipleRecipients.md +5 -5
- data/docs/NewCustomEffect.md +3 -3
- data/docs/NewCustomerProfile.md +1 -1
- data/docs/NewCustomerSession.md +5 -5
- data/docs/NewCustomerSessionV2.md +17 -15
- data/docs/NewEvent.md +5 -5
- data/docs/NewEventType.md +3 -17
- data/docs/NewInvitation.md +3 -3
- data/docs/NewLoyaltyProgram.md +16 -8
- data/docs/NewLoyaltyTier.md +2 -2
- data/docs/NewNotificationWebhook.md +19 -0
- data/docs/NewReferral.md +7 -7
- data/docs/NewReferralsForMultipleAdvocates.md +10 -10
- data/docs/NewReturn.md +17 -0
- data/docs/NewRole.md +2 -2
- data/docs/NewRuleset.md +4 -4
- data/docs/NewUser.md +3 -3
- data/docs/NotificationWebhook.md +27 -0
- data/docs/Referral.md +13 -13
- data/docs/ReferralConstraints.md +4 -4
- data/docs/ReturnIntegrationRequest.md +19 -0
- data/docs/ReturnedCartItem.md +19 -0
- data/docs/Role.md +5 -5
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +7 -1
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +3 -1
- data/docs/RollbackDiscountEffectProps.md +12 -2
- data/docs/Rule.md +4 -4
- data/docs/RuleFailureReason.md +1 -1
- data/docs/Ruleset.md +10 -8
- data/docs/SamlConnection.md +2 -2
- data/docs/Session.md +3 -3
- data/docs/SetDiscountEffectProps.md +3 -1
- data/docs/SetDiscountPerAdditionalCostEffectProps.md +25 -0
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +29 -0
- data/docs/SetDiscountPerItemEffectProps.md +13 -5
- data/docs/TemplateDef.md +3 -3
- data/docs/TemplateLimitConfig.md +23 -0
- data/docs/Tier.md +19 -0
- data/docs/UpdateApplication.md +19 -15
- data/docs/UpdateAudience.md +2 -2
- data/docs/UpdateCampaign.md +3 -3
- data/docs/UpdateCampaignCollection.md +17 -0
- data/docs/UpdateCampaignTemplate.md +45 -0
- data/docs/UpdateCatalog.md +21 -0
- data/docs/UpdateCollection.md +19 -0
- data/docs/UpdateCoupon.md +5 -3
- data/docs/UpdateCouponBatch.md +4 -4
- data/docs/UpdateCustomEffect.md +3 -3
- data/docs/UpdateLoyaltyCard.md +17 -0
- data/docs/UpdateLoyaltyProgram.md +10 -6
- data/docs/UpdateReferral.md +4 -4
- data/docs/UpdateReferralBatch.md +25 -0
- data/docs/UpdateRole.md +2 -2
- data/docs/User.md +12 -12
- data/docs/Webhook.md +3 -3
- data/lib/talon_one/api/integration_api.rb +561 -165
- data/lib/talon_one/api/management_api.rb +2256 -1674
- data/lib/talon_one/api_client.rb +1 -1
- data/lib/talon_one/api_error.rb +1 -1
- data/lib/talon_one/configuration.rb +1 -8
- data/lib/talon_one/models/accept_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/accept_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/access_log_entry.rb +1 -1
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +93 -5
- data/lib/talon_one/models/account_analytics.rb +21 -6
- data/lib/talon_one/models/account_entity.rb +1 -1
- data/lib/talon_one/models/account_limits.rb +1 -1
- data/lib/talon_one/models/add_free_item_effect_props.rb +1 -1
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +73 -14
- data/lib/talon_one/models/additional_cost.rb +1 -1
- data/lib/talon_one/models/api_error.rb +1 -1
- data/lib/talon_one/models/application.rb +48 -12
- data/lib/talon_one/models/application_api_health.rb +1 -1
- data/lib/talon_one/models/application_api_key.rb +4 -4
- data/lib/talon_one/models/application_campaign_stats.rb +1 -1
- data/lib/talon_one/models/application_customer.rb +53 -9
- data/lib/talon_one/models/application_customer_entity.rb +1 -1
- data/lib/talon_one/models/application_entity.rb +1 -1
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_notification.rb +212 -0
- data/lib/talon_one/models/application_referee.rb +39 -1
- data/lib/talon_one/models/application_session.rb +55 -6
- data/lib/talon_one/models/application_session_entity.rb +1 -1
- data/lib/talon_one/models/async_coupon_creation_response.rb +212 -0
- data/lib/talon_one/models/attribute.rb +80 -5
- data/lib/talon_one/models/attributes_mandatory.rb +1 -1
- data/lib/talon_one/models/attributes_settings.rb +1 -1
- data/lib/talon_one/models/audience.rb +12 -51
- data/lib/talon_one/models/audience_membership.rb +1 -1
- data/lib/talon_one/models/award_giveaway_effect_props.rb +20 -1
- data/lib/talon_one/models/base_loyalty_program.rb +284 -0
- data/lib/talon_one/models/base_saml_connection.rb +1 -1
- data/lib/talon_one/models/binding.rb +16 -6
- data/lib/talon_one/models/{new_feature_flags.rb → bulk_application_notification.rb} +29 -29
- data/lib/talon_one/models/bulk_campaign_notification.rb +227 -0
- data/lib/talon_one/models/campaign.rb +53 -13
- data/lib/talon_one/models/campaign_analytics.rb +1 -1
- data/lib/talon_one/models/campaign_collection.rb +370 -0
- data/lib/talon_one/models/campaign_collection_without_payload.rb +358 -0
- data/lib/talon_one/models/campaign_copy.rb +3 -3
- data/lib/talon_one/models/campaign_created_notification.rb +212 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +212 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +226 -0
- data/lib/talon_one/models/campaign_entity.rb +1 -1
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_group_entity.rb +1 -1
- data/lib/talon_one/models/campaign_notification.rb +212 -0
- data/lib/talon_one/models/campaign_priorities_changed_notification.rb +241 -0
- data/lib/talon_one/models/campaign_priorities_v2.rb +230 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +235 -0
- data/lib/talon_one/models/campaign_search.rb +1 -1
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_set_branch_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_i_ds.rb +208 -0
- data/lib/talon_one/models/campaign_set_leaf_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_v2.rb +291 -0
- data/lib/talon_one/models/campaign_state_changed_notification.rb +242 -0
- data/lib/talon_one/models/campaign_template.rb +533 -0
- data/lib/talon_one/models/{update_loyalty_tier.rb → campaign_template_collection.rb} +30 -34
- data/lib/talon_one/models/campaign_template_params.rb +295 -0
- data/lib/talon_one/models/cart_item.rb +44 -7
- data/lib/talon_one/models/catalog.rb +330 -0
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/change_profile_password.rb +1 -1
- data/lib/talon_one/models/code_generator_settings.rb +3 -3
- data/lib/talon_one/models/collection.rb +382 -0
- data/lib/talon_one/models/collection_without_payload.rb +370 -0
- data/lib/talon_one/models/coupon.rb +35 -6
- data/lib/talon_one/models/coupon_constraints.rb +2 -2
- data/lib/talon_one/models/coupon_created_effect_props.rb +1 -1
- data/lib/talon_one/models/coupon_creation_job.rb +560 -0
- data/lib/talon_one/models/coupon_limit_configs.rb +209 -0
- data/lib/talon_one/models/coupon_rejection_reason.rb +1 -1
- data/lib/talon_one/models/coupon_reservations.rb +1 -1
- data/lib/talon_one/models/coupon_search.rb +1 -1
- data/lib/talon_one/models/coupon_value.rb +2 -2
- data/lib/talon_one/models/create_application_api_key.rb +4 -4
- data/lib/talon_one/models/create_template_campaign.rb +302 -0
- data/lib/talon_one/models/create_template_campaign_response.rb +236 -0
- data/lib/talon_one/models/custom_effect.rb +61 -14
- data/lib/talon_one/models/custom_effect_props.rb +26 -11
- data/lib/talon_one/models/customer_activity_report.rb +20 -1
- data/lib/talon_one/models/customer_analytics.rb +1 -1
- data/lib/talon_one/models/customer_inventory.rb +3 -2
- data/lib/talon_one/models/customer_profile.rb +49 -15
- data/lib/talon_one/models/customer_profile_audience_request.rb +1 -1
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +23 -1
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +2 -2
- data/lib/talon_one/models/customer_profile_search_query.rb +2 -2
- data/lib/talon_one/models/customer_session.rb +44 -10
- data/lib/talon_one/models/customer_session_v2.rb +87 -26
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +30 -5
- data/lib/talon_one/models/effect.rb +1 -1
- data/lib/talon_one/models/effect_entity.rb +1 -1
- data/lib/talon_one/models/email_entity.rb +1 -1
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +1 -1
- data/lib/talon_one/models/environment.rb +21 -8
- data/lib/talon_one/models/error_effect_props.rb +1 -1
- data/lib/talon_one/models/error_response.rb +1 -1
- data/lib/talon_one/models/error_response_with_status.rb +228 -0
- data/lib/talon_one/models/error_source.rb +1 -1
- data/lib/talon_one/models/event.rb +3 -3
- data/lib/talon_one/models/event_type.rb +5 -148
- data/lib/talon_one/models/event_v2.rb +252 -0
- data/lib/talon_one/models/export.rb +3 -3
- data/lib/talon_one/models/feature_flag.rb +1 -1
- data/lib/talon_one/models/features_feed.rb +1 -1
- data/lib/talon_one/models/feed_notification.rb +1 -1
- data/lib/talon_one/models/func_arg_def.rb +1 -1
- data/lib/talon_one/models/function_def.rb +1 -1
- data/lib/talon_one/models/giveaway.rb +2 -2
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/import.rb +3 -3
- data/lib/talon_one/models/import_entity.rb +1 -1
- data/lib/talon_one/models/inline_response200.rb +1 -1
- data/lib/talon_one/models/inline_response2001.rb +1 -1
- data/lib/talon_one/models/inline_response20010.rb +12 -12
- data/lib/talon_one/models/inline_response20011.rb +8 -12
- data/lib/talon_one/models/inline_response20012.rb +12 -12
- data/lib/talon_one/models/inline_response20013.rb +12 -8
- data/lib/talon_one/models/inline_response20014.rb +2 -2
- data/lib/talon_one/models/inline_response20015.rb +7 -2
- data/lib/talon_one/models/inline_response20016.rb +12 -12
- data/lib/talon_one/models/inline_response20017.rb +2 -7
- data/lib/talon_one/models/inline_response20018.rb +12 -12
- data/lib/talon_one/models/inline_response20019.rb +8 -12
- data/lib/talon_one/models/inline_response2002.rb +1 -1
- data/lib/talon_one/models/inline_response20020.rb +12 -8
- data/lib/talon_one/models/inline_response20021.rb +17 -3
- data/lib/talon_one/models/inline_response20022.rb +2 -2
- data/lib/talon_one/models/inline_response20023.rb +2 -2
- data/lib/talon_one/models/inline_response20024.rb +2 -2
- data/lib/talon_one/models/inline_response20025.rb +2 -2
- data/lib/talon_one/models/inline_response20026.rb +2 -2
- data/lib/talon_one/models/inline_response20027.rb +8 -12
- data/lib/talon_one/models/inline_response20028.rb +2 -2
- data/lib/talon_one/models/inline_response20029.rb +12 -8
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- data/lib/talon_one/models/inline_response20030.rb +227 -0
- data/lib/talon_one/models/inline_response20031.rb +227 -0
- data/lib/talon_one/models/inline_response2004.rb +1 -1
- data/lib/talon_one/models/inline_response2005.rb +1 -1
- 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 +12 -8
- data/lib/talon_one/models/inline_response2009.rb +12 -8
- data/lib/talon_one/models/inline_response201.rb +1 -1
- data/lib/talon_one/models/integration_customer_session_response.rb +206 -0
- data/lib/talon_one/models/integration_entity.rb +20 -1
- data/lib/talon_one/models/integration_event.rb +2 -2
- data/lib/talon_one/models/integration_event_v2_request.rb +286 -0
- data/lib/talon_one/models/integration_profile_entity.rb +2 -2
- data/lib/talon_one/models/integration_request.rb +2 -2
- data/lib/talon_one/models/integration_state.rb +1 -1
- data/lib/talon_one/models/integration_state_v2.rb +26 -6
- data/lib/talon_one/models/inventory_coupon.rb +36 -7
- data/lib/talon_one/models/inventory_referral.rb +446 -0
- data/lib/talon_one/models/ledger_entry.rb +2 -2
- data/lib/talon_one/models/ledger_info.rb +301 -0
- data/lib/talon_one/models/library_attribute.rb +1 -1
- data/lib/talon_one/models/limit_config.rb +27 -5
- data/lib/talon_one/models/limit_counter.rb +398 -0
- data/lib/talon_one/models/login_params.rb +1 -1
- data/lib/talon_one/models/loyalty.rb +15 -3
- data/lib/talon_one/models/loyalty_card.rb +350 -0
- data/lib/talon_one/models/loyalty_card_profile_registration.rb +246 -0
- data/lib/talon_one/models/loyalty_card_registration.rb +212 -0
- data/lib/talon_one/models/loyalty_dashboard_data.rb +331 -0
- data/lib/talon_one/models/loyalty_dashboard_points_breakdown.rb +225 -0
- data/lib/talon_one/models/loyalty_ledger.rb +3 -3
- data/lib/talon_one/models/loyalty_ledger_entry.rb +11 -7
- data/lib/talon_one/models/loyalty_membership.rb +1 -1
- data/lib/talon_one/models/loyalty_points.rb +6 -6
- data/lib/talon_one/models/loyalty_program.rb +124 -33
- data/lib/talon_one/models/loyalty_program_balance.rb +6 -6
- data/lib/talon_one/models/loyalty_program_entity.rb +1 -1
- data/lib/talon_one/models/loyalty_program_ledgers.rb +4 -4
- data/lib/talon_one/models/loyalty_projection.rb +239 -0
- data/lib/talon_one/models/loyalty_projection_data.rb +257 -0
- data/lib/talon_one/models/loyalty_statistics.rb +82 -9
- data/lib/talon_one/models/loyalty_sub_ledger.rb +25 -16
- data/lib/talon_one/models/loyalty_tier.rb +6 -6
- data/lib/talon_one/models/manager_config.rb +1 -1
- data/lib/talon_one/models/meta.rb +1 -1
- data/lib/talon_one/models/model_return.rb +384 -0
- data/lib/talon_one/models/multi_application_entity.rb +1 -1
- data/lib/talon_one/models/{application_customer_search.rb → multiple_attribute.rb} +10 -31
- data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +1 -1
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +21 -2
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +1 -1
- data/lib/talon_one/models/multiple_new_attribute.rb +208 -0
- data/lib/talon_one/models/mutable_entity.rb +1 -1
- data/lib/talon_one/models/new_account.rb +1 -1
- data/lib/talon_one/models/new_account_sign_up.rb +1 -1
- data/lib/talon_one/models/new_additional_cost.rb +93 -5
- data/lib/talon_one/models/new_application.rb +48 -12
- data/lib/talon_one/models/new_application_api_key.rb +5 -5
- data/lib/talon_one/models/new_attribute.rb +68 -2
- data/lib/talon_one/models/new_audience.rb +12 -51
- data/lib/talon_one/models/new_campaign.rb +8 -8
- data/lib/talon_one/models/new_campaign_collection.rb +253 -0
- data/lib/talon_one/models/new_campaign_group.rb +1 -1
- data/lib/talon_one/models/new_campaign_set.rb +1 -1
- data/lib/talon_one/models/new_campaign_set_v2.rb +261 -0
- data/lib/talon_one/models/new_campaign_template.rb +408 -0
- data/lib/talon_one/models/{feature_flags.rb → new_catalog.rb} +36 -39
- data/lib/talon_one/models/new_collection.rb +265 -0
- data/lib/talon_one/models/new_coupon_creation_job.rb +353 -0
- data/lib/talon_one/models/new_coupons.rb +33 -6
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +4 -4
- data/lib/talon_one/models/new_custom_effect.rb +62 -14
- data/lib/talon_one/models/new_customer_profile.rb +1 -1
- data/lib/talon_one/models/new_customer_session.rb +6 -6
- data/lib/talon_one/models/new_customer_session_v2.rb +24 -12
- data/lib/talon_one/models/new_event.rb +2 -2
- data/lib/talon_one/models/new_event_type.rb +5 -148
- data/lib/talon_one/models/new_giveaways_pool.rb +1 -1
- data/lib/talon_one/models/new_invitation.rb +2 -2
- data/lib/talon_one/models/new_invite_email.rb +1 -1
- data/lib/talon_one/models/new_loyalty_program.rb +109 -21
- data/lib/talon_one/models/new_loyalty_tier.rb +7 -7
- data/lib/talon_one/models/new_notification_webhook.rb +229 -0
- data/lib/talon_one/models/new_password.rb +1 -1
- data/lib/talon_one/models/new_password_email.rb +1 -1
- data/lib/talon_one/models/new_referral.rb +21 -2
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +4 -4
- data/lib/talon_one/models/new_return.rb +214 -0
- data/lib/talon_one/models/new_role.rb +12 -12
- data/lib/talon_one/models/new_ruleset.rb +3 -3
- data/lib/talon_one/models/new_saml_connection.rb +1 -1
- data/lib/talon_one/models/new_template_def.rb +1 -1
- data/lib/talon_one/models/new_user.rb +1 -1
- data/lib/talon_one/models/new_webhook.rb +22 -1
- data/lib/talon_one/models/notification.rb +1 -1
- data/lib/talon_one/models/notification_webhook.rb +290 -0
- data/lib/talon_one/models/profile_audiences_changes.rb +1 -1
- data/lib/talon_one/models/redeem_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/referral.rb +22 -3
- data/lib/talon_one/models/referral_constraints.rb +2 -2
- data/lib/talon_one/models/referral_created_effect_props.rb +1 -1
- data/lib/talon_one/models/referral_rejection_reason.rb +1 -1
- data/lib/talon_one/models/reject_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/reject_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/return_integration_request.rb +246 -0
- data/lib/talon_one/models/returned_cart_item.rb +222 -0
- data/lib/talon_one/models/role.rb +2 -2
- data/lib/talon_one/models/role_assign.rb +1 -1
- data/lib/talon_one/models/role_membership.rb +1 -1
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +54 -5
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +34 -5
- data/lib/talon_one/models/rollback_discount_effect_props.rb +57 -7
- data/lib/talon_one/models/rollback_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/rule.rb +1 -1
- data/lib/talon_one/models/rule_failure_reason.rb +2 -2
- data/lib/talon_one/models/ruleset.rb +24 -19
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/saml_connection_metadata.rb +1 -1
- data/lib/talon_one/models/saml_login_endpoint.rb +1 -1
- data/lib/talon_one/models/session.rb +2 -2
- data/lib/talon_one/models/set_discount_effect_props.rb +15 -5
- data/lib/talon_one/models/set_discount_per_additional_cost_effect_props.rb +268 -0
- data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +293 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +50 -10
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +1 -1
- data/lib/talon_one/models/show_notification_effect_props.rb +1 -1
- data/lib/talon_one/models/slot_def.rb +1 -1
- data/lib/talon_one/models/template_arg_def.rb +1 -1
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/template_limit_config.rb +308 -0
- data/lib/talon_one/models/tier.rb +227 -0
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +1 -1
- data/lib/talon_one/models/update_account.rb +1 -1
- data/lib/talon_one/models/update_application.rb +51 -15
- data/lib/talon_one/models/update_attribute_effect_props.rb +1 -1
- data/lib/talon_one/models/update_audience.rb +2 -2
- data/lib/talon_one/models/update_campaign.rb +4 -4
- data/lib/talon_one/models/update_campaign_collection.rb +207 -0
- data/lib/talon_one/models/update_campaign_group.rb +1 -1
- data/lib/talon_one/models/update_campaign_template.rb +435 -0
- data/lib/talon_one/models/update_catalog.rb +229 -0
- data/lib/talon_one/models/update_collection.rb +219 -0
- data/lib/talon_one/models/update_coupon.rb +30 -3
- data/lib/talon_one/models/update_coupon_batch.rb +2 -7
- data/lib/talon_one/models/update_custom_effect.rb +61 -14
- data/lib/talon_one/models/update_loyalty_card.rb +212 -0
- data/lib/talon_one/models/update_loyalty_program.rb +43 -6
- data/lib/talon_one/models/update_referral.rb +16 -1
- data/lib/talon_one/models/update_referral_batch.rb +276 -0
- data/lib/talon_one/models/update_role.rb +9 -9
- data/lib/talon_one/models/update_user.rb +1 -1
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +1 -1
- data/lib/talon_one/models/user.rb +1 -1
- data/lib/talon_one/models/user_entity.rb +1 -1
- data/lib/talon_one/models/user_feed_notifications.rb +1 -1
- data/lib/talon_one/models/webhook.rb +22 -1
- data/lib/talon_one/models/webhook_activation_log_entry.rb +1 -1
- data/lib/talon_one/models/webhook_log_entry.rb +1 -1
- data/lib/talon_one/models/will_award_giveaway_effect_props.rb +20 -1
- data/lib/talon_one/version.rb +2 -2
- data/lib/talon_one.rb +68 -5
- data/spec/api/integration_api_spec.rb +129 -54
- data/spec/api/management_api_spec.rb +526 -459
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/accept_coupon_effect_props_spec.rb +1 -1
- data/spec/models/accept_referral_effect_props_spec.rb +1 -1
- data/spec/models/access_log_entry_spec.rb +1 -1
- data/spec/models/account_additional_cost_spec.rb +11 -1
- data/spec/models/account_analytics_spec.rb +7 -1
- data/spec/models/account_entity_spec.rb +1 -1
- data/spec/models/account_limits_spec.rb +1 -1
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/add_free_item_effect_props_spec.rb +1 -1
- data/spec/models/add_loyalty_points_effect_props_spec.rb +25 -1
- data/spec/models/additional_cost_spec.rb +1 -1
- data/spec/models/api_error_spec.rb +1 -1
- data/spec/models/application_api_health_spec.rb +1 -1
- data/spec/models/application_api_key_spec.rb +2 -2
- data/spec/models/application_campaign_stats_spec.rb +1 -1
- data/spec/models/application_customer_entity_spec.rb +1 -1
- data/spec/models/application_customer_spec.rb +7 -1
- data/spec/models/application_entity_spec.rb +1 -1
- data/spec/models/application_event_spec.rb +1 -1
- data/spec/models/application_notification_spec.rb +41 -0
- data/spec/models/application_referee_spec.rb +1 -1
- data/spec/models/application_session_entity_spec.rb +1 -1
- data/spec/models/application_session_spec.rb +8 -2
- data/spec/models/application_spec.rb +17 -1
- data/spec/models/async_coupon_creation_response_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +19 -1
- data/spec/models/attributes_mandatory_spec.rb +1 -1
- data/spec/models/attributes_settings_spec.rb +1 -1
- data/spec/models/audience_membership_spec.rb +1 -1
- data/spec/models/audience_spec.rb +1 -5
- data/spec/models/award_giveaway_effect_props_spec.rb +1 -1
- data/spec/models/base_loyalty_program_spec.rb +77 -0
- data/spec/models/base_saml_connection_spec.rb +1 -1
- data/spec/models/binding_spec.rb +7 -1
- data/spec/models/bulk_application_notification_spec.rb +47 -0
- data/spec/models/bulk_campaign_notification_spec.rb +47 -0
- data/spec/models/campaign_analytics_spec.rb +1 -1
- data/spec/models/campaign_collection_spec.rb +101 -0
- data/spec/models/campaign_collection_without_payload_spec.rb +95 -0
- data/spec/models/campaign_copy_spec.rb +1 -1
- data/spec/models/campaign_created_notification_spec.rb +41 -0
- data/spec/models/campaign_deleted_notification_spec.rb +41 -0
- data/spec/models/campaign_edited_notification_spec.rb +47 -0
- data/spec/models/campaign_entity_spec.rb +1 -1
- data/spec/models/campaign_group_entity_spec.rb +1 -1
- data/spec/models/campaign_group_spec.rb +1 -1
- data/spec/models/campaign_notification_spec.rb +41 -0
- data/spec/models/campaign_priorities_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_priorities_v2_spec.rb +53 -0
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_search_spec.rb +1 -1
- data/spec/models/campaign_set_branch_node_spec.rb +1 -1
- data/spec/models/campaign_set_i_ds_spec.rb +41 -0
- data/spec/models/campaign_set_leaf_node_spec.rb +1 -1
- data/spec/models/campaign_set_node_spec.rb +1 -1
- data/spec/models/campaign_set_spec.rb +1 -1
- data/spec/models/campaign_set_v2_spec.rb +65 -0
- data/spec/models/campaign_spec.rb +25 -1
- data/spec/models/campaign_state_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_template_collection_spec.rb +47 -0
- data/spec/models/campaign_template_params_spec.rb +57 -0
- data/spec/models/campaign_template_spec.rb +175 -0
- data/spec/models/cart_item_spec.rb +19 -1
- data/spec/models/catalog_spec.rb +89 -0
- data/spec/models/change_profile_password_spec.rb +1 -1
- data/spec/models/change_spec.rb +1 -1
- data/spec/models/code_generator_settings_spec.rb +1 -1
- data/spec/models/collection_spec.rb +107 -0
- data/spec/models/collection_without_payload_spec.rb +101 -0
- data/spec/models/coupon_constraints_spec.rb +1 -1
- data/spec/models/coupon_created_effect_props_spec.rb +1 -1
- data/spec/models/coupon_creation_job_spec.rb +161 -0
- data/spec/models/coupon_limit_configs_spec.rb +41 -0
- data/spec/models/coupon_rejection_reason_spec.rb +1 -1
- data/spec/models/coupon_reservations_spec.rb +1 -1
- data/spec/models/coupon_search_spec.rb +1 -1
- data/spec/models/coupon_spec.rb +7 -1
- data/spec/models/coupon_value_spec.rb +1 -1
- data/spec/models/create_application_api_key_spec.rb +2 -2
- data/spec/models/create_template_campaign_response_spec.rb +53 -0
- data/spec/models/create_template_campaign_spec.rb +77 -0
- data/spec/models/custom_effect_props_spec.rb +8 -2
- data/spec/models/custom_effect_spec.rb +7 -7
- data/spec/models/customer_activity_report_spec.rb +1 -1
- data/spec/models/customer_analytics_spec.rb +1 -1
- data/spec/models/customer_inventory_spec.rb +1 -1
- data/spec/models/customer_profile_audience_request_item_spec.rb +1 -1
- data/spec/models/customer_profile_audience_request_spec.rb +1 -1
- data/spec/models/customer_profile_integration_request_v2_spec.rb +1 -1
- data/spec/models/customer_profile_search_query_spec.rb +1 -1
- data/spec/models/customer_profile_spec.rb +8 -2
- data/spec/models/customer_session_spec.rb +8 -2
- data/spec/models/customer_session_v2_spec.rb +21 -3
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +13 -1
- data/spec/models/effect_entity_spec.rb +1 -1
- data/spec/models/effect_spec.rb +1 -1
- data/spec/models/email_entity_spec.rb +1 -1
- data/spec/models/entity_spec.rb +1 -1
- data/spec/models/entity_with_talang_visible_id_spec.rb +1 -1
- data/spec/models/environment_spec.rb +8 -2
- data/spec/models/error_effect_props_spec.rb +1 -1
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/error_response_with_status_spec.rb +53 -0
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/event_spec.rb +1 -1
- data/spec/models/event_type_spec.rb +1 -51
- data/spec/models/event_v2_spec.rb +53 -0
- data/spec/models/export_spec.rb +2 -2
- data/spec/models/feature_flag_spec.rb +1 -1
- data/spec/models/features_feed_spec.rb +1 -1
- data/spec/models/feed_notification_spec.rb +1 -1
- data/spec/models/func_arg_def_spec.rb +1 -1
- data/spec/models/function_def_spec.rb +1 -1
- data/spec/models/giveaway_spec.rb +1 -1
- data/spec/models/giveaways_pool_spec.rb +1 -1
- data/spec/models/import_entity_spec.rb +1 -1
- data/spec/models/import_spec.rb +1 -1
- data/spec/models/inline_response20010_spec.rb +2 -2
- data/spec/models/inline_response20011_spec.rb +1 -7
- data/spec/models/inline_response20012_spec.rb +2 -2
- data/spec/models/inline_response20013_spec.rb +7 -1
- data/spec/models/inline_response20014_spec.rb +1 -1
- data/spec/models/inline_response20015_spec.rb +1 -1
- data/spec/models/inline_response20016_spec.rb +2 -2
- data/spec/models/inline_response20017_spec.rb +1 -1
- data/spec/models/inline_response20018_spec.rb +2 -2
- data/spec/models/inline_response20019_spec.rb +1 -7
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +7 -1
- data/spec/models/inline_response20021_spec.rb +7 -1
- data/spec/models/inline_response20022_spec.rb +1 -1
- data/spec/models/inline_response20023_spec.rb +1 -1
- data/spec/models/inline_response20024_spec.rb +1 -1
- data/spec/models/inline_response20025_spec.rb +1 -1
- data/spec/models/inline_response20026_spec.rb +1 -1
- data/spec/models/inline_response20027_spec.rb +1 -7
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +7 -1
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response20030_spec.rb +47 -0
- data/spec/models/inline_response20031_spec.rb +47 -0
- data/spec/models/inline_response2003_spec.rb +1 -1
- data/spec/models/inline_response2004_spec.rb +1 -1
- data/spec/models/inline_response2005_spec.rb +1 -1
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2007_spec.rb +1 -1
- data/spec/models/inline_response2008_spec.rb +7 -1
- data/spec/models/inline_response2009_spec.rb +7 -1
- data/spec/models/inline_response200_spec.rb +1 -1
- data/spec/models/inline_response201_spec.rb +1 -1
- data/spec/models/integration_customer_session_response_spec.rb +41 -0
- data/spec/models/integration_entity_spec.rb +1 -1
- data/spec/models/integration_event_spec.rb +1 -1
- data/spec/models/integration_event_v2_request_spec.rb +63 -0
- data/spec/models/integration_profile_entity_spec.rb +1 -1
- data/spec/models/integration_request_spec.rb +2 -2
- data/spec/models/integration_state_spec.rb +1 -1
- data/spec/models/integration_state_v2_spec.rb +13 -1
- data/spec/models/inventory_coupon_spec.rb +7 -1
- data/spec/models/inventory_referral_spec.rb +119 -0
- data/spec/models/ledger_entry_spec.rb +1 -1
- data/spec/models/ledger_info_spec.rb +83 -0
- data/spec/models/library_attribute_spec.rb +1 -1
- data/spec/models/limit_config_spec.rb +11 -1
- data/spec/models/limit_counter_spec.rb +125 -0
- data/spec/models/login_params_spec.rb +1 -1
- data/spec/models/loyalty_card_profile_registration_spec.rb +47 -0
- data/spec/models/loyalty_card_registration_spec.rb +41 -0
- data/spec/models/loyalty_card_spec.rb +95 -0
- data/spec/models/loyalty_dashboard_data_spec.rb +89 -0
- data/spec/models/loyalty_dashboard_points_breakdown_spec.rb +47 -0
- data/spec/models/loyalty_ledger_entry_spec.rb +7 -1
- data/spec/models/loyalty_ledger_spec.rb +1 -1
- data/spec/models/loyalty_membership_spec.rb +1 -1
- data/spec/models/loyalty_points_spec.rb +1 -1
- data/spec/models/loyalty_program_balance_spec.rb +1 -1
- data/spec/models/loyalty_program_entity_spec.rb +1 -1
- data/spec/models/loyalty_program_ledgers_spec.rb +1 -1
- data/spec/models/loyalty_program_spec.rb +32 -8
- data/spec/models/loyalty_projection_data_spec.rb +59 -0
- data/spec/models/loyalty_projection_spec.rb +53 -0
- data/spec/models/loyalty_spec.rb +7 -1
- data/spec/models/loyalty_statistics_spec.rb +31 -1
- data/spec/models/loyalty_sub_ledger_spec.rb +7 -1
- data/spec/models/loyalty_tier_spec.rb +1 -1
- data/spec/models/manager_config_spec.rb +1 -1
- data/spec/models/meta_spec.rb +1 -1
- data/spec/models/model_return_spec.rb +101 -0
- data/spec/models/multi_application_entity_spec.rb +1 -1
- data/spec/models/multiple_attribute_spec.rb +41 -0
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +1 -1
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +1 -1
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +1 -1
- data/spec/models/multiple_new_attribute_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +1 -1
- data/spec/models/new_account_sign_up_spec.rb +1 -1
- data/spec/models/new_account_spec.rb +1 -1
- data/spec/models/new_additional_cost_spec.rb +11 -1
- data/spec/models/new_application_api_key_spec.rb +2 -2
- data/spec/models/new_application_spec.rb +17 -1
- data/spec/models/new_attribute_spec.rb +13 -1
- data/spec/models/new_audience_spec.rb +1 -5
- data/spec/models/new_campaign_collection_spec.rb +47 -0
- data/spec/models/new_campaign_group_spec.rb +1 -1
- data/spec/models/new_campaign_set_spec.rb +1 -1
- data/spec/models/new_campaign_set_v2_spec.rb +53 -0
- data/spec/models/new_campaign_spec.rb +1 -1
- data/spec/models/new_campaign_template_spec.rb +121 -0
- data/spec/models/new_catalog_spec.rb +53 -0
- data/spec/models/new_collection_spec.rb +53 -0
- data/spec/models/new_coupon_creation_job_spec.rb +77 -0
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +1 -1
- data/spec/models/new_coupons_spec.rb +7 -1
- data/spec/models/new_custom_effect_spec.rb +7 -7
- data/spec/models/new_customer_profile_spec.rb +1 -1
- data/spec/models/new_customer_session_spec.rb +2 -2
- data/spec/models/new_customer_session_v2_spec.rb +8 -2
- data/spec/models/new_event_spec.rb +1 -1
- data/spec/models/new_event_type_spec.rb +1 -51
- data/spec/models/new_giveaways_pool_spec.rb +1 -1
- data/spec/models/new_invitation_spec.rb +1 -1
- data/spec/models/new_invite_email_spec.rb +1 -1
- data/spec/models/new_loyalty_program_spec.rb +31 -7
- data/spec/models/new_loyalty_tier_spec.rb +1 -1
- data/spec/models/new_notification_webhook_spec.rb +47 -0
- data/spec/models/new_password_email_spec.rb +1 -1
- data/spec/models/new_password_spec.rb +1 -1
- data/spec/models/new_referral_spec.rb +1 -1
- data/spec/models/new_referrals_for_multiple_advocates_spec.rb +1 -1
- data/spec/models/new_return_spec.rb +41 -0
- data/spec/models/new_role_spec.rb +2 -2
- data/spec/models/new_ruleset_spec.rb +1 -1
- data/spec/models/new_saml_connection_spec.rb +1 -1
- data/spec/models/new_template_def_spec.rb +1 -1
- data/spec/models/new_user_spec.rb +1 -1
- data/spec/models/new_webhook_spec.rb +1 -1
- data/spec/models/notification_spec.rb +1 -1
- data/spec/models/notification_webhook_spec.rb +71 -0
- data/spec/models/profile_audiences_changes_spec.rb +1 -1
- data/spec/models/redeem_referral_effect_props_spec.rb +1 -1
- data/spec/models/referral_constraints_spec.rb +1 -1
- data/spec/models/referral_created_effect_props_spec.rb +1 -1
- data/spec/models/referral_rejection_reason_spec.rb +1 -1
- data/spec/models/referral_spec.rb +1 -1
- data/spec/models/reject_coupon_effect_props_spec.rb +1 -1
- data/spec/models/reject_referral_effect_props_spec.rb +1 -1
- data/spec/models/return_integration_request_spec.rb +51 -0
- data/spec/models/returned_cart_item_spec.rb +47 -0
- data/spec/models/role_assign_spec.rb +1 -1
- data/spec/models/role_membership_spec.rb +1 -1
- data/spec/models/role_spec.rb +1 -1
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +19 -1
- data/spec/models/rollback_coupon_effect_props_spec.rb +1 -1
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +7 -1
- data/spec/models/rollback_discount_effect_props_spec.rb +31 -1
- data/spec/models/rollback_referral_effect_props_spec.rb +1 -1
- data/spec/models/rule_failure_reason_spec.rb +1 -1
- data/spec/models/rule_spec.rb +1 -1
- data/spec/models/ruleset_spec.rb +13 -7
- data/spec/models/saml_connection_metadata_spec.rb +1 -1
- data/spec/models/saml_connection_spec.rb +1 -1
- data/spec/models/saml_login_endpoint_spec.rb +1 -1
- data/spec/models/session_spec.rb +1 -1
- data/spec/models/set_discount_effect_props_spec.rb +7 -1
- data/spec/models/set_discount_per_additional_cost_effect_props_spec.rb +65 -0
- data/spec/models/set_discount_per_additional_cost_per_item_effect_props_spec.rb +77 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +25 -1
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +1 -1
- data/spec/models/show_notification_effect_props_spec.rb +1 -1
- data/spec/models/slot_def_spec.rb +1 -1
- data/spec/models/template_arg_def_spec.rb +1 -1
- data/spec/models/template_def_spec.rb +1 -1
- data/spec/models/template_limit_config_spec.rb +67 -0
- data/spec/models/tier_spec.rb +47 -0
- data/spec/models/trigger_webhook_effect_props_spec.rb +1 -1
- data/spec/models/update_account_spec.rb +1 -1
- data/spec/models/update_application_spec.rb +17 -1
- data/spec/models/update_attribute_effect_props_spec.rb +1 -1
- data/spec/models/update_audience_spec.rb +1 -1
- data/spec/models/update_campaign_collection_spec.rb +41 -0
- data/spec/models/update_campaign_group_spec.rb +1 -1
- data/spec/models/update_campaign_spec.rb +1 -1
- data/spec/models/update_campaign_template_spec.rb +133 -0
- data/spec/models/update_catalog_spec.rb +53 -0
- data/spec/models/update_collection_spec.rb +47 -0
- data/spec/models/update_coupon_batch_spec.rb +1 -1
- data/spec/models/update_coupon_spec.rb +7 -1
- data/spec/models/update_custom_effect_spec.rb +7 -7
- data/spec/models/update_loyalty_card_spec.rb +41 -0
- data/spec/models/update_loyalty_program_spec.rb +13 -1
- data/spec/models/update_referral_batch_spec.rb +65 -0
- data/spec/models/update_referral_spec.rb +1 -1
- data/spec/models/update_role_spec.rb +2 -2
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +1 -1
- data/spec/models/update_user_spec.rb +1 -1
- data/spec/models/user_entity_spec.rb +1 -1
- data/spec/models/user_feed_notifications_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/webhook_activation_log_entry_spec.rb +1 -1
- data/spec/models/webhook_log_entry_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/will_award_giveaway_effect_props_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/talon_one.gemspec +1 -1
- metadata +493 -240
- data/docs/ApplicationCustomerSearch.md +0 -21
- data/docs/FeatureFlags.md +0 -23
- data/docs/NewFeatureFlags.md +0 -21
- data/docs/UpdateLoyaltyTier.md +0 -19
- data/spec/models/application_customer_search_spec.rb +0 -53
- data/spec/models/feature_flags_spec.rb +0 -59
- data/spec/models/new_feature_flags_spec.rb +0 -53
- data/spec/models/update_loyalty_tier_spec.rb +0 -47
data/docs/NewCustomerSession.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**profile_id** | **String** | ID of the customers profile as used within this Talon.One account.
|
|
7
|
+
**profile_id** | **String** | ID of the customers profile as used within this Talon.One account. **Note:** If the customer does not yet have a known profileId, we recommend you use a guest profileId. | [optional]
|
|
8
8
|
**coupon** | **String** | Any coupon code entered. | [optional]
|
|
9
9
|
**referral** | **String** | Any referral code entered. | [optional]
|
|
10
|
-
**state** | **String** | Indicates the current state of the session.
|
|
10
|
+
**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Entities](/docs/dev/concepts/entities#customer-session). | [optional] [default to 'open']
|
|
11
11
|
**cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. | [optional]
|
|
12
|
-
**identifiers** | **Array<String>** |
|
|
12
|
+
**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). | [optional]
|
|
13
13
|
**total** | **Float** | The total sum of the cart in one session. | [optional]
|
|
14
14
|
**attributes** | [**Object**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. | [optional]
|
|
15
15
|
|
|
@@ -18,12 +18,12 @@ Name | Type | Description | Notes
|
|
|
18
18
|
```ruby
|
|
19
19
|
require 'TalonOne'
|
|
20
20
|
|
|
21
|
-
instance = TalonOne::NewCustomerSession.new(profile_id:
|
|
21
|
+
instance = TalonOne::NewCustomerSession.new(profile_id: URNGV8294NV,
|
|
22
22
|
coupon: null,
|
|
23
23
|
referral: null,
|
|
24
24
|
state: null,
|
|
25
25
|
cart_items: null,
|
|
26
|
-
identifiers:
|
|
26
|
+
identifiers: [91.11.156.141],
|
|
27
27
|
total: null,
|
|
28
28
|
attributes: null)
|
|
29
29
|
```
|
|
@@ -4,28 +4,30 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**profile_id** | **String** | ID of the customers profile as used within this Talon.One account.
|
|
8
|
-
**coupon_codes** | **Array<String>** | Any coupon codes entered. | [optional]
|
|
9
|
-
**referral_code** | **String** | Any referral code entered. | [optional]
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**
|
|
13
|
-
**
|
|
14
|
-
**
|
|
7
|
+
**profile_id** | **String** | ID of the customers profile as used within this Talon.One account. **Note:** If the customer does not yet have a known profileId, we recommend you use a guest profileId. | [optional]
|
|
8
|
+
**coupon_codes** | **Array<String>** | Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional]
|
|
9
|
+
**referral_code** | **String** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional]
|
|
10
|
+
**loyalty_cards** | **Array<String>** | Any loyalty cards used. | [optional]
|
|
11
|
+
**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`, after which valid transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` For more information, see [Entites](/docs/dev/concepts/entities#customer-session). | [optional] [default to 'open']
|
|
12
|
+
**cart_items** | [**Array<CartItem>**](CartItem.md) | The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | [optional]
|
|
13
|
+
**additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) | Any costs associated with the session that can not be explicitly attributed to cart items. Examples include shipping costs and service fees. [Create them in the Campaign Manager](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs/#creating-additional-costs) before setting them with this property. | [optional]
|
|
14
|
+
**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). **Important**: If you [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains an identifier by the time you close it. | [optional]
|
|
15
|
+
**attributes** | [**Object**](.md) | A key-value map of the sessions attributes. If you use custom attributes, they must be created in the Campaign Manager before you set them with this property. For more information, see [Attributes](https://docs.talon.one/docs/dev/concepts/attributes). | [optional]
|
|
15
16
|
|
|
16
17
|
## Code Sample
|
|
17
18
|
|
|
18
19
|
```ruby
|
|
19
20
|
require 'TalonOne'
|
|
20
21
|
|
|
21
|
-
instance = TalonOne::NewCustomerSessionV2.new(profile_id:
|
|
22
|
-
coupon_codes:
|
|
23
|
-
referral_code:
|
|
24
|
-
|
|
22
|
+
instance = TalonOne::NewCustomerSessionV2.new(profile_id: URNGV8294NV,
|
|
23
|
+
coupon_codes: [XMAS-20-2021],
|
|
24
|
+
referral_code: NT2K54D9,
|
|
25
|
+
loyalty_cards: [loyalty-card-1],
|
|
26
|
+
state: open,
|
|
25
27
|
cart_items: null,
|
|
26
|
-
additional_costs:
|
|
27
|
-
identifiers:
|
|
28
|
-
attributes:
|
|
28
|
+
additional_costs: {"shipping":{"price":9}},
|
|
29
|
+
identifiers: [91.11.156.141],
|
|
30
|
+
attributes: {"ShippingCity":"Berlin"})
|
|
29
31
|
```
|
|
30
32
|
|
|
31
33
|
|
data/docs/NewEvent.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**profile_id** | **String** | ID of the customers profile as used within this Talon.One account.
|
|
7
|
+
**profile_id** | **String** | ID of the customers profile as used within this Talon.One account. **Note:** If the customer does not yet have a known profileId, we recommend you use a guest profileId. | [optional]
|
|
8
8
|
**type** | **String** | A string representing the event. Must not be a reserved event name. |
|
|
9
9
|
**attributes** | [**Object**](.md) | Arbitrary additional JSON data associated with the event. |
|
|
10
10
|
**session_id** | **String** | The ID of the session that this event occurred in. |
|
|
@@ -14,10 +14,10 @@ Name | Type | Description | Notes
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'TalonOne'
|
|
16
16
|
|
|
17
|
-
instance = TalonOne::NewEvent.new(profile_id:
|
|
18
|
-
type:
|
|
19
|
-
attributes:
|
|
20
|
-
session_id:
|
|
17
|
+
instance = TalonOne::NewEvent.new(profile_id: URNGV8294NV,
|
|
18
|
+
type: pageViews,
|
|
19
|
+
attributes: {"myAttribute":"myValue"},
|
|
20
|
+
session_id: 175KJPS947296)
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
data/docs/NewEventType.md
CHANGED
|
@@ -4,32 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. |
|
|
8
7
|
**title** | **String** | The human-friendly display name for this event type. Use a short, past-tense, description of the event. |
|
|
9
8
|
**name** | **String** | The machine-friendly canonical name for this event type. This will be used in URLs, and cannot be changed after an event type has been created. |
|
|
10
|
-
**description** | **String** | An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway. |
|
|
11
|
-
**mime_type** | **String** | This defines how the request payload will be parsed before your handler code is run. |
|
|
12
|
-
**example_payload** | **String** | It is often helpful to include an example payload with the event type definition for documentation purposes. | [optional]
|
|
13
|
-
**schema** | [**Object**](.md) | It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing. | [optional]
|
|
14
|
-
**handler_language** | **String** | The language of the handler code. Currently only `\"talang\"` is supported. | [optional]
|
|
15
|
-
**handler** | **String** | Code that will be run after successful parsing & validation of the payload for this event. This code _may_ choose to evaluate campaign rules. |
|
|
16
|
-
**version** | **Integer** | The version of this event type. When updating an existing event type this must be **exactly** `currentVersion + 1`. |
|
|
9
|
+
**description** | **String** | An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway. | [optional]
|
|
17
10
|
|
|
18
11
|
## Code Sample
|
|
19
12
|
|
|
20
13
|
```ruby
|
|
21
14
|
require 'TalonOne'
|
|
22
15
|
|
|
23
|
-
instance = TalonOne::NewEventType.new(
|
|
24
|
-
title: null,
|
|
16
|
+
instance = TalonOne::NewEventType.new(title: null,
|
|
25
17
|
name: null,
|
|
26
|
-
description: null
|
|
27
|
-
mime_type: null,
|
|
28
|
-
example_payload: null,
|
|
29
|
-
schema: null,
|
|
30
|
-
handler_language: null,
|
|
31
|
-
handler: null,
|
|
32
|
-
version: null)
|
|
18
|
+
description: null)
|
|
33
19
|
```
|
|
34
20
|
|
|
35
21
|
|
data/docs/NewInvitation.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Name of the user being invited. | [optional]
|
|
8
8
|
**email** | **String** | |
|
|
9
|
-
**acl** | **String** |
|
|
9
|
+
**acl** | **String** | The `Access Control List` json defining the role of the user. This represents the actual access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` |
|
|
10
10
|
**roles** | **Array<Integer>** | An array of roleIDs to assign the new user to | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
|
|
|
15
15
|
require 'TalonOne'
|
|
16
16
|
|
|
17
17
|
instance = TalonOne::NewInvitation.new(name: null,
|
|
18
|
-
email:
|
|
19
|
-
acl:
|
|
18
|
+
email: john@example.com,
|
|
19
|
+
acl: {"Role":0},
|
|
20
20
|
roles: null)
|
|
21
21
|
```
|
|
22
22
|
|
data/docs/NewLoyaltyProgram.md
CHANGED
|
@@ -4,26 +4,34 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**name** | **String** | The internal name for the Loyalty Program. This is an immutable value. |
|
|
8
7
|
**title** | **String** | The display title for the Loyalty Program. |
|
|
9
8
|
**description** | **String** | Description of our Loyalty Program. | [optional]
|
|
10
9
|
**subscribed_applications** | **Array<Integer>** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional]
|
|
11
10
|
**default_validity** | **String** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. |
|
|
12
11
|
**default_pending** | **String** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. |
|
|
13
12
|
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program |
|
|
13
|
+
**users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
|
|
14
|
+
**name** | **String** | The internal name for the Loyalty Program. This is an immutable value. |
|
|
15
|
+
**tiers** | [**Array<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program | [optional]
|
|
16
|
+
**timezone** | **String** | A string containing an IANA timezone descriptor. |
|
|
17
|
+
**card_based** | **Boolean** | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. | [default to false]
|
|
14
18
|
|
|
15
19
|
## Code Sample
|
|
16
20
|
|
|
17
21
|
```ruby
|
|
18
22
|
require 'TalonOne'
|
|
19
23
|
|
|
20
|
-
instance = TalonOne::NewLoyaltyProgram.new(
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
24
|
+
instance = TalonOne::NewLoyaltyProgram.new(title: Point collection,
|
|
25
|
+
description: Customers collect 10 points per 1$ spent,
|
|
26
|
+
subscribed_applications: [132, 97],
|
|
27
|
+
default_validity: unlimited,
|
|
28
|
+
default_pending: immediate,
|
|
29
|
+
allow_subledger: false,
|
|
30
|
+
users_per_card_limit: 111,
|
|
31
|
+
name: GeneralPointCollection,
|
|
32
|
+
tiers: null,
|
|
33
|
+
timezone: null,
|
|
34
|
+
card_based: true)
|
|
27
35
|
```
|
|
28
36
|
|
|
29
37
|
|
data/docs/NewLoyaltyTier.md
CHANGED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::NewNotificationWebhook
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**url** | **String** | API url for this notification webhook |
|
|
8
|
+
**headers** | **Array<String>** | List of API HTTP headers for this notification webhook |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::NewNotificationWebhook.new(url: null,
|
|
16
|
+
headers: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/NewReferral.md
CHANGED
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional]
|
|
8
8
|
**expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional]
|
|
9
|
-
**usage_limit** | **Integer** | The number of times a referral code can be used.
|
|
9
|
+
**usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | [optional]
|
|
10
10
|
**campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. |
|
|
11
11
|
**advocate_profile_integration_id** | **String** | The Integration ID of the Advocate's Profile. |
|
|
12
12
|
**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional]
|
|
@@ -17,12 +17,12 @@ Name | Type | Description | Notes
|
|
|
17
17
|
```ruby
|
|
18
18
|
require 'TalonOne'
|
|
19
19
|
|
|
20
|
-
instance = TalonOne::NewReferral.new(start_date:
|
|
21
|
-
expiry_date:
|
|
22
|
-
usage_limit:
|
|
23
|
-
campaign_id:
|
|
24
|
-
advocate_profile_integration_id:
|
|
25
|
-
friend_profile_integration_id:
|
|
20
|
+
instance = TalonOne::NewReferral.new(start_date: 2020-11-10T23:00Z,
|
|
21
|
+
expiry_date: 2021-11-10T23:00Z,
|
|
22
|
+
usage_limit: 1,
|
|
23
|
+
campaign_id: 78,
|
|
24
|
+
advocate_profile_integration_id: URNGV8294NV,
|
|
25
|
+
friend_profile_integration_id: BZGGC2454PA,
|
|
26
26
|
attributes: null)
|
|
27
27
|
```
|
|
28
28
|
|
|
@@ -6,26 +6,26 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional]
|
|
8
8
|
**expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional]
|
|
9
|
-
**usage_limit** | **Integer** | The number of times a referral code can be used.
|
|
9
|
+
**usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. |
|
|
10
10
|
**campaign_id** | **Integer** | The ID of the campaign from which the referral received the referral code. |
|
|
11
11
|
**advocate_profile_integration_ids** | **Array<String>** | An array containing all the respective advocate profiles. |
|
|
12
12
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
13
|
-
**valid_characters** | **Array<String>** |
|
|
14
|
-
**referral_pattern** | **String** | The pattern
|
|
13
|
+
**valid_characters** | **Array<String>** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional]
|
|
14
|
+
**referral_pattern** | **String** | The pattern used to generate referrals. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional]
|
|
15
15
|
|
|
16
16
|
## Code Sample
|
|
17
17
|
|
|
18
18
|
```ruby
|
|
19
19
|
require 'TalonOne'
|
|
20
20
|
|
|
21
|
-
instance = TalonOne::NewReferralsForMultipleAdvocates.new(start_date:
|
|
22
|
-
expiry_date:
|
|
23
|
-
usage_limit:
|
|
24
|
-
campaign_id:
|
|
25
|
-
advocate_profile_integration_ids:
|
|
21
|
+
instance = TalonOne::NewReferralsForMultipleAdvocates.new(start_date: 2020-11-10T23:00Z,
|
|
22
|
+
expiry_date: 2021-11-10T23:00Z,
|
|
23
|
+
usage_limit: 1,
|
|
24
|
+
campaign_id: 45,
|
|
25
|
+
advocate_profile_integration_ids: [URNGV8294NV, DRPVV9476AF],
|
|
26
26
|
attributes: null,
|
|
27
|
-
valid_characters:
|
|
28
|
-
referral_pattern:
|
|
27
|
+
valid_characters: [E, F, I, Z, 1, 2, 3],
|
|
28
|
+
referral_pattern: REF-###-###)
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
|
data/docs/NewReturn.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::NewReturn
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**returned_cart_items** | [**Array<ReturnedCartItem>**](ReturnedCartItem.md) | List of cart items to be returned |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::NewReturn.new(returned_cart_items: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/NewRole.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | Name of the role |
|
|
8
8
|
**description** | **String** | Description of the role | [optional]
|
|
9
9
|
**acl** | **String** | Role Policy this should be a stringified blob of json |
|
|
10
|
-
**
|
|
10
|
+
**members** | **Array<Integer>** | An array of user identifiers |
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -17,7 +17,7 @@ require 'TalonOne'
|
|
|
17
17
|
instance = TalonOne::NewRole.new(name: null,
|
|
18
18
|
description: null,
|
|
19
19
|
acl: null,
|
|
20
|
-
|
|
20
|
+
members: null)
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
data/docs/NewRuleset.md
CHANGED
|
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**rules** | [**Array<Rule>**](Rule.md) | Set of rules to apply. |
|
|
8
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. |
|
|
9
|
-
**rb_version** | **String** |
|
|
10
|
-
**activate** | **Boolean** |
|
|
9
|
+
**rb_version** | **String** | The version of the rulebuilder used to create this ruleset. | [optional]
|
|
10
|
+
**activate** | **Boolean** | Indicates whether this created ruleset should be activated for the campaign that owns it. | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
|
|
|
15
15
|
require 'TalonOne'
|
|
16
16
|
|
|
17
17
|
instance = TalonOne::NewRuleset.new(rules: null,
|
|
18
|
-
bindings:
|
|
19
|
-
rb_version:
|
|
18
|
+
bindings: [],
|
|
19
|
+
rb_version: v2,
|
|
20
20
|
activate: null)
|
|
21
21
|
```
|
|
22
22
|
|
data/docs/NewUser.md
CHANGED
|
@@ -14,10 +14,10 @@ Name | Type | Description | Notes
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'TalonOne'
|
|
16
16
|
|
|
17
|
-
instance = TalonOne::NewUser.new(email:
|
|
18
|
-
password:
|
|
17
|
+
instance = TalonOne::NewUser.new(email: john.doe@example.com,
|
|
18
|
+
password: admin123456,
|
|
19
19
|
name: null,
|
|
20
|
-
invite_token:
|
|
20
|
+
invite_token: Gy9b8w1irmQtEPo5RmbMmSPheL5h4)
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# TalonOne::NotificationWebhook
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | Unique ID for this entity. |
|
|
8
|
+
**created** | **DateTime** | The exact moment this entity was created. |
|
|
9
|
+
**modified** | **DateTime** | The exact moment this entity was last modified. |
|
|
10
|
+
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
11
|
+
**url** | **String** | API url for this notification webhook |
|
|
12
|
+
**headers** | **Array<String>** | List of API HTTP headers for this notification webhook |
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'TalonOne'
|
|
18
|
+
|
|
19
|
+
instance = TalonOne::NotificationWebhook.new(id: 6,
|
|
20
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
21
|
+
modified: 2021-09-12T10:12:42Z,
|
|
22
|
+
application_id: 322,
|
|
23
|
+
url: null,
|
|
24
|
+
headers: null)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
data/docs/Referral.md
CHANGED
|
@@ -8,13 +8,13 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**created** | **DateTime** | The exact moment this entity was created. |
|
|
9
9
|
**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional]
|
|
10
10
|
**expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional]
|
|
11
|
-
**usage_limit** | **Integer** | The number of times a referral code can be used.
|
|
11
|
+
**usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. |
|
|
12
12
|
**campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. |
|
|
13
13
|
**advocate_profile_integration_id** | **String** | The Integration ID of the Advocate's Profile. |
|
|
14
14
|
**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional]
|
|
15
15
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
16
16
|
**import_id** | **Integer** | The ID of the Import which created this referral. | [optional]
|
|
17
|
-
**code** | **String** | The
|
|
17
|
+
**code** | **String** | The referral code. |
|
|
18
18
|
**usage_counter** | **Integer** | The number of times this referral code has been successfully used. |
|
|
19
19
|
**batch_id** | **String** | The ID of the batch the referrals belong to. | [optional]
|
|
20
20
|
|
|
@@ -23,19 +23,19 @@ Name | Type | Description | Notes
|
|
|
23
23
|
```ruby
|
|
24
24
|
require 'TalonOne'
|
|
25
25
|
|
|
26
|
-
instance = TalonOne::Referral.new(id:
|
|
27
|
-
created:
|
|
28
|
-
start_date:
|
|
29
|
-
expiry_date:
|
|
30
|
-
usage_limit:
|
|
31
|
-
campaign_id:
|
|
32
|
-
advocate_profile_integration_id:
|
|
33
|
-
friend_profile_integration_id:
|
|
26
|
+
instance = TalonOne::Referral.new(id: 6,
|
|
27
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
28
|
+
start_date: 2020-11-10T23:00Z,
|
|
29
|
+
expiry_date: 2021-11-10T23:00Z,
|
|
30
|
+
usage_limit: 1,
|
|
31
|
+
campaign_id: 78,
|
|
32
|
+
advocate_profile_integration_id: URNGV8294NV,
|
|
33
|
+
friend_profile_integration_id: BZGGC2454PA,
|
|
34
34
|
attributes: null,
|
|
35
35
|
import_id: null,
|
|
36
|
-
code:
|
|
37
|
-
usage_counter:
|
|
38
|
-
batch_id:
|
|
36
|
+
code: 27G47Y54VH9L,
|
|
37
|
+
usage_counter: 1,
|
|
38
|
+
batch_id: tqyrgahe)
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
|
data/docs/ReferralConstraints.md
CHANGED
|
@@ -6,16 +6,16 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional]
|
|
8
8
|
**expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional]
|
|
9
|
-
**usage_limit** | **Integer** | The number of times a referral code can be used.
|
|
9
|
+
**usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::ReferralConstraints.new(start_date:
|
|
17
|
-
expiry_date:
|
|
18
|
-
usage_limit:
|
|
16
|
+
instance = TalonOne::ReferralConstraints.new(start_date: 2020-11-10T23:00Z,
|
|
17
|
+
expiry_date: 2021-11-10T23:00Z,
|
|
18
|
+
usage_limit: 1)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::ReturnIntegrationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**_return** | [**NewReturn**](NewReturn.md) | |
|
|
8
|
+
**response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the return request. | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::ReturnIntegrationRequest.new(_return: null,
|
|
16
|
+
response_content: [customerSession, customerProfile])
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::ReturnedCartItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**position** | **Integer** | The index of the cart item in the provided customer session's `cartItems` property. |
|
|
8
|
+
**quantity** | **Integer** | Number of cart items to return. It is only available when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. If cart item flattening is disabled, the cart item can only be returned in its entirety. | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::ReturnedCartItem.new(position: 2,
|
|
16
|
+
quantity: 1)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/Role.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**created** | **DateTime** | The exact moment this entity was created. |
|
|
9
9
|
**modified** | **DateTime** | The exact moment this entity was last modified. |
|
|
10
10
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
11
|
-
**campaign_group_id** | **Integer** | The ID of the Campaign Group this role was created for.
|
|
11
|
+
**campaign_group_id** | **Integer** | The ID of the [Campaign Group](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this role was created for. | [optional]
|
|
12
12
|
**name** | **String** | Name of the role |
|
|
13
13
|
**description** | **String** | Description of the role | [optional]
|
|
14
14
|
**members** | **Array<Integer>** | A list of user identifiers assigned to this role | [optional]
|
|
@@ -19,10 +19,10 @@ Name | Type | Description | Notes
|
|
|
19
19
|
```ruby
|
|
20
20
|
require 'TalonOne'
|
|
21
21
|
|
|
22
|
-
instance = TalonOne::Role.new(id:
|
|
23
|
-
created:
|
|
24
|
-
modified:
|
|
25
|
-
account_id:
|
|
22
|
+
instance = TalonOne::Role.new(id: 6,
|
|
23
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
24
|
+
modified: 2021-09-12T10:12:42Z,
|
|
25
|
+
account_id: 3886,
|
|
26
26
|
campaign_group_id: null,
|
|
27
27
|
name: null,
|
|
28
28
|
description: null,
|
|
@@ -9,6 +9,9 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**value** | **Float** | The amount of points that were rolled back |
|
|
10
10
|
**recipient_integration_id** | **String** | The user for whom these points were originally added |
|
|
11
11
|
**transaction_uuid** | **String** | The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. |
|
|
12
|
+
**cart_item_position** | **Float** | The index of the item in the cart items for which the loyalty points were rolled back. | [optional]
|
|
13
|
+
**cart_item_sub_position** | **Float** | The sub-position is returned when [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled. It indicates to which item the loyalty points were rolled back, for cart items with `quantity` > 1. | [optional]
|
|
14
|
+
**card_identifier** | **String** | The card on which these points were originally added. | [optional]
|
|
12
15
|
|
|
13
16
|
## Code Sample
|
|
14
17
|
|
|
@@ -19,7 +22,10 @@ instance = TalonOne::RollbackAddedLoyaltyPointsEffectProps.new(program_id: null,
|
|
|
19
22
|
sub_ledger_id: null,
|
|
20
23
|
value: null,
|
|
21
24
|
recipient_integration_id: null,
|
|
22
|
-
transaction_uuid: null
|
|
25
|
+
transaction_uuid: null,
|
|
26
|
+
cart_item_position: null,
|
|
27
|
+
cart_item_sub_position: null,
|
|
28
|
+
card_identifier: null)
|
|
23
29
|
```
|
|
24
30
|
|
|
25
31
|
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**start_date** | **DateTime** | Date after which the reimbursed points will be valid | [optional]
|
|
12
12
|
**expiry_date** | **DateTime** | Date after which the reimbursed points will expire | [optional]
|
|
13
13
|
**transaction_uuid** | **String** | The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back |
|
|
14
|
+
**card_identifier** | **String** | The card on which these points were added. | [optional]
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
@@ -23,7 +24,8 @@ instance = TalonOne::RollbackDeductedLoyaltyPointsEffectProps.new(program_id: nu
|
|
|
23
24
|
recipient_integration_id: null,
|
|
24
25
|
start_date: null,
|
|
25
26
|
expiry_date: null,
|
|
26
|
-
transaction_uuid: null
|
|
27
|
+
transaction_uuid: null,
|
|
28
|
+
card_identifier: null)
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
|
|
@@ -5,7 +5,12 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The name of the \"setDiscount\" effect that was rolled back |
|
|
8
|
-
**value** | **Float** | The value of the discount that was rolled back |
|
|
8
|
+
**value** | **Float** | The value of the discount that was rolled back. |
|
|
9
|
+
**cart_item_position** | **Float** | The index of the item in the cart items for which the discount was rolled back. | [optional]
|
|
10
|
+
**cart_item_sub_position** | **Float** | The index of the item unit in its line item. It is only used for cart items with `quantity` > 1 and is only returned when cart item flattening is enabled. | [optional]
|
|
11
|
+
**additional_cost_id** | **Integer** | The ID of the additional cost that was rolled back | [optional]
|
|
12
|
+
**additional_cost** | **String** | The name of the additional cost that was rolled back | [optional]
|
|
13
|
+
**scope** | **String** | The scope of the rolled back discount - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` | [optional]
|
|
9
14
|
|
|
10
15
|
## Code Sample
|
|
11
16
|
|
|
@@ -13,7 +18,12 @@ Name | Type | Description | Notes
|
|
|
13
18
|
require 'TalonOne'
|
|
14
19
|
|
|
15
20
|
instance = TalonOne::RollbackDiscountEffectProps.new(name: null,
|
|
16
|
-
value: null
|
|
21
|
+
value: null,
|
|
22
|
+
cart_item_position: null,
|
|
23
|
+
cart_item_sub_position: null,
|
|
24
|
+
additional_cost_id: null,
|
|
25
|
+
additional_cost: null,
|
|
26
|
+
scope: null)
|
|
17
27
|
```
|
|
18
28
|
|
|
19
29
|
|