talon_one 2.5.1 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +164 -56
- data/docs/AcceptCouponEffectProps.md +1 -1
- data/docs/AcceptReferralEffectProps.md +1 -1
- data/docs/AccessLogEntry.md +15 -10
- data/docs/Account.md +6 -6
- data/docs/AccountAdditionalCost.md +10 -10
- data/docs/AccountAnalytics.md +19 -19
- data/docs/AccountDashboardStatistic.md +27 -0
- data/docs/AccountDashboardStatisticApiCalls.md +19 -0
- data/docs/AccountDashboardStatisticCampaigns.md +19 -0
- data/docs/AccountDashboardStatisticDiscount.md +21 -0
- data/docs/AccountDashboardStatisticLoyaltyPoints.md +19 -0
- data/docs/AccountDashboardStatisticReferrals.md +19 -0
- data/docs/AccountDashboardStatisticRevenue.md +21 -0
- data/docs/AccountLimits.md +12 -12
- data/docs/AddFreeItemEffectProps.md +2 -2
- data/docs/AddItemCatalogAction.md +23 -0
- data/docs/AddLoyaltyPoints.md +31 -0
- data/docs/AddLoyaltyPointsEffectProps.md +8 -4
- data/docs/AddedDeductedPointsNotificationPolicy.md +19 -0
- data/docs/Application.md +13 -13
- data/docs/ApplicationAPIKey.md +7 -7
- data/docs/ApplicationApiHealth.md +2 -2
- data/docs/ApplicationCampaignStats.md +6 -6
- data/docs/ApplicationCustomer.md +9 -7
- data/docs/ApplicationEvent.md +3 -3
- data/docs/ApplicationReferee.md +4 -4
- data/docs/ApplicationSession.md +5 -5
- data/docs/ApplicationSessionEntity.md +1 -1
- data/docs/Attribute.md +17 -13
- data/docs/Audience.md +14 -6
- data/docs/AudienceAnalytics.md +19 -0
- data/docs/AudienceCustomer.md +41 -0
- data/docs/AudienceIntegrationID.md +17 -0
- data/docs/AudienceMembership.md +2 -2
- data/docs/AwardGiveawayEffectProps.md +5 -5
- data/docs/BaseLoyaltyProgram.md +7 -5
- data/docs/BaseNotification.md +21 -0
- data/docs/BaseNotificationEntity.md +17 -0
- data/docs/BaseNotificationWebhook.md +25 -0
- data/docs/BaseNotifications.md +17 -0
- data/docs/BaseSamlConnection.md +1 -1
- data/docs/BulkApplicationNotification.md +1 -1
- data/docs/BulkCampaignNotification.md +1 -1
- data/docs/Campaign.md +27 -25
- data/docs/CampaignActivationRequest.md +17 -0
- data/docs/CampaignAnalytics.md +8 -8
- data/docs/CampaignCollection.md +3 -3
- data/docs/CampaignCollectionWithoutPayload.md +3 -3
- data/docs/CampaignCopy.md +8 -8
- data/docs/CampaignCreatedNotification.md +5 -1
- data/docs/CampaignDeletedNotification.md +3 -1
- data/docs/CampaignEditedNotification.md +3 -1
- data/docs/CampaignGroup.md +8 -8
- data/docs/CampaignNotification.md +1 -1
- data/docs/CampaignPrioritiesChangedNotification.md +4 -4
- data/docs/CampaignRulesetChangedNotification.md +1 -1
- data/docs/CampaignSearch.md +1 -1
- data/docs/CampaignSet.md +7 -5
- data/docs/CampaignSetBranchNode.md +6 -6
- data/docs/CampaignSetIDs.md +1 -1
- data/docs/CampaignSetLeafNode.md +1 -1
- data/docs/CampaignSetNode.md +1 -1
- data/docs/CampaignSetV2.md +4 -4
- data/docs/CampaignStateChangedNotification.md +4 -2
- data/docs/CampaignTemplate.md +23 -21
- data/docs/CampaignTemplateParams.md +5 -3
- data/docs/CardLedgerTransactionLogEntry.md +41 -0
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +41 -0
- data/docs/CartItem.md +15 -13
- data/docs/Catalog.md +8 -8
- data/docs/CatalogAction.md +19 -0
- data/docs/CatalogActionFilter.md +21 -0
- data/docs/CatalogItem.md +29 -0
- data/docs/CatalogSyncRequest.md +19 -0
- data/docs/CatalogsStrikethroughNotificationPolicy.md +17 -0
- data/docs/Change.md +10 -8
- data/docs/ChangeProfilePassword.md +2 -2
- data/docs/CodeGeneratorSettings.md +2 -2
- data/docs/Collection.md +3 -3
- data/docs/CollectionItem.md +17 -0
- data/docs/CollectionWithoutPayload.md +3 -3
- data/docs/Coupon.md +18 -12
- data/docs/CouponConstraints.md +6 -4
- data/docs/CouponCreatedEffectProps.md +2 -2
- data/docs/CouponCreationJob.md +16 -14
- data/docs/CouponReservations.md +2 -2
- data/docs/CouponSearch.md +1 -1
- data/docs/CouponsNotificationPolicy.md +19 -0
- data/docs/CreateApplicationAPIKey.md +2 -2
- data/docs/CreateManagementKey.md +23 -0
- data/docs/CreateTemplateCampaign.md +2 -0
- data/docs/CustomEffect.md +8 -6
- data/docs/CustomEffectProps.md +11 -3
- data/docs/CustomerActivityReport.md +2 -2
- data/docs/CustomerAnalytics.md +7 -7
- data/docs/CustomerProfile.md +10 -8
- data/docs/CustomerProfileIntegrationRequestV2.md +4 -2
- data/docs/CustomerProfileUpdateV2Response.md +17 -0
- data/docs/CustomerSession.md +10 -10
- data/docs/CustomerSessionV2.md +17 -15
- data/docs/DeductLoyaltyPoints.md +23 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +7 -7
- data/docs/Effect.md +9 -7
- data/docs/EffectEntity.md +9 -7
- data/docs/Endpoint.md +17 -0
- data/docs/Entity.md +2 -2
- data/docs/EntityWithTalangVisibleID.md +2 -2
- data/docs/Environment.md +3 -3
- data/docs/ErrorSource.md +1 -1
- data/docs/EvaluableCampaignIds.md +17 -0
- data/docs/Event.md +6 -6
- data/docs/EventType.md +8 -8
- data/docs/EventV2.md +6 -4
- data/docs/ExpiringPointsNotificationPolicy.md +19 -0
- data/docs/ExpiringPointsNotificationTrigger.md +19 -0
- data/docs/Export.md +5 -5
- data/docs/FeatureFlag.md +7 -7
- data/docs/FeedNotification.md +6 -6
- data/docs/FrontendState.md +16 -0
- data/docs/Giveaway.md +10 -6
- data/docs/GiveawaysPool.md +8 -6
- data/docs/Import.md +4 -4
- data/docs/ImportEntity.md +1 -1
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +3 -3
- data/docs/InlineResponse20012.md +3 -3
- data/docs/InlineResponse20013.md +3 -5
- data/docs/InlineResponse20014.md +4 -2
- data/docs/InlineResponse20015.md +1 -1
- data/docs/InlineResponse20016.md +4 -2
- data/docs/InlineResponse20017.md +2 -2
- data/docs/InlineResponse20018.md +3 -3
- data/docs/InlineResponse20019.md +2 -2
- data/docs/InlineResponse2002.md +2 -2
- data/docs/InlineResponse20020.md +4 -4
- data/docs/InlineResponse20021.md +3 -3
- data/docs/InlineResponse20022.md +5 -3
- data/docs/InlineResponse20023.md +3 -3
- data/docs/InlineResponse20024.md +3 -3
- data/docs/InlineResponse20025.md +3 -3
- data/docs/InlineResponse20026.md +3 -3
- data/docs/InlineResponse20027.md +2 -2
- data/docs/InlineResponse20028.md +5 -3
- data/docs/InlineResponse20029.md +4 -4
- data/docs/InlineResponse2003.md +2 -2
- data/docs/InlineResponse20030.md +2 -2
- data/docs/InlineResponse20031.md +2 -2
- data/docs/InlineResponse20032.md +19 -0
- data/docs/InlineResponse20033.md +19 -0
- data/docs/InlineResponse20034.md +19 -0
- data/docs/InlineResponse20035.md +19 -0
- data/docs/InlineResponse20036.md +19 -0
- data/docs/InlineResponse20037.md +21 -0
- data/docs/InlineResponse20038.md +19 -0
- data/docs/InlineResponse20039.md +19 -0
- data/docs/InlineResponse2004.md +2 -2
- data/docs/InlineResponse2005.md +3 -3
- data/docs/InlineResponse2006.md +3 -3
- data/docs/InlineResponse2007.md +3 -3
- data/docs/InlineResponse2008.md +3 -5
- data/docs/InlineResponse2009.md +3 -5
- data/docs/InlineResponse201.md +1 -1
- data/docs/IntegrationApi.md +516 -87
- data/docs/IntegrationCoupon.md +59 -0
- data/docs/IntegrationCustomerSessionResponse.md +3 -1
- data/docs/IntegrationEntity.md +2 -2
- data/docs/IntegrationEvent.md +2 -2
- data/docs/IntegrationEventV2Request.md +6 -4
- data/docs/IntegrationProfileEntity.md +1 -1
- data/docs/IntegrationRequest.md +1 -1
- data/docs/IntegrationStateV2.md +2 -2
- data/docs/InventoryCoupon.md +18 -12
- data/docs/InventoryReferral.md +6 -6
- data/docs/ItemAttribute.md +21 -0
- data/docs/LedgerEntry.md +12 -12
- data/docs/LedgerInfo.md +12 -12
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +39 -0
- data/docs/LimitCounter.md +9 -9
- data/docs/LoyaltyBalance.md +23 -0
- data/docs/LoyaltyBalances.md +19 -0
- data/docs/LoyaltyCard.md +13 -9
- data/docs/LoyaltyCardProfileRegistration.md +3 -3
- data/docs/LoyaltyCardRegistration.md +1 -1
- data/docs/LoyaltyDashboardData.md +6 -6
- data/docs/LoyaltyDashboardPointsBreakdown.md +2 -2
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyLedgerEntry.md +17 -15
- data/docs/LoyaltyLedgerTransactions.md +19 -0
- data/docs/LoyaltyProgram.md +8 -6
- data/docs/LoyaltyProgramBalance.md +11 -9
- data/docs/LoyaltyProgramLedgers.md +4 -4
- data/docs/LoyaltyProgramTransaction.md +49 -0
- data/docs/LoyaltyStatistics.md +6 -6
- data/docs/LoyaltySubLedger.md +1 -1
- data/docs/LoyaltyTier.md +3 -3
- data/docs/ManagementApi.md +2620 -735
- data/docs/ManagementKey.md +31 -0
- data/docs/ModelReturn.md +3 -3
- data/docs/MultipleAudiences.md +19 -0
- data/docs/MultipleAudiencesItem.md +25 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +2 -2
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +1 -1
- data/docs/MultipleNewAudiences.md +17 -0
- data/docs/MutableEntity.md +1 -1
- data/docs/NewAdditionalCost.md +8 -8
- data/docs/NewApplication.md +10 -10
- data/docs/NewApplicationAPIKey.md +8 -8
- data/docs/NewAttribute.md +15 -11
- data/docs/NewAudience.md +12 -4
- data/docs/NewBaseNotification.md +19 -0
- data/docs/NewCampaign.md +6 -6
- data/docs/NewCampaignGroup.md +5 -5
- data/docs/NewCampaignSet.md +2 -2
- data/docs/NewCampaignSetV2.md +2 -2
- data/docs/NewCampaignTemplate.md +7 -5
- data/docs/NewCatalog.md +5 -5
- data/docs/NewCouponCreationJob.md +8 -6
- data/docs/NewCoupons.md +14 -10
- data/docs/NewCouponsForMultipleRecipients.md +12 -10
- data/docs/NewCustomEffect.md +3 -1
- data/docs/NewCustomerProfile.md +1 -1
- data/docs/NewCustomerSession.md +6 -6
- data/docs/NewCustomerSessionV2.md +7 -5
- data/docs/NewEvent.md +2 -2
- data/docs/NewEventType.md +6 -6
- data/docs/NewGiveawaysPool.md +6 -4
- data/docs/NewInternalAudience.md +21 -0
- data/docs/NewInvitation.md +4 -4
- data/docs/NewLoyaltyProgram.md +7 -5
- data/docs/NewLoyaltyTier.md +1 -1
- data/docs/NewManagementKey.md +33 -0
- data/docs/NewMultipleAudiencesItem.md +19 -0
- data/docs/NewNotificationWebhook.md +4 -4
- data/docs/NewPassword.md +2 -2
- data/docs/NewPicklist.md +19 -0
- data/docs/NewReferral.md +3 -3
- data/docs/NewReferralsForMultipleAdvocates.md +4 -4
- data/docs/NewReturn.md +1 -1
- data/docs/NewRole.md +8 -8
- data/docs/NewRuleset.md +3 -1
- data/docs/NewSamlConnection.md +1 -1
- data/docs/NewWebhook.md +16 -14
- data/docs/Notification.md +3 -3
- data/docs/NotificationWebhook.md +7 -7
- data/docs/OutgoingIntegrationBrazePolicy.md +19 -0
- data/docs/OutgoingIntegrationConfiguration.md +21 -0
- data/docs/OutgoingIntegrationType.md +25 -0
- data/docs/OutgoingIntegrationTypes.md +17 -0
- data/docs/OutgoingIntegrationWebhookTemplate.md +27 -0
- data/docs/OutgoingIntegrationWebhookTemplates.md +17 -0
- data/docs/PatchItemCatalogAction.md +23 -0
- data/docs/PatchManyItemsCatalogAction.md +21 -0
- data/docs/Picklist.md +31 -0
- data/docs/PriorityPosition.md +19 -0
- data/docs/ProfileAudiencesChanges.md +2 -2
- data/docs/RedeemReferralEffectProps.md +2 -2
- data/docs/Referral.md +6 -6
- data/docs/ReferralConstraints.md +1 -1
- data/docs/ReferralCreatedEffectProps.md +1 -1
- data/docs/ReferralRejectionReason.md +1 -1
- data/docs/RejectCouponEffectProps.md +5 -5
- data/docs/RejectReferralEffectProps.md +5 -5
- data/docs/RemoveItemCatalogAction.md +17 -0
- data/docs/RemoveManyItemsCatalogAction.md +17 -0
- data/docs/ReserveCouponEffectProps.md +21 -0
- data/docs/ReturnIntegrationRequest.md +1 -1
- data/docs/ReturnedCartItem.md +1 -1
- data/docs/Role.md +13 -13
- data/docs/RoleAssign.md +4 -4
- data/docs/RoleMembership.md +2 -2
- data/docs/RoleV2.md +25 -0
- data/docs/RoleV2ApplicationDetails.md +21 -0
- data/docs/RoleV2PermissionSet.md +19 -0
- data/docs/RoleV2Permissions.md +19 -0
- data/docs/RoleV2PermissionsRoles.md +21 -0
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +8 -8
- data/docs/RollbackCouponEffectProps.md +1 -1
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +10 -10
- data/docs/RollbackDiscountEffectProps.md +3 -3
- data/docs/RollbackReferralEffectProps.md +1 -1
- data/docs/Rule.md +5 -1
- data/docs/RuleFailureReason.md +12 -12
- data/docs/Ruleset.md +7 -5
- data/docs/SamlConnection.md +3 -3
- data/docs/Session.md +2 -2
- data/docs/SetDiscountEffectProps.md +4 -4
- data/docs/SetDiscountPerAdditionalCostEffectProps.md +5 -5
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +5 -5
- data/docs/SetDiscountPerItemEffectProps.md +9 -5
- data/docs/ShowBundleMetadataEffectProps.md +3 -3
- data/docs/ShowNotificationEffectProps.md +3 -3
- data/docs/StrikethroughChangedItem.md +29 -0
- data/docs/StrikethroughEffect.md +27 -0
- data/docs/StrikethroughLabelingNotification.md +25 -0
- data/docs/StrikethroughSetDiscountPerItemEffectProps.md +19 -0
- data/docs/StrikethroughTrigger.md +25 -0
- data/docs/TalangAttribute.md +33 -0
- data/docs/TalangAttributeVisibility.md +19 -0
- data/docs/TemplateArgDef.md +5 -1
- data/docs/TemplateDef.md +2 -2
- data/docs/Tier.md +2 -2
- data/docs/TransferLoyaltyCard.md +17 -0
- data/docs/TriggerWebhookEffectProps.md +2 -2
- data/docs/UpdateAccount.md +2 -2
- data/docs/UpdateApplication.md +9 -9
- data/docs/UpdateAttributeEffectProps.md +2 -2
- data/docs/UpdateAudience.md +1 -1
- data/docs/UpdateCampaign.md +12 -12
- data/docs/UpdateCampaignGroup.md +5 -5
- data/docs/UpdateCampaignTemplate.md +16 -14
- data/docs/UpdateCatalog.md +2 -2
- data/docs/UpdateCoupon.md +12 -8
- data/docs/UpdateCouponBatch.md +7 -5
- data/docs/UpdateCustomEffect.md +3 -1
- data/docs/UpdateLoyaltyCard.md +2 -2
- data/docs/UpdateLoyaltyProgram.md +7 -5
- data/docs/UpdatePicklist.md +19 -0
- data/docs/UpdateReferral.md +3 -3
- data/docs/UpdateReferralBatch.md +2 -2
- data/docs/UpdateRole.md +8 -8
- data/docs/UpdateUser.md +7 -7
- data/docs/UpdateUserLatestFeedTimestamp.md +1 -1
- data/docs/User.md +5 -5
- data/docs/UserEntity.md +2 -2
- data/docs/UserFeedNotifications.md +2 -2
- data/docs/Webhook.md +19 -17
- data/docs/WebhookActivationLogEntry.md +9 -9
- data/docs/WebhookLogEntry.md +18 -15
- data/docs/WillAwardGiveawayEffectProps.md +3 -3
- data/lib/talon_one/api/integration_api.rb +640 -99
- data/lib/talon_one/api/management_api.rb +2413 -780
- data/lib/talon_one/api_client.rb +2 -2
- data/lib/talon_one/api_error.rb +2 -2
- data/lib/talon_one/configuration.rb +12 -5
- data/lib/talon_one/models/accept_coupon_effect_props.rb +3 -3
- data/lib/talon_one/models/accept_referral_effect_props.rb +3 -3
- data/lib/talon_one/models/access_log_entry.rb +6 -6
- data/lib/talon_one/models/account.rb +8 -8
- data/lib/talon_one/models/account_additional_cost.rb +7 -7
- data/lib/talon_one/models/account_analytics.rb +21 -21
- data/lib/talon_one/models/account_dashboard_statistic.rb +271 -0
- data/lib/talon_one/models/account_dashboard_statistic_api_calls.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_campaigns.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_discount.rb +242 -0
- data/lib/talon_one/models/account_dashboard_statistic_loyalty_points.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_referrals.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_revenue.rb +242 -0
- data/lib/talon_one/models/account_entity.rb +2 -2
- data/lib/talon_one/models/account_limits.rb +14 -14
- data/lib/talon_one/models/add_free_item_effect_props.rb +4 -4
- data/lib/talon_one/models/add_item_catalog_action.rb +245 -0
- data/lib/talon_one/models/add_loyalty_points.rb +311 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +43 -8
- data/lib/talon_one/models/added_deducted_points_notification_policy.rb +269 -0
- data/lib/talon_one/models/additional_cost.rb +2 -2
- data/lib/talon_one/models/api_error.rb +2 -2
- data/lib/talon_one/models/application.rb +7 -7
- data/lib/talon_one/models/application_api_health.rb +5 -5
- data/lib/talon_one/models/application_api_key.rb +11 -11
- data/lib/talon_one/models/application_campaign_stats.rb +9 -9
- data/lib/talon_one/models/application_customer.rb +20 -10
- data/lib/talon_one/models/application_customer_entity.rb +2 -2
- data/lib/talon_one/models/application_entity.rb +2 -2
- data/lib/talon_one/models/application_event.rb +5 -5
- data/lib/talon_one/models/application_notification.rb +2 -2
- data/lib/talon_one/models/application_referee.rb +6 -6
- data/lib/talon_one/models/application_session.rb +7 -7
- data/lib/talon_one/models/application_session_entity.rb +2 -2
- data/lib/talon_one/models/async_coupon_creation_response.rb +2 -2
- data/lib/talon_one/models/attribute.rb +30 -6
- data/lib/talon_one/models/attributes_mandatory.rb +2 -2
- data/lib/talon_one/models/attributes_settings.rb +2 -2
- data/lib/talon_one/models/audience.rb +50 -10
- data/lib/talon_one/models/audience_analytics.rb +218 -0
- data/lib/talon_one/models/audience_customer.rb +395 -0
- data/lib/talon_one/models/{loyalty_projection_data.rb → audience_integration_id.rb} +33 -59
- data/lib/talon_one/models/audience_membership.rb +2 -2
- data/lib/talon_one/models/award_giveaway_effect_props.rb +2 -2
- data/lib/talon_one/models/base_loyalty_program.rb +19 -9
- data/lib/talon_one/models/base_notification.rb +260 -0
- data/lib/talon_one/models/base_notification_entity.rb +211 -0
- data/lib/talon_one/models/base_notification_webhook.rb +275 -0
- data/lib/talon_one/models/base_notifications.rb +209 -0
- data/lib/talon_one/models/base_saml_connection.rb +2 -2
- data/lib/talon_one/models/binding.rb +2 -2
- data/lib/talon_one/models/bulk_application_notification.rb +2 -2
- data/lib/talon_one/models/bulk_campaign_notification.rb +2 -2
- data/lib/talon_one/models/campaign.rb +18 -8
- data/lib/talon_one/models/campaign_activation_request.rb +214 -0
- data/lib/talon_one/models/campaign_analytics.rb +2 -2
- data/lib/talon_one/models/campaign_collection.rb +5 -5
- data/lib/talon_one/models/campaign_collection_without_payload.rb +5 -5
- data/lib/talon_one/models/campaign_copy.rb +4 -4
- data/lib/talon_one/models/campaign_created_notification.rb +29 -6
- data/lib/talon_one/models/campaign_deleted_notification.rb +21 -6
- data/lib/talon_one/models/campaign_edited_notification.rb +15 -6
- data/lib/talon_one/models/campaign_entity.rb +2 -2
- data/lib/talon_one/models/campaign_group.rb +7 -7
- data/lib/talon_one/models/campaign_group_entity.rb +2 -2
- data/lib/talon_one/models/campaign_notification.rb +2 -2
- data/lib/talon_one/models/campaign_priorities_changed_notification.rb +17 -22
- data/lib/talon_one/models/campaign_priorities_v2.rb +2 -2
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +2 -7
- data/lib/talon_one/models/campaign_search.rb +3 -3
- data/lib/talon_one/models/campaign_set.rb +19 -9
- data/lib/talon_one/models/campaign_set_branch_node.rb +5 -5
- data/lib/talon_one/models/campaign_set_i_ds.rb +2 -2
- data/lib/talon_one/models/campaign_set_leaf_node.rb +3 -3
- data/lib/talon_one/models/campaign_set_node.rb +2 -2
- data/lib/talon_one/models/campaign_set_v2.rb +5 -5
- data/lib/talon_one/models/campaign_state_changed_notification.rb +15 -6
- data/lib/talon_one/models/campaign_template.rb +25 -15
- data/lib/talon_one/models/campaign_template_collection.rb +2 -2
- data/lib/talon_one/models/campaign_template_params.rb +16 -6
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +508 -0
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +508 -0
- data/lib/talon_one/models/cart_item.rb +28 -47
- data/lib/talon_one/models/catalog.rb +7 -7
- data/lib/talon_one/models/catalog_action.rb +261 -0
- data/lib/talon_one/models/catalog_action_filter.rb +277 -0
- data/lib/talon_one/models/catalog_item.rb +313 -0
- data/lib/talon_one/models/catalog_sync_request.rb +238 -0
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +231 -0
- data/lib/talon_one/models/change.rb +20 -10
- data/lib/talon_one/models/change_profile_password.rb +2 -2
- data/lib/talon_one/models/code_generator_settings.rb +3 -3
- data/lib/talon_one/models/collection.rb +5 -5
- data/lib/talon_one/models/collection_item.rb +212 -0
- data/lib/talon_one/models/collection_without_payload.rb +5 -5
- data/lib/talon_one/models/coupon.rb +68 -12
- data/lib/talon_one/models/coupon_constraints.rb +39 -5
- data/lib/talon_one/models/coupon_created_effect_props.rb +4 -4
- data/lib/talon_one/models/coupon_creation_job.rb +58 -15
- data/lib/talon_one/models/coupon_limit_configs.rb +2 -2
- data/lib/talon_one/models/coupon_rejection_reason.rb +4 -4
- data/lib/talon_one/models/coupon_reservations.rb +3 -3
- data/lib/talon_one/models/coupon_search.rb +3 -3
- data/lib/talon_one/models/coupon_value.rb +2 -2
- data/lib/talon_one/models/coupons_notification_policy.rb +269 -0
- data/lib/talon_one/models/create_application_api_key.rb +6 -6
- data/lib/talon_one/models/create_management_key.rb +256 -0
- data/lib/talon_one/models/create_template_campaign.rb +15 -3
- data/lib/talon_one/models/create_template_campaign_response.rb +2 -2
- data/lib/talon_one/models/custom_effect.rb +17 -7
- data/lib/talon_one/models/custom_effect_props.rb +44 -4
- data/lib/talon_one/models/customer_activity_report.rb +5 -5
- data/lib/talon_one/models/customer_analytics.rb +10 -10
- data/lib/talon_one/models/customer_inventory.rb +2 -2
- data/lib/talon_one/models/customer_profile.rb +23 -13
- data/lib/talon_one/models/customer_profile_audience_request.rb +2 -2
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +2 -2
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +17 -5
- data/lib/talon_one/models/customer_profile_search_query.rb +2 -2
- data/lib/talon_one/models/customer_profile_update_v2_response.rb +212 -0
- data/lib/talon_one/models/customer_session.rb +8 -8
- data/lib/talon_one/models/customer_session_v2.rb +27 -15
- data/lib/talon_one/models/{loyalty_points.rb → deduct_loyalty_points.rb} +23 -33
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +23 -8
- data/lib/talon_one/models/effect.rb +20 -9
- data/lib/talon_one/models/effect_entity.rb +23 -13
- data/lib/talon_one/models/email_entity.rb +2 -2
- data/lib/talon_one/models/endpoint.rb +212 -0
- data/lib/talon_one/models/entity.rb +4 -4
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +2 -2
- data/lib/talon_one/models/environment.rb +5 -5
- data/lib/talon_one/models/error_effect_props.rb +2 -2
- data/lib/talon_one/models/error_response.rb +2 -2
- data/lib/talon_one/models/error_response_with_status.rb +2 -2
- data/lib/talon_one/models/error_source.rb +3 -3
- data/lib/talon_one/models/evaluable_campaign_ids.rb +209 -0
- data/lib/talon_one/models/event.rb +6 -6
- data/lib/talon_one/models/event_type.rb +7 -7
- data/lib/talon_one/models/event_v2.rb +18 -6
- data/lib/talon_one/models/expiring_points_notification_policy.rb +247 -0
- data/lib/talon_one/models/expiring_points_notification_trigger.rb +280 -0
- data/lib/talon_one/models/export.rb +6 -6
- data/lib/talon_one/models/feature_flag.rb +6 -6
- data/lib/talon_one/models/features_feed.rb +2 -2
- data/lib/talon_one/models/feed_notification.rb +9 -9
- data/lib/talon_one/models/frontend_state.rb +39 -0
- data/lib/talon_one/models/func_arg_def.rb +4 -4
- data/lib/talon_one/models/function_def.rb +2 -2
- data/lib/talon_one/models/giveaway.rb +28 -8
- data/lib/talon_one/models/giveaways_pool.rb +22 -7
- data/lib/talon_one/models/import.rb +5 -5
- data/lib/talon_one/models/import_entity.rb +2 -2
- data/lib/talon_one/models/inline_response200.rb +2 -2
- data/lib/talon_one/models/inline_response2001.rb +13 -13
- data/lib/talon_one/models/inline_response20010.rb +13 -13
- data/lib/talon_one/models/inline_response20011.rb +13 -13
- data/lib/talon_one/models/inline_response20012.rb +13 -13
- data/lib/talon_one/models/inline_response20013.rb +11 -13
- data/lib/talon_one/models/inline_response20014.rb +13 -9
- data/lib/talon_one/models/inline_response20015.rb +3 -3
- data/lib/talon_one/models/inline_response20016.rb +13 -9
- data/lib/talon_one/models/inline_response20017.rb +8 -3
- data/lib/talon_one/models/inline_response20018.rb +13 -13
- data/lib/talon_one/models/inline_response20019.rb +3 -3
- data/lib/talon_one/models/inline_response2002.rb +3 -3
- data/lib/talon_one/models/inline_response20020.rb +13 -13
- data/lib/talon_one/models/inline_response20021.rb +3 -13
- data/lib/talon_one/models/inline_response20022.rb +13 -9
- data/lib/talon_one/models/inline_response20023.rb +13 -13
- data/lib/talon_one/models/inline_response20024.rb +13 -13
- data/lib/talon_one/models/inline_response20025.rb +10 -15
- data/lib/talon_one/models/inline_response20026.rb +13 -13
- data/lib/talon_one/models/inline_response20027.rb +3 -3
- data/lib/talon_one/models/inline_response20028.rb +13 -9
- data/lib/talon_one/models/inline_response20029.rb +13 -13
- data/lib/talon_one/models/inline_response2003.rb +3 -3
- data/lib/talon_one/models/inline_response20030.rb +3 -3
- data/lib/talon_one/models/inline_response20031.rb +3 -3
- data/lib/talon_one/models/inline_response20032.rb +227 -0
- data/lib/talon_one/models/inline_response20033.rb +227 -0
- data/lib/talon_one/models/inline_response20034.rb +227 -0
- data/lib/talon_one/models/inline_response20035.rb +227 -0
- data/lib/talon_one/models/inline_response20036.rb +227 -0
- data/lib/talon_one/models/inline_response20037.rb +231 -0
- data/lib/talon_one/models/inline_response20038.rb +227 -0
- data/lib/talon_one/models/inline_response20039.rb +227 -0
- data/lib/talon_one/models/inline_response2004.rb +3 -3
- data/lib/talon_one/models/inline_response2005.rb +13 -13
- data/lib/talon_one/models/inline_response2006.rb +13 -13
- data/lib/talon_one/models/inline_response2007.rb +13 -13
- data/lib/talon_one/models/inline_response2008.rb +9 -13
- data/lib/talon_one/models/inline_response2009.rb +9 -13
- data/lib/talon_one/models/inline_response201.rb +2 -2
- data/lib/talon_one/models/integration_coupon.rb +569 -0
- data/lib/talon_one/models/integration_customer_session_response.rb +17 -6
- data/lib/talon_one/models/integration_entity.rb +4 -4
- data/lib/talon_one/models/integration_event.rb +3 -3
- data/lib/talon_one/models/integration_event_v2_request.rb +18 -6
- data/lib/talon_one/models/integration_profile_entity.rb +3 -3
- data/lib/talon_one/models/integration_request.rb +3 -3
- data/lib/talon_one/models/integration_state.rb +2 -2
- data/lib/talon_one/models/integration_state_v2.rb +5 -4
- data/lib/talon_one/models/inventory_coupon.rb +65 -9
- data/lib/talon_one/models/inventory_referral.rb +6 -6
- data/lib/talon_one/models/item_attribute.rb +243 -0
- data/lib/talon_one/models/ledger_entry.rb +11 -11
- data/lib/talon_one/models/ledger_info.rb +21 -20
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +474 -0
- data/lib/talon_one/models/library_attribute.rb +2 -2
- data/lib/talon_one/models/limit_config.rb +2 -2
- data/lib/talon_one/models/limit_counter.rb +4 -4
- data/lib/talon_one/models/login_params.rb +2 -2
- data/lib/talon_one/models/loyalty.rb +2 -2
- data/lib/talon_one/models/loyalty_balance.rb +238 -0
- data/lib/talon_one/models/loyalty_balances.rb +219 -0
- data/lib/talon_one/models/loyalty_card.rb +81 -12
- data/lib/talon_one/models/loyalty_card_profile_registration.rb +4 -4
- data/lib/talon_one/models/loyalty_card_registration.rb +2 -2
- data/lib/talon_one/models/loyalty_dashboard_data.rb +2 -2
- data/lib/talon_one/models/loyalty_dashboard_points_breakdown.rb +2 -2
- data/lib/talon_one/models/loyalty_ledger.rb +2 -2
- data/lib/talon_one/models/loyalty_ledger_entry.rb +18 -8
- data/lib/talon_one/models/loyalty_ledger_transactions.rb +220 -0
- data/lib/talon_one/models/loyalty_membership.rb +2 -2
- data/lib/talon_one/models/loyalty_program.rb +23 -8
- data/lib/talon_one/models/loyalty_program_balance.rb +21 -11
- data/lib/talon_one/models/loyalty_program_entity.rb +2 -2
- data/lib/talon_one/models/loyalty_program_ledgers.rb +6 -6
- data/lib/talon_one/models/loyalty_program_transaction.rb +553 -0
- data/lib/talon_one/models/loyalty_statistics.rb +2 -2
- data/lib/talon_one/models/loyalty_sub_ledger.rb +3 -3
- data/lib/talon_one/models/loyalty_tier.rb +5 -5
- data/lib/talon_one/models/management_key.rb +317 -0
- data/lib/talon_one/models/manager_config.rb +2 -2
- data/lib/talon_one/models/meta.rb +2 -2
- data/lib/talon_one/models/model_return.rb +5 -5
- data/lib/talon_one/models/multi_application_entity.rb +2 -2
- data/lib/talon_one/models/multiple_attribute.rb +2 -2
- data/lib/talon_one/models/{loyalty_projection.rb → multiple_audiences.rb} +27 -38
- data/lib/talon_one/models/multiple_audiences_item.rb +354 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +2 -2
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +4 -4
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +3 -3
- data/lib/talon_one/models/multiple_new_attribute.rb +2 -2
- data/lib/talon_one/models/multiple_new_audiences.rb +213 -0
- data/lib/talon_one/models/mutable_entity.rb +3 -3
- data/lib/talon_one/models/new_account.rb +2 -2
- data/lib/talon_one/models/new_account_sign_up.rb +2 -2
- data/lib/talon_one/models/new_additional_cost.rb +5 -5
- data/lib/talon_one/models/new_application.rb +4 -4
- data/lib/talon_one/models/new_application_api_key.rb +12 -12
- data/lib/talon_one/models/new_attribute.rb +31 -7
- data/lib/talon_one/models/new_audience.rb +49 -8
- data/lib/talon_one/models/new_base_notification.rb +226 -0
- data/lib/talon_one/models/new_campaign.rb +6 -6
- data/lib/talon_one/models/new_campaign_collection.rb +2 -2
- data/lib/talon_one/models/new_campaign_group.rb +4 -4
- data/lib/talon_one/models/new_campaign_set.rb +3 -3
- data/lib/talon_one/models/new_campaign_set_v2.rb +3 -3
- data/lib/talon_one/models/new_campaign_template.rb +20 -10
- data/lib/talon_one/models/new_catalog.rb +4 -4
- data/lib/talon_one/models/new_collection.rb +2 -2
- data/lib/talon_one/models/new_coupon_creation_job.rb +50 -7
- data/lib/talon_one/models/new_coupons.rb +57 -11
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +41 -7
- data/lib/talon_one/models/new_custom_effect.rb +14 -4
- data/lib/talon_one/models/new_customer_profile.rb +3 -3
- data/lib/talon_one/models/new_customer_session.rb +5 -5
- data/lib/talon_one/models/new_customer_session_v2.rb +21 -9
- data/lib/talon_one/models/new_event.rb +3 -3
- data/lib/talon_one/models/new_event_type.rb +5 -5
- data/lib/talon_one/models/new_giveaways_pool.rb +22 -7
- data/lib/talon_one/models/new_internal_audience.rb +251 -0
- data/lib/talon_one/models/new_invitation.rb +5 -5
- data/lib/talon_one/models/new_invite_email.rb +2 -2
- data/lib/talon_one/models/new_loyalty_program.rb +22 -7
- data/lib/talon_one/models/new_loyalty_tier.rb +4 -4
- data/lib/talon_one/models/new_management_key.rb +332 -0
- data/lib/talon_one/models/new_multiple_audiences_item.rb +266 -0
- data/lib/talon_one/models/new_notification_webhook.rb +4 -4
- data/lib/talon_one/models/new_password.rb +2 -2
- data/lib/talon_one/models/new_password_email.rb +2 -2
- data/lib/talon_one/models/new_picklist.rb +263 -0
- data/lib/talon_one/models/new_referral.rb +4 -4
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +4 -4
- data/lib/talon_one/models/new_return.rb +3 -3
- data/lib/talon_one/models/new_role.rb +6 -6
- data/lib/talon_one/models/new_ruleset.rb +15 -3
- data/lib/talon_one/models/new_saml_connection.rb +2 -2
- data/lib/talon_one/models/new_template_def.rb +2 -2
- data/lib/talon_one/models/new_user.rb +2 -2
- data/lib/talon_one/models/new_webhook.rb +9 -9
- data/lib/talon_one/models/notification.rb +5 -5
- data/lib/talon_one/models/notification_webhook.rb +7 -7
- data/lib/talon_one/models/outgoing_integration_braze_policy.rb +227 -0
- data/lib/talon_one/models/outgoing_integration_configuration.rb +241 -0
- data/lib/talon_one/models/outgoing_integration_type.rb +357 -0
- data/lib/talon_one/models/outgoing_integration_types.rb +209 -0
- data/lib/talon_one/models/outgoing_integration_webhook_template.rb +328 -0
- data/lib/talon_one/models/outgoing_integration_webhook_templates.rb +209 -0
- data/lib/talon_one/models/patch_item_catalog_action.rb +245 -0
- data/lib/talon_one/models/patch_many_items_catalog_action.rb +230 -0
- data/lib/talon_one/models/picklist.rb +339 -0
- data/lib/talon_one/models/priority_position.rb +264 -0
- data/lib/talon_one/models/profile_audiences_changes.rb +2 -2
- data/lib/talon_one/models/redeem_referral_effect_props.rb +5 -5
- data/lib/talon_one/models/referral.rb +6 -6
- data/lib/talon_one/models/referral_constraints.rb +3 -3
- data/lib/talon_one/models/referral_created_effect_props.rb +3 -3
- data/lib/talon_one/models/referral_rejection_reason.rb +4 -4
- data/lib/talon_one/models/reject_coupon_effect_props.rb +7 -7
- data/lib/talon_one/models/reject_referral_effect_props.rb +7 -7
- data/lib/talon_one/models/remove_item_catalog_action.rb +213 -0
- data/lib/talon_one/models/remove_many_items_catalog_action.rb +210 -0
- data/lib/talon_one/models/reserve_coupon_effect_props.rb +243 -0
- data/lib/talon_one/models/return_integration_request.rb +3 -3
- data/lib/talon_one/models/returned_cart_item.rb +3 -3
- data/lib/talon_one/models/role.rb +10 -10
- data/lib/talon_one/models/role_assign.rb +4 -4
- data/lib/talon_one/models/role_membership.rb +4 -4
- data/lib/talon_one/models/role_v2.rb +248 -0
- data/lib/talon_one/models/role_v2_application_details.rb +227 -0
- data/lib/talon_one/models/role_v2_permission_set.rb +228 -0
- data/lib/talon_one/models/role_v2_permissions.rb +218 -0
- data/lib/talon_one/models/role_v2_permissions_roles.rb +230 -0
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +23 -8
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +3 -3
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +25 -10
- data/lib/talon_one/models/rollback_discount_effect_props.rb +5 -5
- data/lib/talon_one/models/rollback_referral_effect_props.rb +3 -3
- data/lib/talon_one/models/rule.rb +23 -3
- data/lib/talon_one/models/rule_failure_reason.rb +14 -14
- data/lib/talon_one/models/ruleset.rb +18 -6
- data/lib/talon_one/models/saml_connection.rb +4 -4
- data/lib/talon_one/models/saml_connection_metadata.rb +2 -2
- data/lib/talon_one/models/saml_login_endpoint.rb +2 -2
- data/lib/talon_one/models/session.rb +3 -3
- data/lib/talon_one/models/set_discount_effect_props.rb +6 -6
- data/lib/talon_one/models/set_discount_per_additional_cost_effect_props.rb +7 -7
- data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +7 -7
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +30 -10
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +6 -6
- data/lib/talon_one/models/show_notification_effect_props.rb +5 -5
- data/lib/talon_one/models/slot_def.rb +2 -2
- data/lib/talon_one/models/strikethrough_changed_item.rb +318 -0
- data/lib/talon_one/models/strikethrough_effect.rb +287 -0
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +273 -0
- data/lib/talon_one/models/strikethrough_set_discount_per_item_effect_props.rb +228 -0
- data/lib/talon_one/models/strikethrough_trigger.rb +273 -0
- data/lib/talon_one/models/talang_attribute.rb +363 -0
- data/lib/talon_one/models/talang_attribute_visibility.rb +221 -0
- data/lib/talon_one/models/template_arg_def.rb +28 -8
- data/lib/talon_one/models/template_def.rb +4 -4
- data/lib/talon_one/models/template_limit_config.rb +2 -2
- data/lib/talon_one/models/tier.rb +4 -4
- data/lib/talon_one/models/transfer_loyalty_card.rb +231 -0
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +4 -4
- data/lib/talon_one/models/update_account.rb +4 -4
- data/lib/talon_one/models/update_application.rb +3 -3
- data/lib/talon_one/models/update_attribute_effect_props.rb +4 -4
- 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 +2 -2
- data/lib/talon_one/models/update_campaign_group.rb +4 -4
- data/lib/talon_one/models/update_campaign_template.rb +23 -13
- data/lib/talon_one/models/update_catalog.rb +4 -4
- data/lib/talon_one/models/update_collection.rb +2 -2
- data/lib/talon_one/models/update_coupon.rb +56 -10
- data/lib/talon_one/models/update_coupon_batch.rb +40 -6
- data/lib/talon_one/models/update_custom_effect.rb +14 -4
- data/lib/talon_one/models/update_loyalty_card.rb +3 -3
- data/lib/talon_one/models/update_loyalty_program.rb +17 -7
- data/lib/talon_one/models/update_picklist.rb +264 -0
- data/lib/talon_one/models/update_referral.rb +5 -5
- data/lib/talon_one/models/update_referral_batch.rb +4 -4
- data/lib/talon_one/models/update_role.rb +6 -6
- data/lib/talon_one/models/update_user.rb +5 -5
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +4 -4
- data/lib/talon_one/models/user.rb +7 -7
- data/lib/talon_one/models/user_entity.rb +3 -3
- data/lib/talon_one/models/user_feed_notifications.rb +5 -5
- data/lib/talon_one/models/webhook.rb +12 -12
- data/lib/talon_one/models/webhook_activation_log_entry.rb +7 -7
- data/lib/talon_one/models/webhook_log_entry.rb +8 -8
- data/lib/talon_one/models/will_award_giveaway_effect_props.rb +2 -2
- data/lib/talon_one/version.rb +3 -3
- data/lib/talon_one.rb +88 -5
- data/spec/api/integration_api_spec.rb +151 -49
- data/spec/api/management_api_spec.rb +564 -260
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +5 -5
- data/spec/models/accept_coupon_effect_props_spec.rb +2 -2
- data/spec/models/accept_referral_effect_props_spec.rb +2 -2
- data/spec/models/access_log_entry_spec.rb +2 -2
- data/spec/models/account_additional_cost_spec.rb +2 -2
- data/spec/models/account_analytics_spec.rb +2 -2
- data/spec/models/account_dashboard_statistic_api_calls_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_campaigns_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_discount_spec.rb +53 -0
- data/spec/models/account_dashboard_statistic_loyalty_points_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_referrals_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_revenue_spec.rb +53 -0
- data/spec/models/account_dashboard_statistic_spec.rb +71 -0
- data/spec/models/account_entity_spec.rb +2 -2
- data/spec/models/account_limits_spec.rb +2 -2
- data/spec/models/account_spec.rb +2 -2
- data/spec/models/add_free_item_effect_props_spec.rb +2 -2
- data/spec/models/{loyalty_projection_data_spec.rb → add_item_catalog_action_spec.rb} +12 -12
- data/spec/models/add_loyalty_points_effect_props_spec.rb +14 -2
- data/spec/models/add_loyalty_points_spec.rb +83 -0
- data/spec/models/added_deducted_points_notification_policy_spec.rb +51 -0
- data/spec/models/additional_cost_spec.rb +2 -2
- data/spec/models/api_error_spec.rb +2 -2
- data/spec/models/application_api_health_spec.rb +2 -2
- data/spec/models/application_api_key_spec.rb +3 -3
- data/spec/models/application_campaign_stats_spec.rb +2 -2
- data/spec/models/application_customer_entity_spec.rb +2 -2
- data/spec/models/application_customer_spec.rb +8 -2
- data/spec/models/application_entity_spec.rb +2 -2
- data/spec/models/application_event_spec.rb +2 -2
- data/spec/models/application_notification_spec.rb +2 -2
- data/spec/models/application_referee_spec.rb +2 -2
- data/spec/models/application_session_entity_spec.rb +2 -2
- data/spec/models/application_session_spec.rb +2 -2
- data/spec/models/application_spec.rb +2 -2
- data/spec/models/async_coupon_creation_response_spec.rb +2 -2
- data/spec/models/attribute_spec.rb +18 -2
- data/spec/models/attributes_mandatory_spec.rb +2 -2
- data/spec/models/attributes_settings_spec.rb +2 -2
- data/spec/models/audience_analytics_spec.rb +47 -0
- data/spec/models/audience_customer_spec.rb +113 -0
- data/spec/models/audience_integration_id_spec.rb +41 -0
- data/spec/models/audience_membership_spec.rb +2 -2
- data/spec/models/audience_spec.rb +26 -2
- data/spec/models/award_giveaway_effect_props_spec.rb +2 -2
- data/spec/models/base_loyalty_program_spec.rb +8 -2
- data/spec/models/base_notification_entity_spec.rb +41 -0
- data/spec/models/{loyalty_projection_spec.rb → base_notification_spec.rb} +11 -11
- data/spec/models/base_notification_webhook_spec.rb +65 -0
- data/spec/models/base_notifications_spec.rb +41 -0
- data/spec/models/base_saml_connection_spec.rb +2 -2
- data/spec/models/binding_spec.rb +2 -2
- data/spec/models/bulk_application_notification_spec.rb +2 -2
- data/spec/models/bulk_campaign_notification_spec.rb +2 -2
- data/spec/models/campaign_activation_request_spec.rb +41 -0
- data/spec/models/campaign_analytics_spec.rb +2 -2
- data/spec/models/campaign_collection_spec.rb +2 -2
- data/spec/models/campaign_collection_without_payload_spec.rb +2 -2
- data/spec/models/campaign_copy_spec.rb +2 -2
- data/spec/models/campaign_created_notification_spec.rb +14 -2
- data/spec/models/campaign_deleted_notification_spec.rb +8 -2
- data/spec/models/campaign_edited_notification_spec.rb +8 -2
- data/spec/models/campaign_entity_spec.rb +2 -2
- data/spec/models/campaign_group_entity_spec.rb +2 -2
- data/spec/models/campaign_group_spec.rb +2 -2
- data/spec/models/campaign_notification_spec.rb +2 -2
- data/spec/models/campaign_priorities_changed_notification_spec.rb +3 -3
- data/spec/models/campaign_priorities_v2_spec.rb +2 -2
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +2 -2
- data/spec/models/campaign_search_spec.rb +2 -2
- data/spec/models/campaign_set_branch_node_spec.rb +2 -2
- data/spec/models/campaign_set_i_ds_spec.rb +2 -2
- data/spec/models/campaign_set_leaf_node_spec.rb +2 -2
- data/spec/models/campaign_set_node_spec.rb +2 -2
- data/spec/models/campaign_set_spec.rb +8 -2
- data/spec/models/campaign_set_v2_spec.rb +2 -2
- data/spec/models/campaign_spec.rb +9 -3
- data/spec/models/campaign_state_changed_notification_spec.rb +8 -2
- data/spec/models/campaign_template_collection_spec.rb +2 -2
- data/spec/models/campaign_template_params_spec.rb +8 -2
- data/spec/models/campaign_template_spec.rb +9 -3
- data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +117 -0
- data/spec/models/card_ledger_transaction_log_entry_spec.rb +117 -0
- data/spec/models/cart_item_spec.rb +8 -2
- data/spec/models/catalog_action_filter_spec.rb +57 -0
- data/spec/models/catalog_action_spec.rb +51 -0
- data/spec/models/catalog_item_spec.rb +77 -0
- data/spec/models/catalog_spec.rb +2 -2
- data/spec/models/catalog_sync_request_spec.rb +47 -0
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +41 -0
- data/spec/models/change_profile_password_spec.rb +2 -2
- data/spec/models/change_spec.rb +8 -2
- data/spec/models/code_generator_settings_spec.rb +2 -2
- data/spec/models/collection_item_spec.rb +41 -0
- data/spec/models/collection_spec.rb +2 -2
- data/spec/models/collection_without_payload_spec.rb +2 -2
- data/spec/models/coupon_constraints_spec.rb +8 -2
- data/spec/models/coupon_created_effect_props_spec.rb +2 -2
- data/spec/models/coupon_creation_job_spec.rb +8 -2
- data/spec/models/coupon_limit_configs_spec.rb +2 -2
- data/spec/models/coupon_rejection_reason_spec.rb +3 -3
- data/spec/models/coupon_reservations_spec.rb +2 -2
- data/spec/models/coupon_search_spec.rb +2 -2
- data/spec/models/coupon_spec.rb +20 -2
- data/spec/models/coupon_value_spec.rb +2 -2
- data/spec/models/coupons_notification_policy_spec.rb +51 -0
- data/spec/models/create_application_api_key_spec.rb +3 -3
- data/spec/models/create_management_key_spec.rb +59 -0
- data/spec/models/create_template_campaign_response_spec.rb +2 -2
- data/spec/models/create_template_campaign_spec.rb +8 -2
- data/spec/models/custom_effect_props_spec.rb +26 -2
- data/spec/models/custom_effect_spec.rb +8 -2
- data/spec/models/customer_activity_report_spec.rb +2 -2
- data/spec/models/customer_analytics_spec.rb +2 -2
- data/spec/models/customer_inventory_spec.rb +2 -2
- data/spec/models/customer_profile_audience_request_item_spec.rb +2 -2
- data/spec/models/customer_profile_audience_request_spec.rb +2 -2
- data/spec/models/customer_profile_integration_request_v2_spec.rb +8 -2
- data/spec/models/customer_profile_search_query_spec.rb +2 -2
- data/spec/models/customer_profile_spec.rb +8 -2
- data/spec/models/customer_profile_update_v2_response_spec.rb +41 -0
- data/spec/models/customer_session_spec.rb +2 -2
- data/spec/models/customer_session_v2_spec.rb +8 -2
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +2 -2
- data/spec/models/deduct_loyalty_points_spec.rb +59 -0
- data/spec/models/effect_entity_spec.rb +8 -2
- data/spec/models/effect_spec.rb +8 -2
- data/spec/models/email_entity_spec.rb +2 -2
- data/spec/models/endpoint_spec.rb +41 -0
- data/spec/models/entity_spec.rb +2 -2
- data/spec/models/entity_with_talang_visible_id_spec.rb +2 -2
- data/spec/models/environment_spec.rb +2 -2
- data/spec/models/error_effect_props_spec.rb +2 -2
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_response_with_status_spec.rb +2 -2
- data/spec/models/error_source_spec.rb +2 -2
- data/spec/models/evaluable_campaign_ids_spec.rb +41 -0
- data/spec/models/event_spec.rb +2 -2
- data/spec/models/event_type_spec.rb +2 -2
- data/spec/models/event_v2_spec.rb +8 -2
- data/spec/models/expiring_points_notification_policy_spec.rb +47 -0
- data/spec/models/expiring_points_notification_trigger_spec.rb +51 -0
- data/spec/models/export_spec.rb +2 -2
- data/spec/models/feature_flag_spec.rb +2 -2
- data/spec/models/features_feed_spec.rb +2 -2
- data/spec/models/feed_notification_spec.rb +2 -2
- data/spec/models/frontend_state_spec.rb +35 -0
- data/spec/models/func_arg_def_spec.rb +3 -3
- data/spec/models/function_def_spec.rb +2 -2
- data/spec/models/giveaway_spec.rb +14 -2
- data/spec/models/giveaways_pool_spec.rb +8 -2
- data/spec/models/import_entity_spec.rb +2 -2
- data/spec/models/import_spec.rb +2 -2
- data/spec/models/inline_response20010_spec.rb +3 -3
- data/spec/models/inline_response20011_spec.rb +3 -3
- data/spec/models/inline_response20012_spec.rb +3 -3
- data/spec/models/inline_response20013_spec.rb +2 -8
- data/spec/models/inline_response20014_spec.rb +8 -2
- data/spec/models/inline_response20015_spec.rb +2 -2
- data/spec/models/inline_response20016_spec.rb +8 -2
- data/spec/models/inline_response20017_spec.rb +2 -2
- data/spec/models/inline_response20018_spec.rb +3 -3
- data/spec/models/inline_response20019_spec.rb +2 -2
- data/spec/models/inline_response2001_spec.rb +3 -3
- data/spec/models/inline_response20020_spec.rb +4 -4
- data/spec/models/inline_response20021_spec.rb +2 -2
- data/spec/models/inline_response20022_spec.rb +8 -2
- data/spec/models/inline_response20023_spec.rb +3 -3
- data/spec/models/inline_response20024_spec.rb +3 -3
- data/spec/models/inline_response20025_spec.rb +3 -3
- data/spec/models/inline_response20026_spec.rb +3 -3
- data/spec/models/inline_response20027_spec.rb +2 -2
- data/spec/models/inline_response20028_spec.rb +8 -2
- data/spec/models/inline_response20029_spec.rb +4 -4
- data/spec/models/inline_response2002_spec.rb +2 -2
- data/spec/models/inline_response20030_spec.rb +2 -2
- data/spec/models/inline_response20031_spec.rb +2 -2
- data/spec/models/inline_response20032_spec.rb +47 -0
- data/spec/models/inline_response20033_spec.rb +47 -0
- data/spec/models/inline_response20034_spec.rb +47 -0
- data/spec/models/inline_response20035_spec.rb +47 -0
- data/spec/models/inline_response20036_spec.rb +47 -0
- data/spec/models/inline_response20037_spec.rb +53 -0
- data/spec/models/inline_response20038_spec.rb +47 -0
- data/spec/models/inline_response20039_spec.rb +47 -0
- data/spec/models/inline_response2003_spec.rb +2 -2
- data/spec/models/inline_response2004_spec.rb +2 -2
- data/spec/models/inline_response2005_spec.rb +3 -3
- data/spec/models/inline_response2006_spec.rb +3 -3
- data/spec/models/inline_response2007_spec.rb +3 -3
- data/spec/models/inline_response2008_spec.rb +2 -8
- data/spec/models/inline_response2009_spec.rb +2 -8
- data/spec/models/inline_response200_spec.rb +2 -2
- data/spec/models/inline_response201_spec.rb +2 -2
- data/spec/models/integration_coupon_spec.rb +167 -0
- data/spec/models/integration_customer_session_response_spec.rb +8 -2
- data/spec/models/integration_entity_spec.rb +2 -2
- data/spec/models/integration_event_spec.rb +2 -2
- data/spec/models/integration_event_v2_request_spec.rb +8 -2
- data/spec/models/integration_profile_entity_spec.rb +2 -2
- data/spec/models/integration_request_spec.rb +2 -2
- data/spec/models/integration_state_spec.rb +2 -2
- data/spec/models/integration_state_v2_spec.rb +2 -2
- data/spec/models/inventory_coupon_spec.rb +20 -2
- data/spec/models/inventory_referral_spec.rb +2 -2
- data/spec/models/item_attribute_spec.rb +53 -0
- data/spec/models/ledger_entry_spec.rb +2 -2
- data/spec/models/ledger_info_spec.rb +5 -5
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +111 -0
- data/spec/models/library_attribute_spec.rb +2 -2
- data/spec/models/limit_config_spec.rb +2 -2
- data/spec/models/limit_counter_spec.rb +2 -2
- data/spec/models/login_params_spec.rb +2 -2
- data/spec/models/loyalty_balance_spec.rb +59 -0
- data/spec/models/loyalty_balances_spec.rb +47 -0
- data/spec/models/loyalty_card_profile_registration_spec.rb +2 -2
- data/spec/models/loyalty_card_registration_spec.rb +2 -2
- data/spec/models/loyalty_card_spec.rb +14 -2
- data/spec/models/loyalty_dashboard_data_spec.rb +2 -2
- data/spec/models/loyalty_dashboard_points_breakdown_spec.rb +2 -2
- data/spec/models/loyalty_ledger_entry_spec.rb +8 -2
- data/spec/models/loyalty_ledger_spec.rb +2 -2
- data/spec/models/loyalty_ledger_transactions_spec.rb +47 -0
- data/spec/models/loyalty_membership_spec.rb +2 -2
- data/spec/models/loyalty_program_balance_spec.rb +8 -2
- data/spec/models/loyalty_program_entity_spec.rb +2 -2
- data/spec/models/loyalty_program_ledgers_spec.rb +2 -2
- data/spec/models/loyalty_program_spec.rb +8 -2
- data/spec/models/loyalty_program_transaction_spec.rb +141 -0
- data/spec/models/loyalty_spec.rb +2 -2
- data/spec/models/loyalty_statistics_spec.rb +2 -2
- data/spec/models/loyalty_sub_ledger_spec.rb +2 -2
- data/spec/models/loyalty_tier_spec.rb +2 -2
- data/spec/models/management_key_spec.rb +83 -0
- data/spec/models/manager_config_spec.rb +2 -2
- data/spec/models/meta_spec.rb +2 -2
- data/spec/models/model_return_spec.rb +2 -2
- data/spec/models/multi_application_entity_spec.rb +2 -2
- data/spec/models/multiple_attribute_spec.rb +2 -2
- data/spec/models/multiple_audiences_item_spec.rb +69 -0
- data/spec/models/multiple_audiences_spec.rb +47 -0
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +2 -2
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +2 -2
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +2 -2
- data/spec/models/multiple_new_attribute_spec.rb +2 -2
- data/spec/models/multiple_new_audiences_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +2 -2
- data/spec/models/new_account_sign_up_spec.rb +2 -2
- data/spec/models/new_account_spec.rb +2 -2
- data/spec/models/new_additional_cost_spec.rb +2 -2
- data/spec/models/new_application_api_key_spec.rb +3 -3
- data/spec/models/new_application_spec.rb +2 -2
- data/spec/models/new_attribute_spec.rb +18 -2
- data/spec/models/new_audience_spec.rb +26 -2
- data/spec/models/new_base_notification_spec.rb +47 -0
- data/spec/models/new_campaign_collection_spec.rb +2 -2
- data/spec/models/new_campaign_group_spec.rb +2 -2
- data/spec/models/new_campaign_set_spec.rb +2 -2
- data/spec/models/new_campaign_set_v2_spec.rb +2 -2
- data/spec/models/new_campaign_spec.rb +3 -3
- data/spec/models/new_campaign_template_spec.rb +9 -3
- data/spec/models/new_catalog_spec.rb +2 -2
- data/spec/models/new_collection_spec.rb +2 -2
- data/spec/models/new_coupon_creation_job_spec.rb +8 -2
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +8 -2
- data/spec/models/new_coupons_spec.rb +14 -2
- data/spec/models/new_custom_effect_spec.rb +8 -2
- data/spec/models/new_customer_profile_spec.rb +2 -2
- 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 +2 -2
- data/spec/models/new_event_type_spec.rb +2 -2
- data/spec/models/new_giveaways_pool_spec.rb +8 -2
- data/spec/models/new_internal_audience_spec.rb +53 -0
- data/spec/models/new_invitation_spec.rb +2 -2
- data/spec/models/new_invite_email_spec.rb +2 -2
- data/spec/models/new_loyalty_program_spec.rb +8 -2
- data/spec/models/new_loyalty_tier_spec.rb +2 -2
- data/spec/models/new_management_key_spec.rb +89 -0
- data/spec/models/new_multiple_audiences_item_spec.rb +47 -0
- data/spec/models/new_notification_webhook_spec.rb +2 -2
- data/spec/models/new_password_email_spec.rb +2 -2
- data/spec/models/new_password_spec.rb +2 -2
- data/spec/models/new_picklist_spec.rb +51 -0
- data/spec/models/new_referral_spec.rb +2 -2
- data/spec/models/new_referrals_for_multiple_advocates_spec.rb +2 -2
- data/spec/models/new_return_spec.rb +2 -2
- data/spec/models/new_role_spec.rb +2 -2
- data/spec/models/new_ruleset_spec.rb +8 -2
- data/spec/models/new_saml_connection_spec.rb +2 -2
- data/spec/models/new_template_def_spec.rb +2 -2
- data/spec/models/new_user_spec.rb +2 -2
- data/spec/models/new_webhook_spec.rb +2 -2
- data/spec/models/notification_spec.rb +2 -2
- data/spec/models/notification_webhook_spec.rb +2 -2
- data/spec/models/outgoing_integration_braze_policy_spec.rb +47 -0
- data/spec/models/outgoing_integration_configuration_spec.rb +53 -0
- data/spec/models/outgoing_integration_type_spec.rb +65 -0
- data/spec/models/outgoing_integration_types_spec.rb +41 -0
- data/spec/models/outgoing_integration_webhook_template_spec.rb +65 -0
- data/spec/models/outgoing_integration_webhook_templates_spec.rb +41 -0
- data/spec/models/patch_item_catalog_action_spec.rb +59 -0
- data/spec/models/patch_many_items_catalog_action_spec.rb +53 -0
- data/spec/models/picklist_spec.rb +87 -0
- data/spec/models/priority_position_spec.rb +51 -0
- data/spec/models/profile_audiences_changes_spec.rb +2 -2
- data/spec/models/redeem_referral_effect_props_spec.rb +2 -2
- data/spec/models/referral_constraints_spec.rb +2 -2
- data/spec/models/referral_created_effect_props_spec.rb +2 -2
- data/spec/models/referral_rejection_reason_spec.rb +3 -3
- data/spec/models/referral_spec.rb +2 -2
- data/spec/models/reject_coupon_effect_props_spec.rb +2 -2
- data/spec/models/reject_referral_effect_props_spec.rb +2 -2
- data/spec/models/remove_item_catalog_action_spec.rb +41 -0
- data/spec/models/remove_many_items_catalog_action_spec.rb +41 -0
- data/spec/models/reserve_coupon_effect_props_spec.rb +53 -0
- data/spec/models/return_integration_request_spec.rb +2 -2
- data/spec/models/returned_cart_item_spec.rb +2 -2
- data/spec/models/role_assign_spec.rb +2 -2
- data/spec/models/role_membership_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/role_v2_application_details_spec.rb +53 -0
- data/spec/models/role_v2_permission_set_spec.rb +47 -0
- data/spec/models/role_v2_permissions_roles_spec.rb +53 -0
- data/spec/models/role_v2_permissions_spec.rb +47 -0
- data/spec/models/{loyalty_points_spec.rb → role_v2_spec.rb} +13 -13
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +2 -2
- data/spec/models/rollback_coupon_effect_props_spec.rb +2 -2
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +2 -2
- data/spec/models/rollback_discount_effect_props_spec.rb +2 -2
- data/spec/models/rollback_referral_effect_props_spec.rb +2 -2
- data/spec/models/rule_failure_reason_spec.rb +2 -2
- data/spec/models/rule_spec.rb +14 -2
- data/spec/models/ruleset_spec.rb +8 -2
- data/spec/models/saml_connection_metadata_spec.rb +2 -2
- data/spec/models/saml_connection_spec.rb +2 -2
- data/spec/models/saml_login_endpoint_spec.rb +2 -2
- data/spec/models/session_spec.rb +2 -2
- data/spec/models/set_discount_effect_props_spec.rb +2 -2
- data/spec/models/set_discount_per_additional_cost_effect_props_spec.rb +2 -2
- data/spec/models/set_discount_per_additional_cost_per_item_effect_props_spec.rb +2 -2
- data/spec/models/set_discount_per_item_effect_props_spec.rb +14 -2
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +2 -2
- data/spec/models/show_notification_effect_props_spec.rb +2 -2
- data/spec/models/slot_def_spec.rb +2 -2
- data/spec/models/strikethrough_changed_item_spec.rb +77 -0
- data/spec/models/strikethrough_effect_spec.rb +71 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +65 -0
- data/spec/models/strikethrough_set_discount_per_item_effect_props_spec.rb +47 -0
- data/spec/models/strikethrough_trigger_spec.rb +65 -0
- data/spec/models/talang_attribute_spec.rb +97 -0
- data/spec/models/talang_attribute_visibility_spec.rb +47 -0
- data/spec/models/template_arg_def_spec.rb +15 -3
- data/spec/models/template_def_spec.rb +2 -2
- data/spec/models/template_limit_config_spec.rb +2 -2
- data/spec/models/tier_spec.rb +2 -2
- data/spec/models/transfer_loyalty_card_spec.rb +41 -0
- data/spec/models/trigger_webhook_effect_props_spec.rb +2 -2
- data/spec/models/update_account_spec.rb +2 -2
- data/spec/models/update_application_spec.rb +2 -2
- data/spec/models/update_attribute_effect_props_spec.rb +2 -2
- data/spec/models/update_audience_spec.rb +2 -2
- data/spec/models/update_campaign_collection_spec.rb +2 -2
- data/spec/models/update_campaign_group_spec.rb +2 -2
- data/spec/models/update_campaign_spec.rb +3 -3
- data/spec/models/update_campaign_template_spec.rb +9 -3
- data/spec/models/update_catalog_spec.rb +2 -2
- data/spec/models/update_collection_spec.rb +2 -2
- data/spec/models/update_coupon_batch_spec.rb +8 -2
- data/spec/models/update_coupon_spec.rb +14 -2
- data/spec/models/update_custom_effect_spec.rb +8 -2
- data/spec/models/update_loyalty_card_spec.rb +2 -2
- data/spec/models/update_loyalty_program_spec.rb +8 -2
- data/spec/models/update_picklist_spec.rb +51 -0
- data/spec/models/update_referral_batch_spec.rb +2 -2
- data/spec/models/update_referral_spec.rb +2 -2
- data/spec/models/update_role_spec.rb +2 -2
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +2 -2
- data/spec/models/update_user_spec.rb +2 -2
- data/spec/models/user_entity_spec.rb +2 -2
- data/spec/models/user_feed_notifications_spec.rb +2 -2
- data/spec/models/user_spec.rb +2 -2
- data/spec/models/webhook_activation_log_entry_spec.rb +2 -2
- data/spec/models/webhook_log_entry_spec.rb +2 -2
- data/spec/models/webhook_spec.rb +2 -2
- data/spec/models/will_award_giveaway_effect_props_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/talon_one.gemspec +2 -2
- metadata +346 -14
- data/docs/LoyaltyPoints.md +0 -25
- data/docs/LoyaltyProjection.md +0 -21
- data/docs/LoyaltyProjectionData.md +0 -23
data/docs/IntegrationApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# TalonOne::IntegrationApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *https://yourbaseurl.talon.one*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
@@ -14,12 +14,19 @@ Method | HTTP request | Description
|
|
|
14
14
|
[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete customer's personal data
|
|
15
15
|
[**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data
|
|
16
16
|
[**get_customer_session**](IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session
|
|
17
|
+
[**get_loyalty_balances**](IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points
|
|
18
|
+
[**get_loyalty_card_balances**](IntegrationApi.md#get_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardIdentifier}/balances | Get loyalty balances for a loyalty card
|
|
19
|
+
[**get_loyalty_card_transactions**](IntegrationApi.md#get_loyalty_card_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardIdentifier}/transactions | Get loyalty card transaction logs
|
|
20
|
+
[**get_loyalty_program_profile_transactions**](IntegrationApi.md#get_loyalty_program_profile_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions | List customer's loyalty transactions
|
|
17
21
|
[**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | List customers that have this coupon reserved
|
|
22
|
+
[**link_loyalty_card_to_profile**](IntegrationApi.md#link_loyalty_card_to_profile) | **POST** /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardIdentifier}/link_profile | Link customer profile to loyalty card
|
|
23
|
+
[**reopen_customer_session**](IntegrationApi.md#reopen_customer_session) | **PUT** /v2/customer_sessions/{customerSessionId}/reopen | Reopen customer session
|
|
18
24
|
[**return_cart_items**](IntegrationApi.md#return_cart_items) | **POST** /v2/customer_sessions/{customerSessionId}/returns | Return cart items
|
|
25
|
+
[**sync_catalog**](IntegrationApi.md#sync_catalog) | **PUT** /v1/catalogs/{catalogId}/sync | Sync cart item catalog
|
|
19
26
|
[**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track event
|
|
20
27
|
[**track_event_v2**](IntegrationApi.md#track_event_v2) | **POST** /v2/events | Track event V2
|
|
21
28
|
[**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
|
|
29
|
+
[**update_audience_v2**](IntegrationApi.md#update_audience_v2) | **PUT** /v2/audiences/{audienceId} | Update audience name
|
|
23
30
|
[**update_customer_profile_audiences**](IntegrationApi.md#update_customer_profile_audiences) | **POST** /v2/customer_audiences | Update multiple customer profiles' audiences
|
|
24
31
|
[**update_customer_profile_v2**](IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{integrationId} | Update customer profile
|
|
25
32
|
[**update_customer_profiles_v2**](IntegrationApi.md#update_customer_profiles_v2) | **PUT** /v2/customer_profiles | Update multiple customer profiles
|
|
@@ -33,7 +40,7 @@ Method | HTTP request | Description
|
|
|
33
40
|
|
|
34
41
|
Create audience
|
|
35
42
|
|
|
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
|
|
43
|
+
Create an audience. The audience can be created directly from scratch or can come from third party platforms. **Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., 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: 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.
|
|
37
44
|
|
|
38
45
|
### Example
|
|
39
46
|
|
|
@@ -49,7 +56,7 @@ TalonOne.configure do |config|
|
|
|
49
56
|
end
|
|
50
57
|
|
|
51
58
|
api_instance = TalonOne::IntegrationApi.new
|
|
52
|
-
body = TalonOne::NewAudience.new # NewAudience |
|
|
59
|
+
body = TalonOne::NewAudience.new # NewAudience | body
|
|
53
60
|
|
|
54
61
|
begin
|
|
55
62
|
#Create audience
|
|
@@ -65,7 +72,7 @@ end
|
|
|
65
72
|
|
|
66
73
|
Name | Type | Description | Notes
|
|
67
74
|
------------- | ------------- | ------------- | -------------
|
|
68
|
-
**body** | [**NewAudience**](NewAudience.md)|
|
|
75
|
+
**body** | [**NewAudience**](NewAudience.md)| body |
|
|
69
76
|
|
|
70
77
|
### Return type
|
|
71
78
|
|
|
@@ -87,7 +94,7 @@ Name | Type | Description | Notes
|
|
|
87
94
|
|
|
88
95
|
Create coupon reservation
|
|
89
96
|
|
|
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
|
|
97
|
+
Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). 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](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. If a coupon gets created for a specific user, it will automatically appear 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](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. 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. <div class=\"redoc-section\"> <p class=\"title\">Important</p> This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. To create a hard reservation, you can: - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint setting the `recipientsIntegrationId` property or, - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). </div> To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
|
|
91
98
|
|
|
92
99
|
### Example
|
|
93
100
|
|
|
@@ -103,8 +110,8 @@ TalonOne.configure do |config|
|
|
|
103
110
|
end
|
|
104
111
|
|
|
105
112
|
api_instance = TalonOne::IntegrationApi.new
|
|
106
|
-
coupon_value = 'coupon_value_example' # String | The
|
|
107
|
-
body = TalonOne::CouponReservations.new # CouponReservations |
|
|
113
|
+
coupon_value = 'coupon_value_example' # String | The code of the coupon.
|
|
114
|
+
body = TalonOne::CouponReservations.new # CouponReservations | body
|
|
108
115
|
|
|
109
116
|
begin
|
|
110
117
|
#Create coupon reservation
|
|
@@ -120,8 +127,8 @@ end
|
|
|
120
127
|
|
|
121
128
|
Name | Type | Description | Notes
|
|
122
129
|
------------- | ------------- | ------------- | -------------
|
|
123
|
-
**coupon_value** | **String**| The
|
|
124
|
-
**body** | [**CouponReservations**](CouponReservations.md)|
|
|
130
|
+
**coupon_value** | **String**| The code of the coupon. |
|
|
131
|
+
**body** | [**CouponReservations**](CouponReservations.md)| body |
|
|
125
132
|
|
|
126
133
|
### Return type
|
|
127
134
|
|
|
@@ -159,7 +166,7 @@ TalonOne.configure do |config|
|
|
|
159
166
|
end
|
|
160
167
|
|
|
161
168
|
api_instance = TalonOne::IntegrationApi.new
|
|
162
|
-
body = TalonOne::NewReferral.new # NewReferral |
|
|
169
|
+
body = TalonOne::NewReferral.new # NewReferral | body
|
|
163
170
|
|
|
164
171
|
begin
|
|
165
172
|
#Create referral code for an advocate
|
|
@@ -175,7 +182,7 @@ end
|
|
|
175
182
|
|
|
176
183
|
Name | Type | Description | Notes
|
|
177
184
|
------------- | ------------- | ------------- | -------------
|
|
178
|
-
**body** | [**NewReferral**](NewReferral.md)|
|
|
185
|
+
**body** | [**NewReferral**](NewReferral.md)| body |
|
|
179
186
|
|
|
180
187
|
### Return type
|
|
181
188
|
|
|
@@ -213,9 +220,9 @@ TalonOne.configure do |config|
|
|
|
213
220
|
end
|
|
214
221
|
|
|
215
222
|
api_instance = TalonOne::IntegrationApi.new
|
|
216
|
-
body = TalonOne::NewReferralsForMultipleAdvocates.new # NewReferralsForMultipleAdvocates |
|
|
223
|
+
body = TalonOne::NewReferralsForMultipleAdvocates.new # NewReferralsForMultipleAdvocates | body
|
|
217
224
|
opts = {
|
|
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
|
|
225
|
+
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 the updated customer profiles.
|
|
219
226
|
}
|
|
220
227
|
|
|
221
228
|
begin
|
|
@@ -232,8 +239,8 @@ end
|
|
|
232
239
|
|
|
233
240
|
Name | Type | Description | Notes
|
|
234
241
|
------------- | ------------- | ------------- | -------------
|
|
235
|
-
**body** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md)|
|
|
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
|
|
242
|
+
**body** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md)| body |
|
|
243
|
+
**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 the updated customer profiles. | [optional] [default to 'yes']
|
|
237
244
|
|
|
238
245
|
### Return type
|
|
239
246
|
|
|
@@ -264,7 +271,7 @@ Remove all members from this audience.
|
|
|
264
271
|
require 'talon_one'
|
|
265
272
|
# setup authorization
|
|
266
273
|
TalonOne.configure do |config|
|
|
267
|
-
# Configure API key authorization:
|
|
274
|
+
# Configure API key authorization: api_key_v1
|
|
268
275
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
269
276
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
270
277
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
@@ -294,7 +301,7 @@ nil (empty response body)
|
|
|
294
301
|
|
|
295
302
|
### Authorization
|
|
296
303
|
|
|
297
|
-
[
|
|
304
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
298
305
|
|
|
299
306
|
### HTTP request headers
|
|
300
307
|
|
|
@@ -308,7 +315,7 @@ nil (empty response body)
|
|
|
308
315
|
|
|
309
316
|
Delete audience
|
|
310
317
|
|
|
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.
|
|
318
|
+
Delete an audience created by a third-party integration. **Warning:** This endpoint also removes any associations recorded between a customer profile and this audience. **Note:** Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience).
|
|
312
319
|
|
|
313
320
|
### Example
|
|
314
321
|
|
|
@@ -317,7 +324,7 @@ Delete an audience created by a third-party integration. **Warning:** This endp
|
|
|
317
324
|
require 'talon_one'
|
|
318
325
|
# setup authorization
|
|
319
326
|
TalonOne.configure do |config|
|
|
320
|
-
# Configure API key authorization:
|
|
327
|
+
# Configure API key authorization: api_key_v1
|
|
321
328
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
322
329
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
323
330
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
@@ -347,7 +354,7 @@ nil (empty response body)
|
|
|
347
354
|
|
|
348
355
|
### Authorization
|
|
349
356
|
|
|
350
|
-
[
|
|
357
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
351
358
|
|
|
352
359
|
### HTTP request headers
|
|
353
360
|
|
|
@@ -361,7 +368,7 @@ nil (empty response body)
|
|
|
361
368
|
|
|
362
369
|
Delete coupon reservations
|
|
363
370
|
|
|
364
|
-
Remove all
|
|
371
|
+
Remove all the coupon reservations from the provided customer profile integration IDs and the provided coupon code.
|
|
365
372
|
|
|
366
373
|
### Example
|
|
367
374
|
|
|
@@ -377,8 +384,8 @@ TalonOne.configure do |config|
|
|
|
377
384
|
end
|
|
378
385
|
|
|
379
386
|
api_instance = TalonOne::IntegrationApi.new
|
|
380
|
-
coupon_value = 'coupon_value_example' # String | The
|
|
381
|
-
body = TalonOne::CouponReservations.new # CouponReservations |
|
|
387
|
+
coupon_value = 'coupon_value_example' # String | The code of the coupon.
|
|
388
|
+
body = TalonOne::CouponReservations.new # CouponReservations | body
|
|
382
389
|
|
|
383
390
|
begin
|
|
384
391
|
#Delete coupon reservations
|
|
@@ -393,8 +400,8 @@ end
|
|
|
393
400
|
|
|
394
401
|
Name | Type | Description | Notes
|
|
395
402
|
------------- | ------------- | ------------- | -------------
|
|
396
|
-
**coupon_value** | **String**| The
|
|
397
|
-
**body** | [**CouponReservations**](CouponReservations.md)|
|
|
403
|
+
**coupon_value** | **String**| The code of the coupon. |
|
|
404
|
+
**body** | [**CouponReservations**](CouponReservations.md)| body |
|
|
398
405
|
|
|
399
406
|
### Return type
|
|
400
407
|
|
|
@@ -432,7 +439,7 @@ TalonOne.configure do |config|
|
|
|
432
439
|
end
|
|
433
440
|
|
|
434
441
|
api_instance = TalonOne::IntegrationApi.new
|
|
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
|
|
442
|
+
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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
|
436
443
|
|
|
437
444
|
begin
|
|
438
445
|
#Delete customer's personal data
|
|
@@ -447,7 +454,7 @@ end
|
|
|
447
454
|
|
|
448
455
|
Name | Type | Description | Notes
|
|
449
456
|
------------- | ------------- | ------------- | -------------
|
|
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
|
|
457
|
+
**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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. |
|
|
451
458
|
|
|
452
459
|
### Return type
|
|
453
460
|
|
|
@@ -469,7 +476,7 @@ nil (empty response body)
|
|
|
469
476
|
|
|
470
477
|
List customer data
|
|
471
478
|
|
|
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.
|
|
479
|
+
Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
|
|
473
480
|
|
|
474
481
|
### Example
|
|
475
482
|
|
|
@@ -485,14 +492,13 @@ TalonOne.configure do |config|
|
|
|
485
492
|
end
|
|
486
493
|
|
|
487
494
|
api_instance = TalonOne::IntegrationApi.new
|
|
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
|
|
495
|
+
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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
|
489
496
|
opts = {
|
|
490
497
|
profile: true, # Boolean | Set to `true` to include customer profile information in the response.
|
|
491
498
|
referrals: true, # Boolean | Set to `true` to include referral information in the response.
|
|
492
499
|
coupons: true, # Boolean | Set to `true` to include coupon information in the response.
|
|
493
500
|
loyalty: true, # Boolean | Set to `true` to include loyalty information in the response.
|
|
494
|
-
giveaways: true
|
|
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.
|
|
501
|
+
giveaways: true # Boolean | Set to `true` to include giveaways information in the response.
|
|
496
502
|
}
|
|
497
503
|
|
|
498
504
|
begin
|
|
@@ -509,13 +515,12 @@ end
|
|
|
509
515
|
|
|
510
516
|
Name | Type | Description | Notes
|
|
511
517
|
------------- | ------------- | ------------- | -------------
|
|
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
|
|
518
|
+
**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](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. |
|
|
513
519
|
**profile** | **Boolean**| Set to `true` to include customer profile information in the response. | [optional]
|
|
514
520
|
**referrals** | **Boolean**| Set to `true` to include referral information in the response. | [optional]
|
|
515
521
|
**coupons** | **Boolean**| Set to `true` to include coupon information in the response. | [optional]
|
|
516
522
|
**loyalty** | **Boolean**| Set to `true` to include loyalty information in the response. | [optional]
|
|
517
523
|
**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]
|
|
519
524
|
|
|
520
525
|
### Return type
|
|
521
526
|
|
|
@@ -537,7 +542,7 @@ Name | Type | Description | Notes
|
|
|
537
542
|
|
|
538
543
|
Get customer session
|
|
539
544
|
|
|
540
|
-
Get customer session data.
|
|
545
|
+
Get the details of the given customer session. You can get the same data via other endpoints that also apply changes, which can help you save requests and increase performance. See: - [Update customer session](#tag/Customer-sessions/operation/updateCustomerSessionV2) - [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2)
|
|
541
546
|
|
|
542
547
|
### Example
|
|
543
548
|
|
|
@@ -553,7 +558,7 @@ TalonOne.configure do |config|
|
|
|
553
558
|
end
|
|
554
559
|
|
|
555
560
|
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
|
|
561
|
+
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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
|
|
557
562
|
|
|
558
563
|
begin
|
|
559
564
|
#Get customer session
|
|
@@ -569,7 +574,7 @@ end
|
|
|
569
574
|
|
|
570
575
|
Name | Type | Description | Notes
|
|
571
576
|
------------- | ------------- | ------------- | -------------
|
|
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
|
|
577
|
+
**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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. |
|
|
573
578
|
|
|
574
579
|
### Return type
|
|
575
580
|
|
|
@@ -585,13 +590,269 @@ Name | Type | Description | Notes
|
|
|
585
590
|
- **Accept**: application/json
|
|
586
591
|
|
|
587
592
|
|
|
593
|
+
## get_loyalty_balances
|
|
594
|
+
|
|
595
|
+
> LoyaltyBalances get_loyalty_balances(loyalty_program_id, integration_id, opts)
|
|
596
|
+
|
|
597
|
+
Get customer's loyalty points
|
|
598
|
+
|
|
599
|
+
Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. **Note:** For more information, see [our documentation on managing loyalty data](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-data#obtaining-the-loyalty-balances-of-a-customer).
|
|
600
|
+
|
|
601
|
+
### Example
|
|
602
|
+
|
|
603
|
+
```ruby
|
|
604
|
+
# load the gem
|
|
605
|
+
require 'talon_one'
|
|
606
|
+
# setup authorization
|
|
607
|
+
TalonOne.configure do |config|
|
|
608
|
+
# Configure API key authorization: api_key_v1
|
|
609
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
610
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
611
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
612
|
+
end
|
|
613
|
+
|
|
614
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
615
|
+
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
616
|
+
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.
|
|
617
|
+
opts = {
|
|
618
|
+
end_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string.
|
|
619
|
+
}
|
|
620
|
+
|
|
621
|
+
begin
|
|
622
|
+
#Get customer's loyalty points
|
|
623
|
+
result = api_instance.get_loyalty_balances(loyalty_program_id, integration_id, opts)
|
|
624
|
+
p result
|
|
625
|
+
rescue TalonOne::ApiError => e
|
|
626
|
+
puts "Exception when calling IntegrationApi->get_loyalty_balances: #{e}"
|
|
627
|
+
end
|
|
628
|
+
```
|
|
629
|
+
|
|
630
|
+
### Parameters
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
Name | Type | Description | Notes
|
|
634
|
+
------------- | ------------- | ------------- | -------------
|
|
635
|
+
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
|
636
|
+
**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. |
|
|
637
|
+
**end_date** | **DateTime**| Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
638
|
+
|
|
639
|
+
### Return type
|
|
640
|
+
|
|
641
|
+
[**LoyaltyBalances**](LoyaltyBalances.md)
|
|
642
|
+
|
|
643
|
+
### Authorization
|
|
644
|
+
|
|
645
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
646
|
+
|
|
647
|
+
### HTTP request headers
|
|
648
|
+
|
|
649
|
+
- **Content-Type**: Not defined
|
|
650
|
+
- **Accept**: application/json
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
## get_loyalty_card_balances
|
|
654
|
+
|
|
655
|
+
> LoyaltyBalances get_loyalty_card_balances(loyalty_program_id, loyalty_card_identifier, opts)
|
|
656
|
+
|
|
657
|
+
Get loyalty balances for a loyalty card
|
|
658
|
+
|
|
659
|
+
Retrieve loyalty balances for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, all loyalty balances for the given loyalty card are returned.
|
|
660
|
+
|
|
661
|
+
### Example
|
|
662
|
+
|
|
663
|
+
```ruby
|
|
664
|
+
# load the gem
|
|
665
|
+
require 'talon_one'
|
|
666
|
+
# setup authorization
|
|
667
|
+
TalonOne.configure do |config|
|
|
668
|
+
# Configure API key authorization: api_key_v1
|
|
669
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
670
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
671
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
672
|
+
end
|
|
673
|
+
|
|
674
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
675
|
+
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
676
|
+
loyalty_card_identifier = 'loyalty_card_identifier_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
677
|
+
opts = {
|
|
678
|
+
end_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string.
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
begin
|
|
682
|
+
#Get loyalty balances for a loyalty card
|
|
683
|
+
result = api_instance.get_loyalty_card_balances(loyalty_program_id, loyalty_card_identifier, opts)
|
|
684
|
+
p result
|
|
685
|
+
rescue TalonOne::ApiError => e
|
|
686
|
+
puts "Exception when calling IntegrationApi->get_loyalty_card_balances: #{e}"
|
|
687
|
+
end
|
|
688
|
+
```
|
|
689
|
+
|
|
690
|
+
### Parameters
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
Name | Type | Description | Notes
|
|
694
|
+
------------- | ------------- | ------------- | -------------
|
|
695
|
+
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
|
696
|
+
**loyalty_card_identifier** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
|
697
|
+
**end_date** | **DateTime**| Used to return balances only for entries older than this timestamp. The expired, active, and pending points are relative to this timestamp. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
698
|
+
|
|
699
|
+
### Return type
|
|
700
|
+
|
|
701
|
+
[**LoyaltyBalances**](LoyaltyBalances.md)
|
|
702
|
+
|
|
703
|
+
### Authorization
|
|
704
|
+
|
|
705
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
706
|
+
|
|
707
|
+
### HTTP request headers
|
|
708
|
+
|
|
709
|
+
- **Content-Type**: Not defined
|
|
710
|
+
- **Accept**: application/json
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
## get_loyalty_card_transactions
|
|
714
|
+
|
|
715
|
+
> CardLedgerTransactionLogEntryIntegrationAPI get_loyalty_card_transactions(loyalty_program_id, loyalty_card_identifier, opts)
|
|
716
|
+
|
|
717
|
+
Get loyalty card transaction logs
|
|
718
|
+
|
|
719
|
+
Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
|
|
720
|
+
|
|
721
|
+
### Example
|
|
722
|
+
|
|
723
|
+
```ruby
|
|
724
|
+
# load the gem
|
|
725
|
+
require 'talon_one'
|
|
726
|
+
# setup authorization
|
|
727
|
+
TalonOne.configure do |config|
|
|
728
|
+
# Configure API key authorization: api_key_v1
|
|
729
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
730
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
731
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
732
|
+
end
|
|
733
|
+
|
|
734
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
735
|
+
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
736
|
+
loyalty_card_identifier = 'loyalty_card_identifier_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
737
|
+
opts = {
|
|
738
|
+
subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
|
|
739
|
+
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
|
740
|
+
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
|
741
|
+
page_size: 1000, # Integer | The number of items in this response.
|
|
742
|
+
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
743
|
+
}
|
|
744
|
+
|
|
745
|
+
begin
|
|
746
|
+
#Get loyalty card transaction logs
|
|
747
|
+
result = api_instance.get_loyalty_card_transactions(loyalty_program_id, loyalty_card_identifier, opts)
|
|
748
|
+
p result
|
|
749
|
+
rescue TalonOne::ApiError => e
|
|
750
|
+
puts "Exception when calling IntegrationApi->get_loyalty_card_transactions: #{e}"
|
|
751
|
+
end
|
|
752
|
+
```
|
|
753
|
+
|
|
754
|
+
### Parameters
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
Name | Type | Description | Notes
|
|
758
|
+
------------- | ------------- | ------------- | -------------
|
|
759
|
+
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
|
760
|
+
**loyalty_card_identifier** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
|
761
|
+
**subledger_id** | **String**| The ID of the subledger by which we filter the data. | [optional]
|
|
762
|
+
**start_date** | **DateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
763
|
+
**end_date** | **DateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
764
|
+
**page_size** | **Integer**| The number of items in this response. | [optional] [default to 1000]
|
|
765
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
766
|
+
|
|
767
|
+
### Return type
|
|
768
|
+
|
|
769
|
+
[**CardLedgerTransactionLogEntryIntegrationAPI**](CardLedgerTransactionLogEntryIntegrationAPI.md)
|
|
770
|
+
|
|
771
|
+
### Authorization
|
|
772
|
+
|
|
773
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
774
|
+
|
|
775
|
+
### HTTP request headers
|
|
776
|
+
|
|
777
|
+
- **Content-Type**: Not defined
|
|
778
|
+
- **Accept**: application/json
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
## get_loyalty_program_profile_transactions
|
|
782
|
+
|
|
783
|
+
> InlineResponse2001 get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
|
|
784
|
+
|
|
785
|
+
List customer's loyalty transactions
|
|
786
|
+
|
|
787
|
+
Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
|
|
788
|
+
|
|
789
|
+
### Example
|
|
790
|
+
|
|
791
|
+
```ruby
|
|
792
|
+
# load the gem
|
|
793
|
+
require 'talon_one'
|
|
794
|
+
# setup authorization
|
|
795
|
+
TalonOne.configure do |config|
|
|
796
|
+
# Configure API key authorization: api_key_v1
|
|
797
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
798
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
799
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
800
|
+
end
|
|
801
|
+
|
|
802
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
803
|
+
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
804
|
+
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.
|
|
805
|
+
opts = {
|
|
806
|
+
subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
|
|
807
|
+
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
|
808
|
+
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string.
|
|
809
|
+
page_size: 50, # Integer | The number of items in this response.
|
|
810
|
+
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
begin
|
|
814
|
+
#List customer's loyalty transactions
|
|
815
|
+
result = api_instance.get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
|
|
816
|
+
p result
|
|
817
|
+
rescue TalonOne::ApiError => e
|
|
818
|
+
puts "Exception when calling IntegrationApi->get_loyalty_program_profile_transactions: #{e}"
|
|
819
|
+
end
|
|
820
|
+
```
|
|
821
|
+
|
|
822
|
+
### Parameters
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
Name | Type | Description | Notes
|
|
826
|
+
------------- | ------------- | ------------- | -------------
|
|
827
|
+
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
|
828
|
+
**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. |
|
|
829
|
+
**subledger_id** | **String**| The ID of the subledger by which we filter the data. | [optional]
|
|
830
|
+
**start_date** | **DateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
831
|
+
**end_date** | **DateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
832
|
+
**page_size** | **Integer**| The number of items in this response. | [optional] [default to 50]
|
|
833
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
834
|
+
|
|
835
|
+
### Return type
|
|
836
|
+
|
|
837
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
|
838
|
+
|
|
839
|
+
### Authorization
|
|
840
|
+
|
|
841
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
842
|
+
|
|
843
|
+
### HTTP request headers
|
|
844
|
+
|
|
845
|
+
- **Content-Type**: Not defined
|
|
846
|
+
- **Accept**: application/json
|
|
847
|
+
|
|
848
|
+
|
|
588
849
|
## get_reserved_customers
|
|
589
850
|
|
|
590
851
|
> InlineResponse200 get_reserved_customers(coupon_value)
|
|
591
852
|
|
|
592
853
|
List customers that have this coupon reserved
|
|
593
854
|
|
|
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
|
|
855
|
+
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](https://docs.talon.one/management-api#operation/createCoupons) or [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoints.
|
|
595
856
|
|
|
596
857
|
### Example
|
|
597
858
|
|
|
@@ -607,7 +868,7 @@ TalonOne.configure do |config|
|
|
|
607
868
|
end
|
|
608
869
|
|
|
609
870
|
api_instance = TalonOne::IntegrationApi.new
|
|
610
|
-
coupon_value = 'coupon_value_example' # String | The
|
|
871
|
+
coupon_value = 'coupon_value_example' # String | The code of the coupon.
|
|
611
872
|
|
|
612
873
|
begin
|
|
613
874
|
#List customers that have this coupon reserved
|
|
@@ -623,7 +884,7 @@ end
|
|
|
623
884
|
|
|
624
885
|
Name | Type | Description | Notes
|
|
625
886
|
------------- | ------------- | ------------- | -------------
|
|
626
|
-
**coupon_value** | **String**| The
|
|
887
|
+
**coupon_value** | **String**| The code of the coupon. |
|
|
627
888
|
|
|
628
889
|
### Return type
|
|
629
890
|
|
|
@@ -639,13 +900,125 @@ Name | Type | Description | Notes
|
|
|
639
900
|
- **Accept**: application/json
|
|
640
901
|
|
|
641
902
|
|
|
903
|
+
## link_loyalty_card_to_profile
|
|
904
|
+
|
|
905
|
+
> LoyaltyCard link_loyalty_card_to_profile(loyalty_program_id, loyalty_card_identifier, body)
|
|
906
|
+
|
|
907
|
+
Link customer profile to loyalty card
|
|
908
|
+
|
|
909
|
+
[Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/loyalty-card-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/loyalty-cards/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/creating-loyalty-programs#creating-card-based-loyalty-programs) allows.
|
|
910
|
+
|
|
911
|
+
### Example
|
|
912
|
+
|
|
913
|
+
```ruby
|
|
914
|
+
# load the gem
|
|
915
|
+
require 'talon_one'
|
|
916
|
+
# setup authorization
|
|
917
|
+
TalonOne.configure do |config|
|
|
918
|
+
# Configure API key authorization: api_key_v1
|
|
919
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
920
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
921
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
922
|
+
end
|
|
923
|
+
|
|
924
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
925
|
+
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
926
|
+
loyalty_card_identifier = 'loyalty_card_identifier_example' # String | Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
927
|
+
body = TalonOne::LoyaltyCardRegistration.new # LoyaltyCardRegistration | body
|
|
928
|
+
|
|
929
|
+
begin
|
|
930
|
+
#Link customer profile to loyalty card
|
|
931
|
+
result = api_instance.link_loyalty_card_to_profile(loyalty_program_id, loyalty_card_identifier, body)
|
|
932
|
+
p result
|
|
933
|
+
rescue TalonOne::ApiError => e
|
|
934
|
+
puts "Exception when calling IntegrationApi->link_loyalty_card_to_profile: #{e}"
|
|
935
|
+
end
|
|
936
|
+
```
|
|
937
|
+
|
|
938
|
+
### Parameters
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
Name | Type | Description | Notes
|
|
942
|
+
------------- | ------------- | ------------- | -------------
|
|
943
|
+
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
|
944
|
+
**loyalty_card_identifier** | **String**| Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. |
|
|
945
|
+
**body** | [**LoyaltyCardRegistration**](LoyaltyCardRegistration.md)| body |
|
|
946
|
+
|
|
947
|
+
### Return type
|
|
948
|
+
|
|
949
|
+
[**LoyaltyCard**](LoyaltyCard.md)
|
|
950
|
+
|
|
951
|
+
### Authorization
|
|
952
|
+
|
|
953
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
954
|
+
|
|
955
|
+
### HTTP request headers
|
|
956
|
+
|
|
957
|
+
- **Content-Type**: application/json
|
|
958
|
+
- **Accept**: application/json
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
## reopen_customer_session
|
|
962
|
+
|
|
963
|
+
> IntegrationStateV2 reopen_customer_session(customer_session_id)
|
|
964
|
+
|
|
965
|
+
Reopen customer session
|
|
966
|
+
|
|
967
|
+
Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets are left the way they were once the session was originally closed:</p> <ul> <li>Add free item effect</li> <li>Any <strong>not pending</strong> pending loyalty points.</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> <p>To see an example of roll back, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets tutorial</a>.</p> </details> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
|
|
968
|
+
|
|
969
|
+
### Example
|
|
970
|
+
|
|
971
|
+
```ruby
|
|
972
|
+
# load the gem
|
|
973
|
+
require 'talon_one'
|
|
974
|
+
# setup authorization
|
|
975
|
+
TalonOne.configure do |config|
|
|
976
|
+
# Configure API key authorization: api_key_v1
|
|
977
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
978
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
979
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
980
|
+
end
|
|
981
|
+
|
|
982
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
983
|
+
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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
|
|
984
|
+
|
|
985
|
+
begin
|
|
986
|
+
#Reopen customer session
|
|
987
|
+
result = api_instance.reopen_customer_session(customer_session_id)
|
|
988
|
+
p result
|
|
989
|
+
rescue TalonOne::ApiError => e
|
|
990
|
+
puts "Exception when calling IntegrationApi->reopen_customer_session: #{e}"
|
|
991
|
+
end
|
|
992
|
+
```
|
|
993
|
+
|
|
994
|
+
### Parameters
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
Name | Type | Description | Notes
|
|
998
|
+
------------- | ------------- | ------------- | -------------
|
|
999
|
+
**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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. |
|
|
1000
|
+
|
|
1001
|
+
### Return type
|
|
1002
|
+
|
|
1003
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
|
1004
|
+
|
|
1005
|
+
### Authorization
|
|
1006
|
+
|
|
1007
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
1008
|
+
|
|
1009
|
+
### HTTP request headers
|
|
1010
|
+
|
|
1011
|
+
- **Content-Type**: Not defined
|
|
1012
|
+
- **Accept**: application/json
|
|
1013
|
+
|
|
1014
|
+
|
|
642
1015
|
## return_cart_items
|
|
643
1016
|
|
|
644
1017
|
> IntegrationStateV2 return_cart_items(customer_session_id, body, opts)
|
|
645
1018
|
|
|
646
1019
|
Return cart items
|
|
647
1020
|
|
|
648
|
-
Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `
|
|
1021
|
+
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#flattening) is enabled for the Application. **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).
|
|
649
1022
|
|
|
650
1023
|
### Example
|
|
651
1024
|
|
|
@@ -661,10 +1034,10 @@ TalonOne.configure do |config|
|
|
|
661
1034
|
end
|
|
662
1035
|
|
|
663
1036
|
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
|
|
665
|
-
body = TalonOne::ReturnIntegrationRequest.new # ReturnIntegrationRequest |
|
|
1037
|
+
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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
|
|
1038
|
+
body = TalonOne::ReturnIntegrationRequest.new # ReturnIntegrationRequest | body
|
|
666
1039
|
opts = {
|
|
667
|
-
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1040
|
+
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
668
1041
|
}
|
|
669
1042
|
|
|
670
1043
|
begin
|
|
@@ -681,9 +1054,9 @@ end
|
|
|
681
1054
|
|
|
682
1055
|
Name | Type | Description | Notes
|
|
683
1056
|
------------- | ------------- | ------------- | -------------
|
|
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
|
|
685
|
-
**body** | [**ReturnIntegrationRequest**](ReturnIntegrationRequest.md)|
|
|
686
|
-
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1057
|
+
**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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. |
|
|
1058
|
+
**body** | [**ReturnIntegrationRequest**](ReturnIntegrationRequest.md)| body |
|
|
1059
|
+
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
687
1060
|
|
|
688
1061
|
### Return type
|
|
689
1062
|
|
|
@@ -699,13 +1072,69 @@ Name | Type | Description | Notes
|
|
|
699
1072
|
- **Accept**: application/json
|
|
700
1073
|
|
|
701
1074
|
|
|
1075
|
+
## sync_catalog
|
|
1076
|
+
|
|
1077
|
+
> Catalog sync_catalog(catalog_id, body)
|
|
1078
|
+
|
|
1079
|
+
Sync cart item catalog
|
|
1080
|
+
|
|
1081
|
+
Perform one or more of the following sync actions on this cart item catalog, up to 1000 actions: - Add an item to the catalog. - Edit the attributes of an item in the catalog. - Edit the attributes of more than one item in the catalog. - Remove an item from the catalog. - Remove more than one item from the catalog. **Note:** For more information, see [our documentation on managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs#displaying-the-details-and-content-of-a-catalog) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoe\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100 }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\" }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of several items at once</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing several items from the catalog at once</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
|
|
1082
|
+
|
|
1083
|
+
### Example
|
|
1084
|
+
|
|
1085
|
+
```ruby
|
|
1086
|
+
# load the gem
|
|
1087
|
+
require 'talon_one'
|
|
1088
|
+
# setup authorization
|
|
1089
|
+
TalonOne.configure do |config|
|
|
1090
|
+
# Configure API key authorization: api_key_v1
|
|
1091
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1092
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1093
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1094
|
+
end
|
|
1095
|
+
|
|
1096
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
1097
|
+
catalog_id = 56 # Integer | The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
|
|
1098
|
+
body = TalonOne::CatalogSyncRequest.new # CatalogSyncRequest | body
|
|
1099
|
+
|
|
1100
|
+
begin
|
|
1101
|
+
#Sync cart item catalog
|
|
1102
|
+
result = api_instance.sync_catalog(catalog_id, body)
|
|
1103
|
+
p result
|
|
1104
|
+
rescue TalonOne::ApiError => e
|
|
1105
|
+
puts "Exception when calling IntegrationApi->sync_catalog: #{e}"
|
|
1106
|
+
end
|
|
1107
|
+
```
|
|
1108
|
+
|
|
1109
|
+
### Parameters
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
Name | Type | Description | Notes
|
|
1113
|
+
------------- | ------------- | ------------- | -------------
|
|
1114
|
+
**catalog_id** | **Integer**| The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**. |
|
|
1115
|
+
**body** | [**CatalogSyncRequest**](CatalogSyncRequest.md)| body |
|
|
1116
|
+
|
|
1117
|
+
### Return type
|
|
1118
|
+
|
|
1119
|
+
[**Catalog**](Catalog.md)
|
|
1120
|
+
|
|
1121
|
+
### Authorization
|
|
1122
|
+
|
|
1123
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
1124
|
+
|
|
1125
|
+
### HTTP request headers
|
|
1126
|
+
|
|
1127
|
+
- **Content-Type**: application/json
|
|
1128
|
+
- **Accept**: application/json
|
|
1129
|
+
|
|
1130
|
+
|
|
702
1131
|
## track_event
|
|
703
1132
|
|
|
704
1133
|
> IntegrationState track_event(body, opts)
|
|
705
1134
|
|
|
706
1135
|
Track event
|
|
707
1136
|
|
|
708
|
-
|
|
1137
|
+
<div class=\"redoc-section\"> <p class=\"title\">Deprecation warning</p> <p>This endpoint is DEPRECATED and will be sunset on March 31st 2023. Use <a href=\"https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2\">Track Event V2</a> instead.</p> <p>See <a href=\"https://docs.talon.one/docs/dev/tutorials/migrating-to-v2\">Migrating to V2</a>.</p> </div> Triggers a custom event in a customer session. You can then check this event in your rules. Before using this endpoint, create your event as a custom attribute of type `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
1138
|
|
|
710
1139
|
### Example
|
|
711
1140
|
|
|
@@ -721,9 +1150,9 @@ TalonOne.configure do |config|
|
|
|
721
1150
|
end
|
|
722
1151
|
|
|
723
1152
|
api_instance = TalonOne::IntegrationApi.new
|
|
724
|
-
body = TalonOne::NewEvent.new # NewEvent |
|
|
1153
|
+
body = TalonOne::NewEvent.new # NewEvent | body
|
|
725
1154
|
opts = {
|
|
726
|
-
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1155
|
+
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
727
1156
|
}
|
|
728
1157
|
|
|
729
1158
|
begin
|
|
@@ -740,8 +1169,8 @@ end
|
|
|
740
1169
|
|
|
741
1170
|
Name | Type | Description | Notes
|
|
742
1171
|
------------- | ------------- | ------------- | -------------
|
|
743
|
-
**body** | [**NewEvent**](NewEvent.md)|
|
|
744
|
-
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1172
|
+
**body** | [**NewEvent**](NewEvent.md)| body |
|
|
1173
|
+
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
745
1174
|
|
|
746
1175
|
### Return type
|
|
747
1176
|
|
|
@@ -763,7 +1192,7 @@ Name | Type | Description | Notes
|
|
|
763
1192
|
|
|
764
1193
|
Track event V2
|
|
765
1194
|
|
|
766
|
-
Triggers a custom event. You can
|
|
1195
|
+
Triggers a custom event. You can build a condition around this event in your rules. Talon.One offers a set of [built-in events](https://docs.talon.one/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 customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). **Important:** - `profileId` is required. An event V2 is associated with a customer profile. - Before using this endpoint, create your event as a custom attribute of type `event`. See the [Developer docs](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event). When you successfully sent an event to Talon.One, you can list received events in the **Events** view in the Campaign Manager.
|
|
767
1196
|
|
|
768
1197
|
### Example
|
|
769
1198
|
|
|
@@ -779,10 +1208,10 @@ TalonOne.configure do |config|
|
|
|
779
1208
|
end
|
|
780
1209
|
|
|
781
1210
|
api_instance = TalonOne::IntegrationApi.new
|
|
782
|
-
body = TalonOne::IntegrationEventV2Request.new # IntegrationEventV2Request |
|
|
1211
|
+
body = TalonOne::IntegrationEventV2Request.new # IntegrationEventV2Request | body
|
|
783
1212
|
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
|
|
785
|
-
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1213
|
+
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 the updated customer profiles.
|
|
1214
|
+
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
786
1215
|
}
|
|
787
1216
|
|
|
788
1217
|
begin
|
|
@@ -799,9 +1228,9 @@ end
|
|
|
799
1228
|
|
|
800
1229
|
Name | Type | Description | Notes
|
|
801
1230
|
------------- | ------------- | ------------- | -------------
|
|
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
|
|
804
|
-
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1231
|
+
**body** | [**IntegrationEventV2Request**](IntegrationEventV2Request.md)| body |
|
|
1232
|
+
**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 the updated customer profiles. | [optional] [default to 'yes']
|
|
1233
|
+
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
805
1234
|
|
|
806
1235
|
### Return type
|
|
807
1236
|
|
|
@@ -840,7 +1269,7 @@ end
|
|
|
840
1269
|
|
|
841
1270
|
api_instance = TalonOne::IntegrationApi.new
|
|
842
1271
|
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 |
|
|
1272
|
+
body = nil # Object | body
|
|
844
1273
|
|
|
845
1274
|
begin
|
|
846
1275
|
#Update profile attributes for all customers in audience
|
|
@@ -856,7 +1285,7 @@ end
|
|
|
856
1285
|
Name | Type | Description | Notes
|
|
857
1286
|
------------- | ------------- | ------------- | -------------
|
|
858
1287
|
**audience_id** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
|
|
859
|
-
**body** | **Object**|
|
|
1288
|
+
**body** | **Object**| body |
|
|
860
1289
|
|
|
861
1290
|
### Return type
|
|
862
1291
|
|
|
@@ -876,9 +1305,9 @@ nil (empty response body)
|
|
|
876
1305
|
|
|
877
1306
|
> Audience update_audience_v2(audience_id, body)
|
|
878
1307
|
|
|
879
|
-
Update audience
|
|
1308
|
+
Update audience name
|
|
880
1309
|
|
|
881
|
-
Update
|
|
1310
|
+
Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the rule engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
|
|
882
1311
|
|
|
883
1312
|
### Example
|
|
884
1313
|
|
|
@@ -895,10 +1324,10 @@ end
|
|
|
895
1324
|
|
|
896
1325
|
api_instance = TalonOne::IntegrationApi.new
|
|
897
1326
|
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 |
|
|
1327
|
+
body = TalonOne::UpdateAudience.new # UpdateAudience | body
|
|
899
1328
|
|
|
900
1329
|
begin
|
|
901
|
-
#Update audience
|
|
1330
|
+
#Update audience name
|
|
902
1331
|
result = api_instance.update_audience_v2(audience_id, body)
|
|
903
1332
|
p result
|
|
904
1333
|
rescue TalonOne::ApiError => e
|
|
@@ -912,7 +1341,7 @@ end
|
|
|
912
1341
|
Name | Type | Description | Notes
|
|
913
1342
|
------------- | ------------- | ------------- | -------------
|
|
914
1343
|
**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)|
|
|
1344
|
+
**body** | [**UpdateAudience**](UpdateAudience.md)| body |
|
|
916
1345
|
|
|
917
1346
|
### Return type
|
|
918
1347
|
|
|
@@ -950,7 +1379,7 @@ TalonOne.configure do |config|
|
|
|
950
1379
|
end
|
|
951
1380
|
|
|
952
1381
|
api_instance = TalonOne::IntegrationApi.new
|
|
953
|
-
body = TalonOne::CustomerProfileAudienceRequest.new # CustomerProfileAudienceRequest |
|
|
1382
|
+
body = TalonOne::CustomerProfileAudienceRequest.new # CustomerProfileAudienceRequest | body
|
|
954
1383
|
|
|
955
1384
|
begin
|
|
956
1385
|
#Update multiple customer profiles' audiences
|
|
@@ -965,7 +1394,7 @@ end
|
|
|
965
1394
|
|
|
966
1395
|
Name | Type | Description | Notes
|
|
967
1396
|
------------- | ------------- | ------------- | -------------
|
|
968
|
-
**body** | [**CustomerProfileAudienceRequest**](CustomerProfileAudienceRequest.md)|
|
|
1397
|
+
**body** | [**CustomerProfileAudienceRequest**](CustomerProfileAudienceRequest.md)| body |
|
|
969
1398
|
|
|
970
1399
|
### Return type
|
|
971
1400
|
|
|
@@ -987,7 +1416,7 @@ nil (empty response body)
|
|
|
987
1416
|
|
|
988
1417
|
Update customer profile
|
|
989
1418
|
|
|
990
|
-
Update
|
|
1419
|
+
Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities#customer-profile). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> 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. </div>
|
|
991
1420
|
|
|
992
1421
|
### Example
|
|
993
1422
|
|
|
@@ -1004,10 +1433,10 @@ end
|
|
|
1004
1433
|
|
|
1005
1434
|
api_instance = TalonOne::IntegrationApi.new
|
|
1006
1435
|
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 |
|
|
1436
|
+
body = TalonOne::CustomerProfileIntegrationRequestV2.new # CustomerProfileIntegrationRequestV2 | body
|
|
1008
1437
|
opts = {
|
|
1009
|
-
run_rule_engine: false, # Boolean | Indicates whether to run the
|
|
1010
|
-
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1438
|
+
run_rule_engine: false, # Boolean | Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body.
|
|
1439
|
+
dry: true # Boolean | (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run.
|
|
1011
1440
|
}
|
|
1012
1441
|
|
|
1013
1442
|
begin
|
|
@@ -1025,9 +1454,9 @@ end
|
|
|
1025
1454
|
Name | Type | Description | Notes
|
|
1026
1455
|
------------- | ------------- | ------------- | -------------
|
|
1027
1456
|
**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
|
|
1030
|
-
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1457
|
+
**body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md)| body |
|
|
1458
|
+
**run_rule_engine** | **Boolean**| Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body. | [optional] [default to false]
|
|
1459
|
+
**dry** | **Boolean**| (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. | [optional]
|
|
1031
1460
|
|
|
1032
1461
|
### Return type
|
|
1033
1462
|
|
|
@@ -1049,7 +1478,7 @@ Name | Type | Description | Notes
|
|
|
1049
1478
|
|
|
1050
1479
|
Update multiple customer profiles
|
|
1051
1480
|
|
|
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
|
|
1481
|
+
Update (or create) up to 1000 [customer profiles](https://docs.talon.one/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](https://docs.talon.one/integration-api#tag/Customer-sessions).
|
|
1053
1482
|
|
|
1054
1483
|
### Example
|
|
1055
1484
|
|
|
@@ -1065,9 +1494,9 @@ TalonOne.configure do |config|
|
|
|
1065
1494
|
end
|
|
1066
1495
|
|
|
1067
1496
|
api_instance = TalonOne::IntegrationApi.new
|
|
1068
|
-
body = TalonOne::MultipleCustomerProfileIntegrationRequest.new # MultipleCustomerProfileIntegrationRequest |
|
|
1497
|
+
body = TalonOne::MultipleCustomerProfileIntegrationRequest.new # MultipleCustomerProfileIntegrationRequest | body
|
|
1069
1498
|
opts = {
|
|
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
|
|
1499
|
+
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 the updated customer profiles.
|
|
1071
1500
|
}
|
|
1072
1501
|
|
|
1073
1502
|
begin
|
|
@@ -1084,8 +1513,8 @@ end
|
|
|
1084
1513
|
|
|
1085
1514
|
Name | Type | Description | Notes
|
|
1086
1515
|
------------- | ------------- | ------------- | -------------
|
|
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
|
|
1516
|
+
**body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md)| body |
|
|
1517
|
+
**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 the updated customer profiles. | [optional] [default to 'yes']
|
|
1089
1518
|
|
|
1090
1519
|
### Return type
|
|
1091
1520
|
|
|
@@ -1107,7 +1536,7 @@ Name | Type | Description | Notes
|
|
|
1107
1536
|
|
|
1108
1537
|
Update customer session
|
|
1109
1538
|
|
|
1110
|
-
Update or create a [customer session](/docs/dev/concepts/entities#customer-session). For example, use this endpoint to share the
|
|
1539
|
+
Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities#customer-session). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities#customer-session) and their states and refer to the `state` parameter documentation the request body schema docs below. ### 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. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
|
|
1111
1540
|
|
|
1112
1541
|
### Example
|
|
1113
1542
|
|
|
@@ -1123,10 +1552,10 @@ TalonOne.configure do |config|
|
|
|
1123
1552
|
end
|
|
1124
1553
|
|
|
1125
1554
|
api_instance = TalonOne::IntegrationApi.new
|
|
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
|
|
1127
|
-
body = TalonOne::IntegrationRequest.new # IntegrationRequest |
|
|
1555
|
+
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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
|
|
1556
|
+
body = TalonOne::IntegrationRequest.new # IntegrationRequest | body
|
|
1128
1557
|
opts = {
|
|
1129
|
-
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1558
|
+
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run.
|
|
1130
1559
|
}
|
|
1131
1560
|
|
|
1132
1561
|
begin
|
|
@@ -1143,9 +1572,9 @@ end
|
|
|
1143
1572
|
|
|
1144
1573
|
Name | Type | Description | Notes
|
|
1145
1574
|
------------- | ------------- | ------------- | -------------
|
|
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
|
|
1147
|
-
**body** | [**IntegrationRequest**](IntegrationRequest.md)|
|
|
1148
|
-
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
1575
|
+
**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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. |
|
|
1576
|
+
**body** | [**IntegrationRequest**](IntegrationRequest.md)| body |
|
|
1577
|
+
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. | [optional]
|
|
1149
1578
|
|
|
1150
1579
|
### Return type
|
|
1151
1580
|
|