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/IntegrationApi.md
CHANGED
|
@@ -4,30 +4,36 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
8
|
-
[**
|
|
7
|
+
[**create_audience_v2**](IntegrationApi.md#create_audience_v2) | **POST** /v2/audiences | Create audience
|
|
8
|
+
[**create_coupon_reservation**](IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create coupon reservation
|
|
9
|
+
[**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create referral code for an advocate
|
|
9
10
|
[**create_referrals_for_multiple_advocates**](IntegrationApi.md#create_referrals_for_multiple_advocates) | **POST** /v1/referrals_for_multiple_advocates | Create referral codes for multiple advocates
|
|
11
|
+
[**delete_audience_memberships_v2**](IntegrationApi.md#delete_audience_memberships_v2) | **DELETE** /v2/audiences/{audienceId}/memberships | Delete audience memberships
|
|
12
|
+
[**delete_audience_v2**](IntegrationApi.md#delete_audience_v2) | **DELETE** /v2/audiences/{audienceId} | Delete audience
|
|
10
13
|
[**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
|
11
|
-
[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete
|
|
12
|
-
[**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory |
|
|
13
|
-
[**
|
|
14
|
-
[**
|
|
15
|
-
[**
|
|
16
|
-
[**
|
|
17
|
-
[**
|
|
18
|
-
[**
|
|
19
|
-
[**
|
|
20
|
-
[**
|
|
14
|
+
[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete customer's personal data
|
|
15
|
+
[**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data
|
|
16
|
+
[**get_customer_session**](IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session
|
|
17
|
+
[**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved
|
|
18
|
+
[**return_cart_items**](IntegrationApi.md#return_cart_items) | **POST** /v2/customer_sessions/{customerSessionId}/returns | Return cart items
|
|
19
|
+
[**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track event
|
|
20
|
+
[**track_event_v2**](IntegrationApi.md#track_event_v2) | **POST** /v2/events | Track event V2
|
|
21
|
+
[**update_audience_customers_attributes**](IntegrationApi.md#update_audience_customers_attributes) | **PUT** /v2/audience_customers/{audienceId}/attributes | Update profile attributes for all customers in audience
|
|
22
|
+
[**update_audience_v2**](IntegrationApi.md#update_audience_v2) | **PUT** /v2/audiences/{audienceId} | Update audience
|
|
23
|
+
[**update_customer_profile_audiences**](IntegrationApi.md#update_customer_profile_audiences) | **POST** /v2/customer_audiences | Update multiple customer profiles' audiences
|
|
24
|
+
[**update_customer_profile_v2**](IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{integrationId} | Update customer profile
|
|
25
|
+
[**update_customer_profiles_v2**](IntegrationApi.md#update_customer_profiles_v2) | **PUT** /v2/customer_profiles | Update multiple customer profiles
|
|
26
|
+
[**update_customer_session_v2**](IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update customer session
|
|
21
27
|
|
|
22
28
|
|
|
23
29
|
|
|
24
|
-
##
|
|
30
|
+
## create_audience_v2
|
|
25
31
|
|
|
26
|
-
>
|
|
32
|
+
> Audience create_audience_v2(body)
|
|
27
33
|
|
|
28
|
-
Create
|
|
34
|
+
Create audience
|
|
29
35
|
|
|
30
|
-
|
|
36
|
+
Create an audience. The audience can be created directly from scratch or can come from third party platforms. To create an audience from an existing audience in mParticle or Segment: 1. Set the `integration` property to `mparticle` or `segment` depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform than mParticle: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch: 1. Only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
|
|
31
37
|
|
|
32
38
|
### Example
|
|
33
39
|
|
|
@@ -40,11 +46,60 @@ TalonOne.configure do |config|
|
|
|
40
46
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
41
47
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
42
48
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
52
|
+
body = TalonOne::NewAudience.new # NewAudience |
|
|
53
|
+
|
|
54
|
+
begin
|
|
55
|
+
#Create audience
|
|
56
|
+
result = api_instance.create_audience_v2(body)
|
|
57
|
+
p result
|
|
58
|
+
rescue TalonOne::ApiError => e
|
|
59
|
+
puts "Exception when calling IntegrationApi->create_audience_v2: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
Name | Type | Description | Notes
|
|
67
|
+
------------- | ------------- | ------------- | -------------
|
|
68
|
+
**body** | [**NewAudience**](NewAudience.md)| |
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
[**Audience**](Audience.md)
|
|
73
|
+
|
|
74
|
+
### Authorization
|
|
43
75
|
|
|
44
|
-
|
|
45
|
-
|
|
76
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
77
|
+
|
|
78
|
+
### HTTP request headers
|
|
79
|
+
|
|
80
|
+
- **Content-Type**: application/json
|
|
81
|
+
- **Accept**: application/json
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
## create_coupon_reservation
|
|
85
|
+
|
|
86
|
+
> Coupon create_coupon_reservation(coupon_value, body)
|
|
87
|
+
|
|
88
|
+
Create coupon reservation
|
|
89
|
+
|
|
90
|
+
Create a coupon reservation for specified customer profiles on the specified coupon. Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data endpoint](/integration-api/#operation/getCustomerInventory). If a coupon gets created for a specific user, it will automatically show up in their coupons. When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data endpoint](/integration-api/#operation/getCustomerInventory). **Important:** - This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. - To create a hard reservation, use the [Create coupons](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients](/management-api/#operation/createCouponsForMultipleRecipients) endpoints setting the `recipientsIntegrationId` property. For example, you can use this endpoint and `List customer data` to create a \"coupon wallet\" by reserving coupon codes for a customer, and then displaying their \"coupon wallet\" when they visit your store.
|
|
91
|
+
|
|
92
|
+
### Example
|
|
93
|
+
|
|
94
|
+
```ruby
|
|
95
|
+
# load the gem
|
|
96
|
+
require 'talon_one'
|
|
97
|
+
# setup authorization
|
|
98
|
+
TalonOne.configure do |config|
|
|
99
|
+
# Configure API key authorization: api_key_v1
|
|
100
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
46
101
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
47
|
-
#config.api_key_prefix['
|
|
102
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
48
103
|
end
|
|
49
104
|
|
|
50
105
|
api_instance = TalonOne::IntegrationApi.new
|
|
@@ -52,7 +107,7 @@ coupon_value = 'coupon_value_example' # String | The value of a coupon
|
|
|
52
107
|
body = TalonOne::CouponReservations.new # CouponReservations |
|
|
53
108
|
|
|
54
109
|
begin
|
|
55
|
-
#Create
|
|
110
|
+
#Create coupon reservation
|
|
56
111
|
result = api_instance.create_coupon_reservation(coupon_value, body)
|
|
57
112
|
p result
|
|
58
113
|
rescue TalonOne::ApiError => e
|
|
@@ -74,7 +129,7 @@ Name | Type | Description | Notes
|
|
|
74
129
|
|
|
75
130
|
### Authorization
|
|
76
131
|
|
|
77
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
132
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
78
133
|
|
|
79
134
|
### HTTP request headers
|
|
80
135
|
|
|
@@ -86,7 +141,7 @@ Name | Type | Description | Notes
|
|
|
86
141
|
|
|
87
142
|
> Referral create_referral(body)
|
|
88
143
|
|
|
89
|
-
Create
|
|
144
|
+
Create referral code for an advocate
|
|
90
145
|
|
|
91
146
|
Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
|
|
92
147
|
|
|
@@ -101,18 +156,13 @@ TalonOne.configure do |config|
|
|
|
101
156
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
102
157
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
103
158
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
104
|
-
|
|
105
|
-
# Configure API key authorization: integration_auth
|
|
106
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
107
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
108
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
109
159
|
end
|
|
110
160
|
|
|
111
161
|
api_instance = TalonOne::IntegrationApi.new
|
|
112
162
|
body = TalonOne::NewReferral.new # NewReferral |
|
|
113
163
|
|
|
114
164
|
begin
|
|
115
|
-
#Create
|
|
165
|
+
#Create referral code for an advocate
|
|
116
166
|
result = api_instance.create_referral(body)
|
|
117
167
|
p result
|
|
118
168
|
rescue TalonOne::ApiError => e
|
|
@@ -133,7 +183,7 @@ Name | Type | Description | Notes
|
|
|
133
183
|
|
|
134
184
|
### Authorization
|
|
135
185
|
|
|
136
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
186
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
137
187
|
|
|
138
188
|
### HTTP request headers
|
|
139
189
|
|
|
@@ -160,17 +210,12 @@ TalonOne.configure do |config|
|
|
|
160
210
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
161
211
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
162
212
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
163
|
-
|
|
164
|
-
# Configure API key authorization: integration_auth
|
|
165
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
166
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
167
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
168
213
|
end
|
|
169
214
|
|
|
170
215
|
api_instance = TalonOne::IntegrationApi.new
|
|
171
216
|
body = TalonOne::NewReferralsForMultipleAdvocates.new # NewReferralsForMultipleAdvocates |
|
|
172
217
|
opts = {
|
|
173
|
-
silent: '
|
|
218
|
+
silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information.
|
|
174
219
|
}
|
|
175
220
|
|
|
176
221
|
begin
|
|
@@ -188,7 +233,7 @@ end
|
|
|
188
233
|
Name | Type | Description | Notes
|
|
189
234
|
------------- | ------------- | ------------- | -------------
|
|
190
235
|
**body** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md)| |
|
|
191
|
-
**silent** | **String**|
|
|
236
|
+
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. | [optional] [default to 'yes']
|
|
192
237
|
|
|
193
238
|
### Return type
|
|
194
239
|
|
|
@@ -196,7 +241,7 @@ Name | Type | Description | Notes
|
|
|
196
241
|
|
|
197
242
|
### Authorization
|
|
198
243
|
|
|
199
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
244
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
200
245
|
|
|
201
246
|
### HTTP request headers
|
|
202
247
|
|
|
@@ -204,13 +249,119 @@ Name | Type | Description | Notes
|
|
|
204
249
|
- **Accept**: application/json
|
|
205
250
|
|
|
206
251
|
|
|
252
|
+
## delete_audience_memberships_v2
|
|
253
|
+
|
|
254
|
+
> delete_audience_memberships_v2(audience_id)
|
|
255
|
+
|
|
256
|
+
Delete audience memberships
|
|
257
|
+
|
|
258
|
+
Remove all members from this audience.
|
|
259
|
+
|
|
260
|
+
### Example
|
|
261
|
+
|
|
262
|
+
```ruby
|
|
263
|
+
# load the gem
|
|
264
|
+
require 'talon_one'
|
|
265
|
+
# setup authorization
|
|
266
|
+
TalonOne.configure do |config|
|
|
267
|
+
# Configure API key authorization: manager_auth
|
|
268
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
269
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
270
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
274
|
+
audience_id = 56 # Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
|
|
275
|
+
|
|
276
|
+
begin
|
|
277
|
+
#Delete audience memberships
|
|
278
|
+
api_instance.delete_audience_memberships_v2(audience_id)
|
|
279
|
+
rescue TalonOne::ApiError => e
|
|
280
|
+
puts "Exception when calling IntegrationApi->delete_audience_memberships_v2: #{e}"
|
|
281
|
+
end
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### Parameters
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
Name | Type | Description | Notes
|
|
288
|
+
------------- | ------------- | ------------- | -------------
|
|
289
|
+
**audience_id** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
|
|
290
|
+
|
|
291
|
+
### Return type
|
|
292
|
+
|
|
293
|
+
nil (empty response body)
|
|
294
|
+
|
|
295
|
+
### Authorization
|
|
296
|
+
|
|
297
|
+
[manager_auth](../README.md#manager_auth)
|
|
298
|
+
|
|
299
|
+
### HTTP request headers
|
|
300
|
+
|
|
301
|
+
- **Content-Type**: Not defined
|
|
302
|
+
- **Accept**: application/json
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
## delete_audience_v2
|
|
306
|
+
|
|
307
|
+
> delete_audience_v2(audience_id)
|
|
308
|
+
|
|
309
|
+
Delete audience
|
|
310
|
+
|
|
311
|
+
Delete an audience created by a third-party integration. **Warning:** This endpoint also removes any associations recorded between a customer profile and this audience.
|
|
312
|
+
|
|
313
|
+
### Example
|
|
314
|
+
|
|
315
|
+
```ruby
|
|
316
|
+
# load the gem
|
|
317
|
+
require 'talon_one'
|
|
318
|
+
# setup authorization
|
|
319
|
+
TalonOne.configure do |config|
|
|
320
|
+
# Configure API key authorization: manager_auth
|
|
321
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
322
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
323
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
324
|
+
end
|
|
325
|
+
|
|
326
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
327
|
+
audience_id = 56 # Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
|
|
328
|
+
|
|
329
|
+
begin
|
|
330
|
+
#Delete audience
|
|
331
|
+
api_instance.delete_audience_v2(audience_id)
|
|
332
|
+
rescue TalonOne::ApiError => e
|
|
333
|
+
puts "Exception when calling IntegrationApi->delete_audience_v2: #{e}"
|
|
334
|
+
end
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
### Parameters
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
Name | Type | Description | Notes
|
|
341
|
+
------------- | ------------- | ------------- | -------------
|
|
342
|
+
**audience_id** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
|
|
343
|
+
|
|
344
|
+
### Return type
|
|
345
|
+
|
|
346
|
+
nil (empty response body)
|
|
347
|
+
|
|
348
|
+
### Authorization
|
|
349
|
+
|
|
350
|
+
[manager_auth](../README.md#manager_auth)
|
|
351
|
+
|
|
352
|
+
### HTTP request headers
|
|
353
|
+
|
|
354
|
+
- **Content-Type**: Not defined
|
|
355
|
+
- **Accept**: application/json
|
|
356
|
+
|
|
357
|
+
|
|
207
358
|
## delete_coupon_reservation
|
|
208
359
|
|
|
209
360
|
> delete_coupon_reservation(coupon_value, body)
|
|
210
361
|
|
|
211
362
|
Delete coupon reservations
|
|
212
363
|
|
|
213
|
-
|
|
364
|
+
Remove all passed customer profiles reservation from this coupon.
|
|
214
365
|
|
|
215
366
|
### Example
|
|
216
367
|
|
|
@@ -223,11 +374,6 @@ TalonOne.configure do |config|
|
|
|
223
374
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
224
375
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
225
376
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
226
|
-
|
|
227
|
-
# Configure API key authorization: integration_auth
|
|
228
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
229
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
230
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
231
377
|
end
|
|
232
378
|
|
|
233
379
|
api_instance = TalonOne::IntegrationApi.new
|
|
@@ -256,21 +402,21 @@ nil (empty response body)
|
|
|
256
402
|
|
|
257
403
|
### Authorization
|
|
258
404
|
|
|
259
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
405
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
260
406
|
|
|
261
407
|
### HTTP request headers
|
|
262
408
|
|
|
263
409
|
- **Content-Type**: application/json
|
|
264
|
-
- **Accept**:
|
|
410
|
+
- **Accept**: application/json
|
|
265
411
|
|
|
266
412
|
|
|
267
413
|
## delete_customer_data
|
|
268
414
|
|
|
269
415
|
> delete_customer_data(integration_id)
|
|
270
416
|
|
|
271
|
-
Delete
|
|
417
|
+
Delete customer's personal data
|
|
272
418
|
|
|
273
|
-
Delete all attributes on the customer profile and on entities that reference
|
|
419
|
+
Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
|
|
274
420
|
|
|
275
421
|
### Example
|
|
276
422
|
|
|
@@ -283,18 +429,13 @@ TalonOne.configure do |config|
|
|
|
283
429
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
284
430
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
285
431
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
286
|
-
|
|
287
|
-
# Configure API key authorization: integration_auth
|
|
288
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
289
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
290
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
291
432
|
end
|
|
292
433
|
|
|
293
434
|
api_instance = TalonOne::IntegrationApi.new
|
|
294
|
-
integration_id = 'integration_id_example' # String | The
|
|
435
|
+
integration_id = 'integration_id_example' # String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers).
|
|
295
436
|
|
|
296
437
|
begin
|
|
297
|
-
#Delete
|
|
438
|
+
#Delete customer's personal data
|
|
298
439
|
api_instance.delete_customer_data(integration_id)
|
|
299
440
|
rescue TalonOne::ApiError => e
|
|
300
441
|
puts "Exception when calling IntegrationApi->delete_customer_data: #{e}"
|
|
@@ -306,7 +447,7 @@ end
|
|
|
306
447
|
|
|
307
448
|
Name | Type | Description | Notes
|
|
308
449
|
------------- | ------------- | ------------- | -------------
|
|
309
|
-
**integration_id** | **String**| The
|
|
450
|
+
**integration_id** | **String**| The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). |
|
|
310
451
|
|
|
311
452
|
### Return type
|
|
312
453
|
|
|
@@ -314,21 +455,21 @@ nil (empty response body)
|
|
|
314
455
|
|
|
315
456
|
### Authorization
|
|
316
457
|
|
|
317
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
458
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
318
459
|
|
|
319
460
|
### HTTP request headers
|
|
320
461
|
|
|
321
462
|
- **Content-Type**: Not defined
|
|
322
|
-
- **Accept**:
|
|
463
|
+
- **Accept**: application/json
|
|
323
464
|
|
|
324
465
|
|
|
325
466
|
## get_customer_inventory
|
|
326
467
|
|
|
327
468
|
> CustomerInventory get_customer_inventory(integration_id, opts)
|
|
328
469
|
|
|
329
|
-
|
|
470
|
+
List customer data
|
|
330
471
|
|
|
331
|
-
|
|
472
|
+
Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points and reserved coupons. Reserved coupons also include redeemed coupons. You can also use this endpoint to get the projected loyalty balances in order to notify your customers about points that are about to expire, or to remind them how many points they have.
|
|
332
473
|
|
|
333
474
|
### Example
|
|
334
475
|
|
|
@@ -341,25 +482,21 @@ TalonOne.configure do |config|
|
|
|
341
482
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
342
483
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
343
484
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
344
|
-
|
|
345
|
-
# Configure API key authorization: integration_auth
|
|
346
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
347
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
348
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
349
485
|
end
|
|
350
486
|
|
|
351
487
|
api_instance = TalonOne::IntegrationApi.new
|
|
352
|
-
integration_id = 'integration_id_example' # String | The
|
|
488
|
+
integration_id = 'integration_id_example' # String | The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers).
|
|
353
489
|
opts = {
|
|
354
|
-
profile: true, # Boolean |
|
|
355
|
-
referrals: true, # Boolean |
|
|
356
|
-
coupons: true, # Boolean |
|
|
357
|
-
loyalty: true, # Boolean |
|
|
358
|
-
giveaways: true # Boolean |
|
|
490
|
+
profile: true, # Boolean | Set to `true` to include customer profile information in the response.
|
|
491
|
+
referrals: true, # Boolean | Set to `true` to include referral information in the response.
|
|
492
|
+
coupons: true, # Boolean | Set to `true` to include coupon information in the response.
|
|
493
|
+
loyalty: true, # Boolean | Set to `true` to include loyalty information in the response.
|
|
494
|
+
giveaways: true, # Boolean | Set to `true` to include giveaways information in the response.
|
|
495
|
+
loyalty_projection_end_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Set an end date to query the projected loyalty balances. You can project results up to 31 days from today.
|
|
359
496
|
}
|
|
360
497
|
|
|
361
498
|
begin
|
|
362
|
-
#
|
|
499
|
+
#List customer data
|
|
363
500
|
result = api_instance.get_customer_inventory(integration_id, opts)
|
|
364
501
|
p result
|
|
365
502
|
rescue TalonOne::ApiError => e
|
|
@@ -372,12 +509,13 @@ end
|
|
|
372
509
|
|
|
373
510
|
Name | Type | Description | Notes
|
|
374
511
|
------------- | ------------- | ------------- | -------------
|
|
375
|
-
**integration_id** | **String**| The
|
|
376
|
-
**profile** | **Boolean**|
|
|
377
|
-
**referrals** | **Boolean**|
|
|
378
|
-
**coupons** | **Boolean**|
|
|
379
|
-
**loyalty** | **Boolean**|
|
|
380
|
-
**giveaways** | **Boolean**|
|
|
512
|
+
**integration_id** | **String**| The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). |
|
|
513
|
+
**profile** | **Boolean**| Set to `true` to include customer profile information in the response. | [optional]
|
|
514
|
+
**referrals** | **Boolean**| Set to `true` to include referral information in the response. | [optional]
|
|
515
|
+
**coupons** | **Boolean**| Set to `true` to include coupon information in the response. | [optional]
|
|
516
|
+
**loyalty** | **Boolean**| Set to `true` to include loyalty information in the response. | [optional]
|
|
517
|
+
**giveaways** | **Boolean**| Set to `true` to include giveaways information in the response. | [optional]
|
|
518
|
+
**loyalty_projection_end_date** | **DateTime**| Set an end date to query the projected loyalty balances. You can project results up to 31 days from today. | [optional]
|
|
381
519
|
|
|
382
520
|
### Return type
|
|
383
521
|
|
|
@@ -385,7 +523,7 @@ Name | Type | Description | Notes
|
|
|
385
523
|
|
|
386
524
|
### Authorization
|
|
387
525
|
|
|
388
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
526
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
389
527
|
|
|
390
528
|
### HTTP request headers
|
|
391
529
|
|
|
@@ -393,13 +531,13 @@ Name | Type | Description | Notes
|
|
|
393
531
|
- **Accept**: application/json
|
|
394
532
|
|
|
395
533
|
|
|
396
|
-
##
|
|
534
|
+
## get_customer_session
|
|
397
535
|
|
|
398
|
-
>
|
|
536
|
+
> IntegrationCustomerSessionResponse get_customer_session(customer_session_id)
|
|
399
537
|
|
|
400
|
-
Get
|
|
538
|
+
Get customer session
|
|
401
539
|
|
|
402
|
-
|
|
540
|
+
Get customer session data.
|
|
403
541
|
|
|
404
542
|
### Example
|
|
405
543
|
|
|
@@ -412,18 +550,67 @@ TalonOne.configure do |config|
|
|
|
412
550
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
413
551
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
414
552
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
553
|
+
end
|
|
415
554
|
|
|
416
|
-
|
|
417
|
-
|
|
555
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
556
|
+
customer_session_id = 'customer_session_id_example' # String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions).
|
|
557
|
+
|
|
558
|
+
begin
|
|
559
|
+
#Get customer session
|
|
560
|
+
result = api_instance.get_customer_session(customer_session_id)
|
|
561
|
+
p result
|
|
562
|
+
rescue TalonOne::ApiError => e
|
|
563
|
+
puts "Exception when calling IntegrationApi->get_customer_session: #{e}"
|
|
564
|
+
end
|
|
565
|
+
```
|
|
566
|
+
|
|
567
|
+
### Parameters
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
Name | Type | Description | Notes
|
|
571
|
+
------------- | ------------- | ------------- | -------------
|
|
572
|
+
**customer_session_id** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). |
|
|
573
|
+
|
|
574
|
+
### Return type
|
|
575
|
+
|
|
576
|
+
[**IntegrationCustomerSessionResponse**](IntegrationCustomerSessionResponse.md)
|
|
577
|
+
|
|
578
|
+
### Authorization
|
|
579
|
+
|
|
580
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
581
|
+
|
|
582
|
+
### HTTP request headers
|
|
583
|
+
|
|
584
|
+
- **Content-Type**: Not defined
|
|
585
|
+
- **Accept**: application/json
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
## get_reserved_customers
|
|
589
|
+
|
|
590
|
+
> InlineResponse200 get_reserved_customers(coupon_value)
|
|
591
|
+
|
|
592
|
+
List customers that have this coupon reserved
|
|
593
|
+
|
|
594
|
+
Return all customers that have this coupon marked as reserved. Coupons are reserved in the following ways: - To create a soft reservation (any customer can use the coupon), use the [Create coupon reservation](#operation/createCouponReservation) endpoint. - To create a hard reservation (only the given customer can use the coupon), create a coupon in the Campaign Manager for a given `recipientIntegrationId` or use the [Create coupons](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients](/management-api/#operation/createCouponsForMultipleRecipients) endpoints.
|
|
595
|
+
|
|
596
|
+
### Example
|
|
597
|
+
|
|
598
|
+
```ruby
|
|
599
|
+
# load the gem
|
|
600
|
+
require 'talon_one'
|
|
601
|
+
# setup authorization
|
|
602
|
+
TalonOne.configure do |config|
|
|
603
|
+
# Configure API key authorization: api_key_v1
|
|
604
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
418
605
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
419
|
-
#config.api_key_prefix['
|
|
606
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
420
607
|
end
|
|
421
608
|
|
|
422
609
|
api_instance = TalonOne::IntegrationApi.new
|
|
423
610
|
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
|
424
611
|
|
|
425
612
|
begin
|
|
426
|
-
#
|
|
613
|
+
#List customers that have this coupon reserved
|
|
427
614
|
result = api_instance.get_reserved_customers(coupon_value)
|
|
428
615
|
p result
|
|
429
616
|
rescue TalonOne::ApiError => e
|
|
@@ -444,7 +631,7 @@ Name | Type | Description | Notes
|
|
|
444
631
|
|
|
445
632
|
### Authorization
|
|
446
633
|
|
|
447
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
634
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
448
635
|
|
|
449
636
|
### HTTP request headers
|
|
450
637
|
|
|
@@ -452,13 +639,13 @@ Name | Type | Description | Notes
|
|
|
452
639
|
- **Accept**: application/json
|
|
453
640
|
|
|
454
641
|
|
|
455
|
-
##
|
|
642
|
+
## return_cart_items
|
|
456
643
|
|
|
457
|
-
>
|
|
644
|
+
> IntegrationStateV2 return_cart_items(customer_session_id, body, opts)
|
|
458
645
|
|
|
459
|
-
|
|
646
|
+
Return cart items
|
|
460
647
|
|
|
461
|
-
|
|
648
|
+
Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially returned`. Its behavior depends on whether [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled for the campaign. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session).
|
|
462
649
|
|
|
463
650
|
### Example
|
|
464
651
|
|
|
@@ -471,11 +658,66 @@ TalonOne.configure do |config|
|
|
|
471
658
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
472
659
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
473
660
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
661
|
+
end
|
|
662
|
+
|
|
663
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
664
|
+
customer_session_id = 'customer_session_id_example' # String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions).
|
|
665
|
+
body = TalonOne::ReturnIntegrationRequest.new # ReturnIntegrationRequest |
|
|
666
|
+
opts = {
|
|
667
|
+
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
668
|
+
}
|
|
669
|
+
|
|
670
|
+
begin
|
|
671
|
+
#Return cart items
|
|
672
|
+
result = api_instance.return_cart_items(customer_session_id, body, opts)
|
|
673
|
+
p result
|
|
674
|
+
rescue TalonOne::ApiError => e
|
|
675
|
+
puts "Exception when calling IntegrationApi->return_cart_items: #{e}"
|
|
676
|
+
end
|
|
677
|
+
```
|
|
678
|
+
|
|
679
|
+
### Parameters
|
|
474
680
|
|
|
475
|
-
|
|
476
|
-
|
|
681
|
+
|
|
682
|
+
Name | Type | Description | Notes
|
|
683
|
+
------------- | ------------- | ------------- | -------------
|
|
684
|
+
**customer_session_id** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). |
|
|
685
|
+
**body** | [**ReturnIntegrationRequest**](ReturnIntegrationRequest.md)| |
|
|
686
|
+
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
687
|
+
|
|
688
|
+
### Return type
|
|
689
|
+
|
|
690
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
|
691
|
+
|
|
692
|
+
### Authorization
|
|
693
|
+
|
|
694
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
695
|
+
|
|
696
|
+
### HTTP request headers
|
|
697
|
+
|
|
698
|
+
- **Content-Type**: application/json
|
|
699
|
+
- **Accept**: application/json
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
## track_event
|
|
703
|
+
|
|
704
|
+
> IntegrationState track_event(body, opts)
|
|
705
|
+
|
|
706
|
+
Track event
|
|
707
|
+
|
|
708
|
+
**Important:** This endpoint is **DEPRECATED**. Use [Track Event V2](https://docs.talon.one/integration-api/#tag/Events/operation/trackEventV2) instead. > Triggers a custom event in a customer session. You can then check this event in your rules. **Important:** Talon.One offers a set of [built-in events](/docs/dev/concepts/events), ensure you do not create a custom event when you can use a built-in event. > For example, use this endpoint to trigger an event when a user updates their payment information. > Before using this endpoint, create your event as a custom attribute of type `event`. See the [Developer docs](/docs/dev/concepts/events/#creating-a-custom-event). > An event is always part of a session. If either the profile or the session does not exist, a new empty profile/session is created. If the specified session already exists, it must belong to the same `profileId` or an error will be returned.
|
|
709
|
+
|
|
710
|
+
### Example
|
|
711
|
+
|
|
712
|
+
```ruby
|
|
713
|
+
# load the gem
|
|
714
|
+
require 'talon_one'
|
|
715
|
+
# setup authorization
|
|
716
|
+
TalonOne.configure do |config|
|
|
717
|
+
# Configure API key authorization: api_key_v1
|
|
718
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
477
719
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
478
|
-
#config.api_key_prefix['
|
|
720
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
479
721
|
end
|
|
480
722
|
|
|
481
723
|
api_instance = TalonOne::IntegrationApi.new
|
|
@@ -485,7 +727,7 @@ opts = {
|
|
|
485
727
|
}
|
|
486
728
|
|
|
487
729
|
begin
|
|
488
|
-
#Track
|
|
730
|
+
#Track event
|
|
489
731
|
result = api_instance.track_event(body, opts)
|
|
490
732
|
p result
|
|
491
733
|
rescue TalonOne::ApiError => e
|
|
@@ -507,7 +749,7 @@ Name | Type | Description | Notes
|
|
|
507
749
|
|
|
508
750
|
### Authorization
|
|
509
751
|
|
|
510
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
752
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
511
753
|
|
|
512
754
|
### HTTP request headers
|
|
513
755
|
|
|
@@ -515,13 +757,13 @@ Name | Type | Description | Notes
|
|
|
515
757
|
- **Accept**: application/json
|
|
516
758
|
|
|
517
759
|
|
|
518
|
-
##
|
|
760
|
+
## track_event_v2
|
|
519
761
|
|
|
520
|
-
>
|
|
762
|
+
> IntegrationStateV2 track_event_v2(body, opts)
|
|
521
763
|
|
|
522
|
-
|
|
764
|
+
Track event V2
|
|
523
765
|
|
|
524
|
-
|
|
766
|
+
Triggers a custom event. You can then check this event in your rules. **Important:** Talon.One offers a set of [built-in events](/docs/dev/concepts/events), ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a user updates their payment information. Before using this endpoint, create your event as a custom attribute of type `event`. See the [Developer docs](/docs/dev/concepts/events/#creating-a-custom-event). **Important:** `profileId` is required. An event V2 is associated with a customer profile.
|
|
525
767
|
|
|
526
768
|
### Example
|
|
527
769
|
|
|
@@ -534,26 +776,21 @@ TalonOne.configure do |config|
|
|
|
534
776
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
535
777
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
536
778
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
537
|
-
|
|
538
|
-
# Configure API key authorization: integration_auth
|
|
539
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
540
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
541
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
542
779
|
end
|
|
543
780
|
|
|
544
781
|
api_instance = TalonOne::IntegrationApi.new
|
|
545
|
-
|
|
546
|
-
body = TalonOne::NewCustomerProfile.new # NewCustomerProfile |
|
|
782
|
+
body = TalonOne::IntegrationEventV2Request.new # IntegrationEventV2Request |
|
|
547
783
|
opts = {
|
|
784
|
+
silent: 'yes', # String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information.
|
|
548
785
|
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
549
786
|
}
|
|
550
787
|
|
|
551
788
|
begin
|
|
552
|
-
#
|
|
553
|
-
result = api_instance.
|
|
789
|
+
#Track event V2
|
|
790
|
+
result = api_instance.track_event_v2(body, opts)
|
|
554
791
|
p result
|
|
555
792
|
rescue TalonOne::ApiError => e
|
|
556
|
-
puts "Exception when calling IntegrationApi->
|
|
793
|
+
puts "Exception when calling IntegrationApi->track_event_v2: #{e}"
|
|
557
794
|
end
|
|
558
795
|
```
|
|
559
796
|
|
|
@@ -562,17 +799,17 @@ end
|
|
|
562
799
|
|
|
563
800
|
Name | Type | Description | Notes
|
|
564
801
|
------------- | ------------- | ------------- | -------------
|
|
565
|
-
**
|
|
566
|
-
**
|
|
802
|
+
**body** | [**IntegrationEventV2Request**](IntegrationEventV2Request.md)| |
|
|
803
|
+
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. | [optional] [default to 'yes']
|
|
567
804
|
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
568
805
|
|
|
569
806
|
### Return type
|
|
570
807
|
|
|
571
|
-
[**
|
|
808
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
|
572
809
|
|
|
573
810
|
### Authorization
|
|
574
811
|
|
|
575
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
812
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
576
813
|
|
|
577
814
|
### HTTP request headers
|
|
578
815
|
|
|
@@ -580,13 +817,13 @@ Name | Type | Description | Notes
|
|
|
580
817
|
- **Accept**: application/json
|
|
581
818
|
|
|
582
819
|
|
|
583
|
-
##
|
|
820
|
+
## update_audience_customers_attributes
|
|
584
821
|
|
|
585
|
-
>
|
|
822
|
+
> update_audience_customers_attributes(audience_id, body)
|
|
586
823
|
|
|
587
|
-
Update
|
|
824
|
+
Update profile attributes for all customers in audience
|
|
588
825
|
|
|
589
|
-
Update
|
|
826
|
+
Update the specified profile attributes to the provided values for all customers in the specified audience.
|
|
590
827
|
|
|
591
828
|
### Example
|
|
592
829
|
|
|
@@ -602,13 +839,14 @@ TalonOne.configure do |config|
|
|
|
602
839
|
end
|
|
603
840
|
|
|
604
841
|
api_instance = TalonOne::IntegrationApi.new
|
|
605
|
-
|
|
842
|
+
audience_id = 56 # Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
|
|
843
|
+
body = nil # Object |
|
|
606
844
|
|
|
607
845
|
begin
|
|
608
|
-
#Update
|
|
609
|
-
api_instance.
|
|
846
|
+
#Update profile attributes for all customers in audience
|
|
847
|
+
api_instance.update_audience_customers_attributes(audience_id, body)
|
|
610
848
|
rescue TalonOne::ApiError => e
|
|
611
|
-
puts "Exception when calling IntegrationApi->
|
|
849
|
+
puts "Exception when calling IntegrationApi->update_audience_customers_attributes: #{e}"
|
|
612
850
|
end
|
|
613
851
|
```
|
|
614
852
|
|
|
@@ -617,7 +855,8 @@ end
|
|
|
617
855
|
|
|
618
856
|
Name | Type | Description | Notes
|
|
619
857
|
------------- | ------------- | ------------- | -------------
|
|
620
|
-
**
|
|
858
|
+
**audience_id** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
|
|
859
|
+
**body** | **Object**| |
|
|
621
860
|
|
|
622
861
|
### Return type
|
|
623
862
|
|
|
@@ -630,16 +869,16 @@ nil (empty response body)
|
|
|
630
869
|
### HTTP request headers
|
|
631
870
|
|
|
632
871
|
- **Content-Type**: application/json
|
|
633
|
-
- **Accept**:
|
|
872
|
+
- **Accept**: application/json
|
|
634
873
|
|
|
635
874
|
|
|
636
|
-
##
|
|
875
|
+
## update_audience_v2
|
|
637
876
|
|
|
638
|
-
>
|
|
877
|
+
> Audience update_audience_v2(audience_id, body)
|
|
639
878
|
|
|
640
|
-
Update
|
|
879
|
+
Update audience
|
|
641
880
|
|
|
642
|
-
Update
|
|
881
|
+
Update an Audience created by a third-party integration.
|
|
643
882
|
|
|
644
883
|
### Example
|
|
645
884
|
|
|
@@ -655,19 +894,15 @@ TalonOne.configure do |config|
|
|
|
655
894
|
end
|
|
656
895
|
|
|
657
896
|
api_instance = TalonOne::IntegrationApi.new
|
|
658
|
-
|
|
659
|
-
body = TalonOne::
|
|
660
|
-
opts = {
|
|
661
|
-
run_rule_engine: false, # Boolean | Indicates whether to run the rule engine.
|
|
662
|
-
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`.
|
|
663
|
-
}
|
|
897
|
+
audience_id = 56 # Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
|
|
898
|
+
body = TalonOne::UpdateAudience.new # UpdateAudience |
|
|
664
899
|
|
|
665
900
|
begin
|
|
666
|
-
#Update
|
|
667
|
-
result = api_instance.
|
|
901
|
+
#Update audience
|
|
902
|
+
result = api_instance.update_audience_v2(audience_id, body)
|
|
668
903
|
p result
|
|
669
904
|
rescue TalonOne::ApiError => e
|
|
670
|
-
puts "Exception when calling IntegrationApi->
|
|
905
|
+
puts "Exception when calling IntegrationApi->update_audience_v2: #{e}"
|
|
671
906
|
end
|
|
672
907
|
```
|
|
673
908
|
|
|
@@ -676,14 +911,12 @@ end
|
|
|
676
911
|
|
|
677
912
|
Name | Type | Description | Notes
|
|
678
913
|
------------- | ------------- | ------------- | -------------
|
|
679
|
-
**
|
|
680
|
-
**body** | [**
|
|
681
|
-
**run_rule_engine** | **Boolean**| Indicates whether to run the rule engine. | [optional] [default to false]
|
|
682
|
-
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`. | [optional]
|
|
914
|
+
**audience_id** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
|
|
915
|
+
**body** | [**UpdateAudience**](UpdateAudience.md)| |
|
|
683
916
|
|
|
684
917
|
### Return type
|
|
685
918
|
|
|
686
|
-
[**
|
|
919
|
+
[**Audience**](Audience.md)
|
|
687
920
|
|
|
688
921
|
### Authorization
|
|
689
922
|
|
|
@@ -695,13 +928,13 @@ Name | Type | Description | Notes
|
|
|
695
928
|
- **Accept**: application/json
|
|
696
929
|
|
|
697
930
|
|
|
698
|
-
##
|
|
931
|
+
## update_customer_profile_audiences
|
|
699
932
|
|
|
700
|
-
>
|
|
933
|
+
> update_customer_profile_audiences(body)
|
|
701
934
|
|
|
702
|
-
Update multiple
|
|
935
|
+
Update multiple customer profiles' audiences
|
|
703
936
|
|
|
704
|
-
Update
|
|
937
|
+
Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000.
|
|
705
938
|
|
|
706
939
|
### Example
|
|
707
940
|
|
|
@@ -717,17 +950,72 @@ TalonOne.configure do |config|
|
|
|
717
950
|
end
|
|
718
951
|
|
|
719
952
|
api_instance = TalonOne::IntegrationApi.new
|
|
720
|
-
body = TalonOne::
|
|
953
|
+
body = TalonOne::CustomerProfileAudienceRequest.new # CustomerProfileAudienceRequest |
|
|
954
|
+
|
|
955
|
+
begin
|
|
956
|
+
#Update multiple customer profiles' audiences
|
|
957
|
+
api_instance.update_customer_profile_audiences(body)
|
|
958
|
+
rescue TalonOne::ApiError => e
|
|
959
|
+
puts "Exception when calling IntegrationApi->update_customer_profile_audiences: #{e}"
|
|
960
|
+
end
|
|
961
|
+
```
|
|
962
|
+
|
|
963
|
+
### Parameters
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
Name | Type | Description | Notes
|
|
967
|
+
------------- | ------------- | ------------- | -------------
|
|
968
|
+
**body** | [**CustomerProfileAudienceRequest**](CustomerProfileAudienceRequest.md)| |
|
|
969
|
+
|
|
970
|
+
### Return type
|
|
971
|
+
|
|
972
|
+
nil (empty response body)
|
|
973
|
+
|
|
974
|
+
### Authorization
|
|
975
|
+
|
|
976
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
977
|
+
|
|
978
|
+
### HTTP request headers
|
|
979
|
+
|
|
980
|
+
- **Content-Type**: application/json
|
|
981
|
+
- **Accept**: application/json
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
## update_customer_profile_v2
|
|
985
|
+
|
|
986
|
+
> IntegrationStateV2 update_customer_profile_v2(integration_id, body, opts)
|
|
987
|
+
|
|
988
|
+
Update customer profile
|
|
989
|
+
|
|
990
|
+
Update (or create) a [Customer Profile](/docs/dev/concepts/entities#customer-profile). **Performance tips** Updating a customer profile returns a response with the requested integration state. You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. You can also set `runRuleEngine` to `false` to prevent unwanted rule executions. This allows you to improve response times. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects.
|
|
991
|
+
|
|
992
|
+
### Example
|
|
993
|
+
|
|
994
|
+
```ruby
|
|
995
|
+
# load the gem
|
|
996
|
+
require 'talon_one'
|
|
997
|
+
# setup authorization
|
|
998
|
+
TalonOne.configure do |config|
|
|
999
|
+
# Configure API key authorization: api_key_v1
|
|
1000
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1001
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1002
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1003
|
+
end
|
|
1004
|
+
|
|
1005
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
1006
|
+
integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
|
1007
|
+
body = TalonOne::CustomerProfileIntegrationRequestV2.new # CustomerProfileIntegrationRequestV2 |
|
|
721
1008
|
opts = {
|
|
722
|
-
|
|
1009
|
+
run_rule_engine: false, # Boolean | Indicates whether to run the rule engine. Setting this property to `false` improves response times.
|
|
1010
|
+
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`.
|
|
723
1011
|
}
|
|
724
1012
|
|
|
725
1013
|
begin
|
|
726
|
-
#Update
|
|
727
|
-
result = api_instance.
|
|
1014
|
+
#Update customer profile
|
|
1015
|
+
result = api_instance.update_customer_profile_v2(integration_id, body, opts)
|
|
728
1016
|
p result
|
|
729
1017
|
rescue TalonOne::ApiError => e
|
|
730
|
-
puts "Exception when calling IntegrationApi->
|
|
1018
|
+
puts "Exception when calling IntegrationApi->update_customer_profile_v2: #{e}"
|
|
731
1019
|
end
|
|
732
1020
|
```
|
|
733
1021
|
|
|
@@ -736,12 +1024,14 @@ end
|
|
|
736
1024
|
|
|
737
1025
|
Name | Type | Description | Notes
|
|
738
1026
|
------------- | ------------- | ------------- | -------------
|
|
739
|
-
**
|
|
740
|
-
**
|
|
1027
|
+
**integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
|
|
1028
|
+
**body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md)| |
|
|
1029
|
+
**run_rule_engine** | **Boolean**| Indicates whether to run the rule engine. Setting this property to `false` improves response times. | [optional] [default to false]
|
|
1030
|
+
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`. | [optional]
|
|
741
1031
|
|
|
742
1032
|
### Return type
|
|
743
1033
|
|
|
744
|
-
[**
|
|
1034
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
|
745
1035
|
|
|
746
1036
|
### Authorization
|
|
747
1037
|
|
|
@@ -753,13 +1043,13 @@ Name | Type | Description | Notes
|
|
|
753
1043
|
- **Accept**: application/json
|
|
754
1044
|
|
|
755
1045
|
|
|
756
|
-
##
|
|
1046
|
+
## update_customer_profiles_v2
|
|
757
1047
|
|
|
758
|
-
>
|
|
1048
|
+
> MultipleCustomerProfileIntegrationResponseV2 update_customer_profiles_v2(body, opts)
|
|
759
1049
|
|
|
760
|
-
Update
|
|
1050
|
+
Update multiple customer profiles
|
|
761
1051
|
|
|
762
|
-
|
|
1052
|
+
Update (or create) up to 1000 [customer profiles](/docs/dev/concepts/entities#customer-profile) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](/integration-api/#tag/Customer-sessions).
|
|
763
1053
|
|
|
764
1054
|
### Example
|
|
765
1055
|
|
|
@@ -772,26 +1062,20 @@ TalonOne.configure do |config|
|
|
|
772
1062
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
773
1063
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
774
1064
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
775
|
-
|
|
776
|
-
# Configure API key authorization: integration_auth
|
|
777
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
778
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
779
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
780
1065
|
end
|
|
781
1066
|
|
|
782
1067
|
api_instance = TalonOne::IntegrationApi.new
|
|
783
|
-
|
|
784
|
-
body = TalonOne::NewCustomerSession.new # NewCustomerSession |
|
|
1068
|
+
body = TalonOne::MultipleCustomerProfileIntegrationRequest.new # MultipleCustomerProfileIntegrationRequest |
|
|
785
1069
|
opts = {
|
|
786
|
-
|
|
1070
|
+
silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information.
|
|
787
1071
|
}
|
|
788
1072
|
|
|
789
1073
|
begin
|
|
790
|
-
#Update
|
|
791
|
-
result = api_instance.
|
|
1074
|
+
#Update multiple customer profiles
|
|
1075
|
+
result = api_instance.update_customer_profiles_v2(body, opts)
|
|
792
1076
|
p result
|
|
793
1077
|
rescue TalonOne::ApiError => e
|
|
794
|
-
puts "Exception when calling IntegrationApi->
|
|
1078
|
+
puts "Exception when calling IntegrationApi->update_customer_profiles_v2: #{e}"
|
|
795
1079
|
end
|
|
796
1080
|
```
|
|
797
1081
|
|
|
@@ -800,17 +1084,16 @@ end
|
|
|
800
1084
|
|
|
801
1085
|
Name | Type | Description | Notes
|
|
802
1086
|
------------- | ------------- | ------------- | -------------
|
|
803
|
-
**
|
|
804
|
-
**
|
|
805
|
-
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
1087
|
+
**body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md)| |
|
|
1088
|
+
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. | [optional] [default to 'yes']
|
|
806
1089
|
|
|
807
1090
|
### Return type
|
|
808
1091
|
|
|
809
|
-
[**
|
|
1092
|
+
[**MultipleCustomerProfileIntegrationResponseV2**](MultipleCustomerProfileIntegrationResponseV2.md)
|
|
810
1093
|
|
|
811
1094
|
### Authorization
|
|
812
1095
|
|
|
813
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
1096
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
814
1097
|
|
|
815
1098
|
### HTTP request headers
|
|
816
1099
|
|
|
@@ -822,9 +1105,9 @@ Name | Type | Description | Notes
|
|
|
822
1105
|
|
|
823
1106
|
> IntegrationStateV2 update_customer_session_v2(customer_session_id, body, opts)
|
|
824
1107
|
|
|
825
|
-
Update
|
|
1108
|
+
Update customer session
|
|
826
1109
|
|
|
827
|
-
Update
|
|
1110
|
+
Update or create a [customer session](/docs/dev/concepts/entities#customer-session). For example, use this endpoint to share the content of a customer's cart with Talon.One and to check which promotion rules apply. **Note:** The currency for the session and the cart items in the session is the same as the Application that owns this session. **Session management** The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same Application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. See more information and tips about session management in the [documentation](/docs/dev/concepts/entities#customer-session). **Sessions and customer profiles** - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. **Performance tips** Updating a customer session returns a response with the requested integration state. You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. For more information, see the [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
|
|
828
1111
|
|
|
829
1112
|
### Example
|
|
830
1113
|
|
|
@@ -840,14 +1123,14 @@ TalonOne.configure do |config|
|
|
|
840
1123
|
end
|
|
841
1124
|
|
|
842
1125
|
api_instance = TalonOne::IntegrationApi.new
|
|
843
|
-
customer_session_id = 'customer_session_id_example' # String | The
|
|
1126
|
+
customer_session_id = 'customer_session_id_example' # String | The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions).
|
|
844
1127
|
body = TalonOne::IntegrationRequest.new # IntegrationRequest |
|
|
845
1128
|
opts = {
|
|
846
1129
|
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
847
1130
|
}
|
|
848
1131
|
|
|
849
1132
|
begin
|
|
850
|
-
#Update
|
|
1133
|
+
#Update customer session
|
|
851
1134
|
result = api_instance.update_customer_session_v2(customer_session_id, body, opts)
|
|
852
1135
|
p result
|
|
853
1136
|
rescue TalonOne::ApiError => e
|
|
@@ -860,7 +1143,7 @@ end
|
|
|
860
1143
|
|
|
861
1144
|
Name | Type | Description | Notes
|
|
862
1145
|
------------- | ------------- | ------------- | -------------
|
|
863
|
-
**customer_session_id** | **String**| The
|
|
1146
|
+
**customer_session_id** | **String**| The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). |
|
|
864
1147
|
**body** | [**IntegrationRequest**](IntegrationRequest.md)| |
|
|
865
1148
|
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
866
1149
|
|