talon_one 2.4.0 → 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/Makefile +43 -0
- data/README.md +325 -179
- data/docs/AcceptCouponEffectProps.md +1 -1
- data/docs/AcceptReferralEffectProps.md +1 -1
- data/docs/AccessLogEntry.md +15 -10
- data/docs/Account.md +9 -9
- data/docs/AccountAdditionalCost.md +13 -11
- data/docs/AccountAnalytics.md +37 -35
- 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/AccountEntity.md +1 -1
- data/docs/AccountLimits.md +12 -12
- data/docs/AddFreeItemEffectProps.md +3 -3
- data/docs/AddItemCatalogAction.md +23 -0
- data/docs/AddLoyaltyPoints.md +31 -0
- data/docs/AddLoyaltyPointsEffectProps.md +22 -10
- data/docs/AddedDeductedPointsNotificationPolicy.md +19 -0
- data/docs/AdditionalCost.md +1 -1
- data/docs/Application.md +33 -29
- data/docs/ApplicationAPIKey.md +16 -16
- data/docs/ApplicationApiHealth.md +3 -3
- data/docs/ApplicationCampaignStats.md +6 -6
- data/docs/ApplicationCustomer.md +16 -12
- data/docs/ApplicationCustomerEntity.md +1 -1
- data/docs/ApplicationEntity.md +1 -1
- data/docs/ApplicationEvent.md +7 -7
- data/docs/ApplicationNotification.md +17 -0
- data/docs/ApplicationReferee.md +5 -5
- data/docs/ApplicationSession.md +17 -15
- data/docs/ApplicationSessionEntity.md +1 -1
- data/docs/AsyncCouponCreationResponse.md +17 -0
- data/docs/Attribute.md +24 -14
- data/docs/Audience.md +19 -11
- 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 +31 -0
- 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/Binding.md +6 -4
- data/docs/BulkApplicationNotification.md +19 -0
- data/docs/BulkCampaignNotification.md +19 -0
- data/docs/Campaign.md +47 -37
- data/docs/CampaignActivationRequest.md +17 -0
- data/docs/CampaignAnalytics.md +8 -8
- data/docs/CampaignCollection.md +37 -0
- data/docs/CampaignCollectionWithoutPayload.md +35 -0
- data/docs/CampaignCopy.md +10 -10
- data/docs/CampaignCreatedNotification.md +21 -0
- data/docs/CampaignDeletedNotification.md +19 -0
- data/docs/CampaignEditedNotification.md +21 -0
- data/docs/CampaignEntity.md +1 -1
- data/docs/CampaignGroup.md +12 -12
- data/docs/CampaignNotification.md +17 -0
- data/docs/CampaignPrioritiesChangedNotification.md +21 -0
- data/docs/CampaignPrioritiesV2.md +21 -0
- data/docs/CampaignRulesetChangedNotification.md +21 -0
- data/docs/CampaignSearch.md +1 -1
- data/docs/CampaignSet.md +10 -8
- data/docs/CampaignSetBranchNode.md +6 -6
- data/docs/CampaignSetIDs.md +17 -0
- data/docs/CampaignSetLeafNode.md +1 -1
- data/docs/CampaignSetNode.md +1 -1
- data/docs/CampaignSetV2.md +25 -0
- data/docs/CampaignStateChangedNotification.md +23 -0
- data/docs/CampaignTemplate.md +61 -0
- data/docs/CampaignTemplateCollection.md +19 -0
- data/docs/CampaignTemplateParams.md +23 -0
- data/docs/CardLedgerTransactionLogEntry.md +41 -0
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +41 -0
- data/docs/CartItem.md +26 -18
- data/docs/Catalog.md +33 -0
- 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 +12 -10
- data/docs/ChangeProfilePassword.md +2 -2
- data/docs/CodeGeneratorSettings.md +4 -4
- data/docs/Collection.md +39 -0
- data/docs/CollectionItem.md +17 -0
- data/docs/CollectionWithoutPayload.md +37 -0
- data/docs/Coupon.md +33 -25
- data/docs/CouponConstraints.md +9 -7
- data/docs/CouponCreatedEffectProps.md +2 -2
- data/docs/CouponCreationJob.md +59 -0
- data/docs/CouponLimitConfigs.md +17 -0
- data/docs/CouponRejectionReason.md +3 -3
- data/docs/CouponReservations.md +2 -2
- data/docs/CouponSearch.md +1 -1
- data/docs/CouponValue.md +2 -2
- data/docs/CouponsNotificationPolicy.md +19 -0
- data/docs/CreateApplicationAPIKey.md +6 -6
- data/docs/CreateManagementKey.md +23 -0
- data/docs/CreateTemplateCampaign.md +31 -0
- data/docs/CreateTemplateCampaignResponse.md +21 -0
- data/docs/CustomEffect.md +14 -12
- data/docs/CustomEffectProps.md +12 -2
- data/docs/CustomerActivityReport.md +4 -4
- data/docs/CustomerAnalytics.md +7 -7
- data/docs/CustomerInventory.md +2 -2
- data/docs/CustomerProfile.md +17 -13
- data/docs/CustomerProfileAudienceRequestItem.md +6 -6
- data/docs/CustomerProfileIntegrationRequestV2.md +6 -4
- data/docs/CustomerProfileSearchQuery.md +1 -1
- data/docs/CustomerProfileUpdateV2Response.md +17 -0
- data/docs/CustomerSession.md +16 -14
- data/docs/CustomerSessionV2.md +34 -26
- data/docs/DeductLoyaltyPoints.md +23 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +10 -6
- data/docs/Effect.md +15 -13
- data/docs/EffectEntity.md +14 -12
- data/docs/EmailEntity.md +1 -1
- data/docs/Endpoint.md +17 -0
- data/docs/Entity.md +4 -4
- data/docs/EntityWithTalangVisibleID.md +2 -2
- data/docs/Environment.md +9 -7
- data/docs/ErrorResponseWithStatus.md +21 -0
- data/docs/ErrorSource.md +1 -1
- data/docs/EvaluableCampaignIds.md +17 -0
- data/docs/Event.md +11 -11
- data/docs/EventType.md +10 -24
- data/docs/EventV2.md +23 -0
- data/docs/ExpiringPointsNotificationPolicy.md +19 -0
- data/docs/ExpiringPointsNotificationTrigger.md +19 -0
- data/docs/Export.md +8 -8
- data/docs/FeatureFlag.md +7 -7
- data/docs/FeedNotification.md +6 -6
- data/docs/FrontendState.md +16 -0
- data/docs/Giveaway.md +13 -9
- data/docs/GiveawaysPool.md +11 -9
- data/docs/Import.md +11 -11
- data/docs/ImportEntity.md +1 -1
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse20010.md +2 -2
- data/docs/InlineResponse20011.md +3 -5
- data/docs/InlineResponse20012.md +2 -2
- data/docs/InlineResponse20013.md +3 -3
- data/docs/InlineResponse20014.md +4 -2
- data/docs/InlineResponse20015.md +2 -2
- data/docs/InlineResponse20016.md +5 -3
- data/docs/InlineResponse20017.md +1 -1
- data/docs/InlineResponse20018.md +2 -2
- data/docs/InlineResponse20019.md +3 -5
- data/docs/InlineResponse2002.md +2 -2
- data/docs/InlineResponse20020.md +5 -3
- data/docs/InlineResponse20021.md +5 -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 +3 -5
- data/docs/InlineResponse20028.md +5 -3
- data/docs/InlineResponse20029.md +5 -3
- data/docs/InlineResponse2003.md +2 -2
- data/docs/InlineResponse20030.md +19 -0
- data/docs/InlineResponse20031.md +19 -0
- 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 -3
- data/docs/InlineResponse2009.md +2 -2
- data/docs/InlineResponse201.md +1 -1
- data/docs/IntegrationApi.md +932 -220
- data/docs/IntegrationCoupon.md +59 -0
- data/docs/IntegrationCustomerSessionResponse.md +19 -0
- data/docs/IntegrationEntity.md +4 -4
- data/docs/IntegrationEvent.md +4 -4
- data/docs/IntegrationEventV2Request.md +25 -0
- data/docs/IntegrationProfileEntity.md +2 -2
- data/docs/IntegrationRequest.md +2 -2
- data/docs/IntegrationStateV2.md +8 -4
- data/docs/InventoryCoupon.md +36 -28
- data/docs/InventoryReferral.md +43 -0
- data/docs/ItemAttribute.md +21 -0
- data/docs/LedgerEntry.md +17 -17
- data/docs/LedgerInfo.md +31 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +39 -0
- data/docs/LimitConfig.md +8 -6
- data/docs/LimitCounter.md +45 -0
- data/docs/LoginParams.md +2 -2
- data/docs/Loyalty.md +4 -2
- data/docs/LoyaltyBalance.md +23 -0
- data/docs/LoyaltyBalances.md +19 -0
- data/docs/LoyaltyCard.md +39 -0
- data/docs/LoyaltyCardProfileRegistration.md +19 -0
- data/docs/LoyaltyCardRegistration.md +17 -0
- data/docs/LoyaltyDashboardData.md +33 -0
- data/docs/LoyaltyDashboardPointsBreakdown.md +19 -0
- data/docs/LoyaltyLedger.md +2 -2
- data/docs/LoyaltyLedgerEntry.md +19 -15
- data/docs/LoyaltyLedgerTransactions.md +19 -0
- data/docs/LoyaltyMembership.md +1 -1
- data/docs/LoyaltyProgram.md +26 -16
- data/docs/LoyaltyProgramBalance.md +12 -10
- data/docs/LoyaltyProgramEntity.md +1 -1
- data/docs/LoyaltyProgramLedgers.md +8 -8
- data/docs/LoyaltyProgramTransaction.md +49 -0
- data/docs/LoyaltyStatistics.md +18 -8
- data/docs/LoyaltySubLedger.md +13 -11
- data/docs/LoyaltyTier.md +8 -8
- data/docs/ManagementApi.md +4100 -1835
- data/docs/ManagementKey.md +31 -0
- data/docs/ModelReturn.md +37 -0
- data/docs/MultipleAttribute.md +17 -0
- data/docs/MultipleAudiences.md +19 -0
- data/docs/MultipleAudiencesItem.md +25 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +4 -4
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +1 -1
- data/docs/MultipleNewAttribute.md +17 -0
- data/docs/MultipleNewAudiences.md +17 -0
- data/docs/MutableEntity.md +2 -2
- data/docs/NewAccountSignUp.md +2 -2
- data/docs/NewAdditionalCost.md +8 -6
- data/docs/NewApplication.md +26 -22
- data/docs/NewApplicationAPIKey.md +18 -18
- data/docs/NewAttribute.md +17 -9
- data/docs/NewAudience.md +14 -6
- data/docs/NewBaseNotification.md +19 -0
- data/docs/NewCampaign.md +17 -17
- data/docs/NewCampaignCollection.md +19 -0
- data/docs/NewCampaignGroup.md +5 -5
- data/docs/NewCampaignSet.md +3 -3
- data/docs/NewCampaignSetV2.md +21 -0
- data/docs/NewCampaignTemplate.md +43 -0
- data/docs/NewCatalog.md +21 -0
- data/docs/NewCollection.md +21 -0
- data/docs/NewCouponCreationJob.md +31 -0
- data/docs/NewCoupons.md +24 -18
- data/docs/NewCouponsForMultipleRecipients.md +17 -15
- data/docs/NewCustomEffect.md +6 -4
- data/docs/NewCustomerProfile.md +2 -2
- data/docs/NewCustomerSession.md +8 -8
- data/docs/NewCustomerSessionV2.md +19 -15
- data/docs/NewEvent.md +5 -5
- data/docs/NewEventType.md +6 -20
- data/docs/NewGiveawaysPool.md +6 -4
- data/docs/NewInternalAudience.md +21 -0
- data/docs/NewInvitation.md +5 -5
- data/docs/NewLoyaltyProgram.md +21 -11
- data/docs/NewLoyaltyTier.md +3 -3
- data/docs/NewManagementKey.md +33 -0
- data/docs/NewMultipleAudiencesItem.md +19 -0
- data/docs/NewNotificationWebhook.md +19 -0
- data/docs/NewPassword.md +2 -2
- data/docs/NewPicklist.md +19 -0
- data/docs/NewReferral.md +10 -10
- data/docs/NewReferralsForMultipleAdvocates.md +13 -13
- data/docs/NewReturn.md +17 -0
- data/docs/NewRole.md +8 -8
- data/docs/NewRuleset.md +7 -5
- data/docs/NewSamlConnection.md +1 -1
- data/docs/NewUser.md +3 -3
- data/docs/NewWebhook.md +16 -14
- data/docs/Notification.md +3 -3
- data/docs/NotificationWebhook.md +27 -0
- 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 +19 -19
- data/docs/ReferralConstraints.md +5 -5
- 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 +19 -0
- data/docs/ReturnedCartItem.md +19 -0
- data/docs/Role.md +17 -17
- 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 +12 -6
- data/docs/RollbackCouponEffectProps.md +1 -1
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +11 -9
- data/docs/RollbackDiscountEffectProps.md +13 -3
- data/docs/RollbackReferralEffectProps.md +1 -1
- data/docs/Rule.md +8 -4
- data/docs/RuleFailureReason.md +13 -13
- data/docs/Ruleset.md +17 -13
- data/docs/SamlConnection.md +5 -5
- data/docs/Session.md +5 -5
- data/docs/SetDiscountEffectProps.md +6 -4
- data/docs/SetDiscountPerAdditionalCostEffectProps.md +25 -0
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +29 -0
- data/docs/SetDiscountPerItemEffectProps.md +17 -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 +5 -5
- data/docs/TemplateLimitConfig.md +23 -0
- data/docs/Tier.md +19 -0
- data/docs/TransferLoyaltyCard.md +17 -0
- data/docs/TriggerWebhookEffectProps.md +2 -2
- data/docs/UpdateAccount.md +2 -2
- data/docs/UpdateApplication.md +25 -21
- data/docs/UpdateAttributeEffectProps.md +2 -2
- data/docs/UpdateAudience.md +2 -2
- data/docs/UpdateCampaign.md +15 -15
- data/docs/UpdateCampaignCollection.md +17 -0
- data/docs/UpdateCampaignGroup.md +5 -5
- data/docs/UpdateCampaignTemplate.md +47 -0
- data/docs/UpdateCatalog.md +21 -0
- data/docs/UpdateCollection.md +19 -0
- data/docs/UpdateCoupon.md +17 -11
- data/docs/UpdateCouponBatch.md +11 -9
- data/docs/UpdateCustomEffect.md +6 -4
- data/docs/UpdateLoyaltyCard.md +17 -0
- data/docs/UpdateLoyaltyProgram.md +15 -9
- data/docs/UpdatePicklist.md +19 -0
- data/docs/UpdateReferral.md +7 -7
- data/docs/UpdateReferralBatch.md +25 -0
- data/docs/UpdateRole.md +8 -8
- data/docs/UpdateUser.md +7 -7
- data/docs/UpdateUserLatestFeedTimestamp.md +1 -1
- data/docs/User.md +17 -17
- data/docs/UserEntity.md +2 -2
- data/docs/UserFeedNotifications.md +2 -2
- data/docs/Webhook.md +22 -20
- 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 +1168 -231
- data/lib/talon_one/api/management_api.rb +5076 -2861
- data/lib/talon_one/api_client.rb +2 -2
- data/lib/talon_one/api_error.rb +2 -2
- data/lib/talon_one/configuration.rb +8 -8
- 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 +98 -10
- data/lib/talon_one/models/account_analytics.rb +39 -24
- 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 +109 -15
- 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 +53 -17
- data/lib/talon_one/models/application_api_health.rb +5 -5
- data/lib/talon_one/models/application_api_key.rb +12 -12
- data/lib/talon_one/models/application_campaign_stats.rb +9 -9
- data/lib/talon_one/models/application_customer.rb +68 -14
- 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 +212 -0
- data/lib/talon_one/models/application_referee.rb +44 -6
- data/lib/talon_one/models/application_session.rb +60 -11
- data/lib/talon_one/models/application_session_entity.rb +2 -2
- data/lib/talon_one/models/async_coupon_creation_response.rb +212 -0
- data/lib/talon_one/models/attribute.rb +108 -9
- 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 +57 -56
- 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/audience_integration_id.rb +231 -0
- data/lib/talon_one/models/audience_membership.rb +2 -2
- data/lib/talon_one/models/award_giveaway_effect_props.rb +21 -2
- data/lib/talon_one/models/base_loyalty_program.rb +294 -0
- 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 +17 -7
- data/lib/talon_one/models/bulk_application_notification.rb +227 -0
- data/lib/talon_one/models/bulk_campaign_notification.rb +227 -0
- data/lib/talon_one/models/campaign.rb +66 -16
- 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 +370 -0
- data/lib/talon_one/models/campaign_collection_without_payload.rb +358 -0
- data/lib/talon_one/models/campaign_copy.rb +6 -6
- data/lib/talon_one/models/campaign_created_notification.rb +235 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +227 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +235 -0
- 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 +212 -0
- data/lib/talon_one/models/campaign_priorities_changed_notification.rb +236 -0
- data/lib/talon_one/models/campaign_priorities_v2.rb +230 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +230 -0
- 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 +208 -0
- 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 +291 -0
- data/lib/talon_one/models/campaign_state_changed_notification.rb +251 -0
- data/lib/talon_one/models/campaign_template.rb +543 -0
- data/lib/talon_one/models/campaign_template_collection.rb +252 -0
- data/lib/talon_one/models/campaign_template_params.rb +305 -0
- 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 +59 -41
- data/lib/talon_one/models/catalog.rb +330 -0
- 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 +4 -4
- data/lib/talon_one/models/collection.rb +382 -0
- data/lib/talon_one/models/collection_item.rb +212 -0
- data/lib/talon_one/models/collection_without_payload.rb +370 -0
- data/lib/talon_one/models/coupon.rb +100 -15
- data/lib/talon_one/models/coupon_constraints.rb +40 -6
- data/lib/talon_one/models/coupon_created_effect_props.rb +4 -4
- data/lib/talon_one/models/coupon_creation_job.rb +603 -0
- data/lib/talon_one/models/coupon_limit_configs.rb +209 -0
- 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 +3 -3
- data/lib/talon_one/models/coupons_notification_policy.rb +269 -0
- data/lib/talon_one/models/create_application_api_key.rb +7 -7
- data/lib/talon_one/models/create_management_key.rb +256 -0
- data/lib/talon_one/models/create_template_campaign.rb +314 -0
- data/lib/talon_one/models/create_template_campaign_response.rb +236 -0
- data/lib/talon_one/models/custom_effect.rb +76 -19
- data/lib/talon_one/models/custom_effect_props.rb +67 -12
- data/lib/talon_one/models/customer_activity_report.rb +24 -5
- data/lib/talon_one/models/customer_analytics.rb +10 -10
- data/lib/talon_one/models/customer_inventory.rb +4 -3
- data/lib/talon_one/models/customer_profile.rb +66 -22
- data/lib/talon_one/models/customer_profile_audience_request.rb +2 -2
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +24 -2
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +17 -5
- data/lib/talon_one/models/customer_profile_search_query.rb +3 -3
- data/lib/talon_one/models/customer_profile_update_v2_response.rb +212 -0
- data/lib/talon_one/models/customer_session.rb +47 -13
- data/lib/talon_one/models/customer_session_v2.rb +103 -30
- data/lib/talon_one/models/{loyalty_points.rb → deduct_loyalty_points.rb} +28 -38
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +51 -11
- 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 +24 -11
- 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 +228 -0
- 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 +11 -154
- data/lib/talon_one/models/event_v2.rb +264 -0
- 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 +8 -8
- 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 +29 -9
- data/lib/talon_one/models/giveaways_pool.rb +22 -7
- data/lib/talon_one/models/import.rb +7 -7
- 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 +3 -3
- data/lib/talon_one/models/inline_response20011.rb +9 -13
- data/lib/talon_one/models/inline_response20012.rb +3 -3
- data/lib/talon_one/models/inline_response20013.rb +15 -13
- data/lib/talon_one/models/inline_response20014.rb +13 -9
- data/lib/talon_one/models/inline_response20015.rb +8 -3
- data/lib/talon_one/models/inline_response20016.rb +13 -9
- data/lib/talon_one/models/inline_response20017.rb +3 -3
- data/lib/talon_one/models/inline_response20018.rb +3 -3
- data/lib/talon_one/models/inline_response20019.rb +9 -13
- data/lib/talon_one/models/inline_response2002.rb +3 -3
- data/lib/talon_one/models/inline_response20020.rb +13 -9
- data/lib/talon_one/models/inline_response20021.rb +13 -9
- 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 +9 -13
- data/lib/talon_one/models/inline_response20028.rb +13 -9
- data/lib/talon_one/models/inline_response20029.rb +13 -9
- data/lib/talon_one/models/inline_response2003.rb +3 -3
- data/lib/talon_one/models/inline_response20030.rb +227 -0
- data/lib/talon_one/models/inline_response20031.rb +227 -0
- data/lib/talon_one/models/inline_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 +13 -13
- data/lib/talon_one/models/inline_response2009.rb +3 -3
- 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 +217 -0
- data/lib/talon_one/models/integration_entity.rb +23 -4
- data/lib/talon_one/models/integration_event.rb +3 -3
- data/lib/talon_one/models/integration_event_v2_request.rb +298 -0
- 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 +30 -9
- data/lib/talon_one/models/inventory_coupon.rb +98 -13
- data/lib/talon_one/models/inventory_referral.rb +446 -0
- 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 +302 -0
- 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 +28 -6
- data/lib/talon_one/models/limit_counter.rb +398 -0
- data/lib/talon_one/models/login_params.rb +2 -2
- data/lib/talon_one/models/loyalty.rb +16 -4
- data/lib/talon_one/models/loyalty_balance.rb +238 -0
- data/lib/talon_one/models/{new_feature_flags.rb → loyalty_balances.rb} +22 -30
- data/lib/talon_one/models/loyalty_card.rb +419 -0
- data/lib/talon_one/models/loyalty_card_profile_registration.rb +246 -0
- data/lib/talon_one/models/loyalty_card_registration.rb +212 -0
- data/lib/talon_one/models/loyalty_dashboard_data.rb +331 -0
- data/lib/talon_one/models/loyalty_dashboard_points_breakdown.rb +225 -0
- data/lib/talon_one/models/loyalty_ledger.rb +4 -4
- data/lib/talon_one/models/loyalty_ledger_entry.rb +27 -13
- 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 +143 -37
- 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 +8 -8
- data/lib/talon_one/models/loyalty_program_transaction.rb +553 -0
- data/lib/talon_one/models/loyalty_statistics.rb +83 -10
- data/lib/talon_one/models/loyalty_sub_ledger.rb +26 -17
- data/lib/talon_one/models/loyalty_tier.rb +10 -10
- 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 +384 -0
- data/lib/talon_one/models/multi_application_entity.rb +2 -2
- data/lib/talon_one/models/multiple_attribute.rb +208 -0
- data/lib/talon_one/models/{feature_flags.rb → multiple_audiences.rb} +19 -34
- 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 +23 -4
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +3 -3
- data/lib/talon_one/models/multiple_new_attribute.rb +208 -0
- 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 +96 -8
- data/lib/talon_one/models/new_application.rb +50 -14
- data/lib/talon_one/models/new_application_api_key.rb +13 -13
- data/lib/talon_one/models/new_attribute.rb +97 -7
- data/lib/talon_one/models/new_audience.rb +56 -54
- data/lib/talon_one/models/new_base_notification.rb +226 -0
- data/lib/talon_one/models/new_campaign.rb +10 -10
- data/lib/talon_one/models/new_campaign_collection.rb +253 -0
- 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 +261 -0
- data/lib/talon_one/models/new_campaign_template.rb +418 -0
- data/lib/talon_one/models/new_catalog.rb +240 -0
- data/lib/talon_one/models/new_collection.rb +265 -0
- data/lib/talon_one/models/new_coupon_creation_job.rb +396 -0
- data/lib/talon_one/models/new_coupons.rb +87 -14
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +44 -10
- data/lib/talon_one/models/new_custom_effect.rb +74 -16
- data/lib/talon_one/models/new_customer_profile.rb +3 -3
- data/lib/talon_one/models/new_customer_session.rb +7 -7
- data/lib/talon_one/models/new_customer_session_v2.rb +38 -14
- data/lib/talon_one/models/new_event.rb +3 -3
- data/lib/talon_one/models/new_event_type.rb +9 -152
- data/lib/talon_one/models/new_giveaways_pool.rb +22 -7
- data/lib/talon_one/models/{update_loyalty_tier.rb → new_internal_audience.rb} +34 -39
- 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 +128 -25
- data/lib/talon_one/models/new_loyalty_tier.rb +9 -9
- 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 +229 -0
- 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 +24 -5
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +7 -7
- data/lib/talon_one/models/new_return.rb +214 -0
- data/lib/talon_one/models/new_role.rb +17 -17
- data/lib/talon_one/models/new_ruleset.rb +17 -5
- 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 +30 -9
- data/lib/talon_one/models/notification.rb +5 -5
- data/lib/talon_one/models/notification_webhook.rb +290 -0
- 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 +27 -8
- data/lib/talon_one/models/referral_constraints.rb +4 -4
- 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 +246 -0
- data/lib/talon_one/models/returned_cart_item.rb +222 -0
- 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 +74 -10
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +3 -3
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +57 -13
- data/lib/talon_one/models/rollback_discount_effect_props.rb +59 -9
- 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 +15 -15
- data/lib/talon_one/models/ruleset.rb +40 -23
- 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 +4 -4
- data/lib/talon_one/models/set_discount_effect_props.rb +19 -9
- data/lib/talon_one/models/set_discount_per_additional_cost_effect_props.rb +268 -0
- data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +293 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +71 -11
- 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/{application_customer_search.rb → talang_attribute_visibility.rb} +22 -30
- 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 +308 -0
- data/lib/talon_one/models/tier.rb +227 -0
- 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 +52 -16
- data/lib/talon_one/models/update_attribute_effect_props.rb +4 -4
- data/lib/talon_one/models/update_audience.rb +3 -3
- data/lib/talon_one/models/update_campaign.rb +7 -7
- data/lib/talon_one/models/update_campaign_collection.rb +207 -0
- data/lib/talon_one/models/update_campaign_group.rb +4 -4
- data/lib/talon_one/models/update_campaign_template.rb +445 -0
- data/lib/talon_one/models/update_catalog.rb +229 -0
- data/lib/talon_one/models/update_collection.rb +219 -0
- data/lib/talon_one/models/update_coupon.rb +84 -11
- data/lib/talon_one/models/update_coupon_batch.rb +39 -10
- data/lib/talon_one/models/update_custom_effect.rb +73 -16
- data/lib/talon_one/models/update_loyalty_card.rb +212 -0
- data/lib/talon_one/models/update_loyalty_program.rb +57 -10
- data/lib/talon_one/models/update_picklist.rb +264 -0
- data/lib/talon_one/models/update_referral.rb +20 -5
- data/lib/talon_one/models/update_referral_batch.rb +276 -0
- data/lib/talon_one/models/update_role.rb +14 -14
- 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 +33 -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 +21 -2
- data/lib/talon_one/version.rb +3 -3
- data/lib/talon_one.rb +153 -7
- data/spec/api/integration_api_spec.rb +249 -72
- data/spec/api/management_api_spec.rb +951 -580
- 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 +12 -2
- data/spec/models/account_analytics_spec.rb +8 -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/add_item_catalog_action_spec.rb +59 -0
- data/spec/models/add_loyalty_points_effect_props_spec.rb +38 -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 +14 -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 +41 -0
- 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 +9 -3
- data/spec/models/application_spec.rb +18 -2
- data/spec/models/async_coupon_creation_response_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +36 -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 -6
- data/spec/models/award_giveaway_effect_props_spec.rb +2 -2
- data/spec/models/base_loyalty_program_spec.rb +83 -0
- data/spec/models/base_notification_entity_spec.rb +41 -0
- data/spec/models/base_notification_spec.rb +53 -0
- 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 +8 -2
- data/spec/models/bulk_application_notification_spec.rb +47 -0
- data/spec/models/bulk_campaign_notification_spec.rb +47 -0
- 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 +101 -0
- data/spec/models/campaign_collection_without_payload_spec.rb +95 -0
- data/spec/models/campaign_copy_spec.rb +2 -2
- data/spec/models/campaign_created_notification_spec.rb +53 -0
- data/spec/models/campaign_deleted_notification_spec.rb +47 -0
- data/spec/models/campaign_edited_notification_spec.rb +53 -0
- 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 +41 -0
- data/spec/models/campaign_priorities_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_priorities_v2_spec.rb +53 -0
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_search_spec.rb +2 -2
- data/spec/models/campaign_set_branch_node_spec.rb +2 -2
- data/spec/models/campaign_set_i_ds_spec.rb +41 -0
- 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 +65 -0
- data/spec/models/campaign_spec.rb +33 -3
- data/spec/models/campaign_state_changed_notification_spec.rb +59 -0
- data/spec/models/campaign_template_collection_spec.rb +47 -0
- data/spec/models/campaign_template_params_spec.rb +63 -0
- data/spec/models/campaign_template_spec.rb +181 -0
- 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 +26 -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 +89 -0
- 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 +107 -0
- data/spec/models/collection_without_payload_spec.rb +101 -0
- 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 +167 -0
- data/spec/models/coupon_limit_configs_spec.rb +41 -0
- 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 +26 -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 +53 -0
- data/spec/models/create_template_campaign_spec.rb +83 -0
- data/spec/models/custom_effect_props_spec.rb +33 -3
- data/spec/models/custom_effect_spec.rb +14 -8
- 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 +15 -3
- data/spec/models/customer_profile_update_v2_response_spec.rb +41 -0
- data/spec/models/customer_session_spec.rb +9 -3
- data/spec/models/customer_session_v2_spec.rb +28 -4
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +14 -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 +9 -3
- 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 +53 -0
- 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 -52
- data/spec/models/event_v2_spec.rb +59 -0
- 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 +3 -3
- 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 +2 -2
- data/spec/models/inline_response20011_spec.rb +2 -8
- data/spec/models/inline_response20012_spec.rb +2 -2
- data/spec/models/inline_response20013_spec.rb +3 -3
- 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 +2 -2
- data/spec/models/inline_response20019_spec.rb +2 -8
- data/spec/models/inline_response2001_spec.rb +3 -3
- data/spec/models/inline_response20020_spec.rb +8 -2
- data/spec/models/inline_response20021_spec.rb +8 -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 -8
- data/spec/models/inline_response20028_spec.rb +8 -2
- data/spec/models/inline_response20029_spec.rb +8 -2
- data/spec/models/inline_response2002_spec.rb +2 -2
- data/spec/models/inline_response20030_spec.rb +47 -0
- data/spec/models/inline_response20031_spec.rb +47 -0
- 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 +3 -3
- data/spec/models/inline_response2009_spec.rb +2 -2
- 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 +47 -0
- 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 +69 -0
- data/spec/models/integration_profile_entity_spec.rb +2 -2
- data/spec/models/integration_request_spec.rb +3 -3
- data/spec/models/integration_state_spec.rb +2 -2
- data/spec/models/integration_state_v2_spec.rb +14 -2
- data/spec/models/inventory_coupon_spec.rb +26 -2
- data/spec/models/inventory_referral_spec.rb +119 -0
- 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 +83 -0
- 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 +12 -2
- data/spec/models/limit_counter_spec.rb +125 -0
- 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 +47 -0
- data/spec/models/loyalty_card_registration_spec.rb +41 -0
- data/spec/models/loyalty_card_spec.rb +107 -0
- data/spec/models/loyalty_dashboard_data_spec.rb +89 -0
- data/spec/models/loyalty_dashboard_points_breakdown_spec.rb +47 -0
- data/spec/models/loyalty_ledger_entry_spec.rb +14 -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 +39 -9
- data/spec/models/loyalty_program_transaction_spec.rb +141 -0
- data/spec/models/loyalty_spec.rb +8 -2
- data/spec/models/loyalty_statistics_spec.rb +32 -2
- data/spec/models/loyalty_sub_ledger_spec.rb +8 -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 +101 -0
- data/spec/models/multi_application_entity_spec.rb +2 -2
- data/spec/models/multiple_attribute_spec.rb +41 -0
- 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 +41 -0
- 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 +12 -2
- data/spec/models/new_application_api_key_spec.rb +3 -3
- data/spec/models/new_application_spec.rb +18 -2
- data/spec/models/new_attribute_spec.rb +30 -2
- data/spec/models/new_audience_spec.rb +26 -6
- data/spec/models/new_base_notification_spec.rb +47 -0
- data/spec/models/new_campaign_collection_spec.rb +47 -0
- 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 +53 -0
- data/spec/models/new_campaign_spec.rb +3 -3
- data/spec/models/new_campaign_template_spec.rb +127 -0
- data/spec/models/new_catalog_spec.rb +53 -0
- data/spec/models/new_collection_spec.rb +53 -0
- data/spec/models/new_coupon_creation_job_spec.rb +83 -0
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +8 -2
- data/spec/models/new_coupons_spec.rb +20 -2
- data/spec/models/new_custom_effect_spec.rb +14 -8
- data/spec/models/new_customer_profile_spec.rb +2 -2
- data/spec/models/new_customer_session_spec.rb +3 -3
- data/spec/models/new_customer_session_v2_spec.rb +15 -3
- data/spec/models/new_event_spec.rb +2 -2
- data/spec/models/new_event_type_spec.rb +2 -52
- 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 +38 -8
- 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 +47 -0
- 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 +41 -0
- data/spec/models/new_role_spec.rb +3 -3
- 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 +71 -0
- 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 +51 -0
- data/spec/models/returned_cart_item_spec.rb +47 -0
- 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/role_v2_spec.rb +65 -0
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +20 -2
- data/spec/models/rollback_coupon_effect_props_spec.rb +2 -2
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +8 -2
- data/spec/models/rollback_discount_effect_props_spec.rb +32 -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 +17 -5
- 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 +8 -2
- data/spec/models/set_discount_per_additional_cost_effect_props_spec.rb +65 -0
- data/spec/models/set_discount_per_additional_cost_per_item_effect_props_spec.rb +77 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +38 -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 +67 -0
- data/spec/models/tier_spec.rb +47 -0
- 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 +18 -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 +41 -0
- 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 +139 -0
- data/spec/models/update_catalog_spec.rb +53 -0
- data/spec/models/update_collection_spec.rb +47 -0
- data/spec/models/update_coupon_batch_spec.rb +8 -2
- data/spec/models/update_coupon_spec.rb +20 -2
- data/spec/models/update_custom_effect_spec.rb +14 -8
- data/spec/models/update_loyalty_card_spec.rb +41 -0
- data/spec/models/update_loyalty_program_spec.rb +20 -2
- data/spec/models/update_picklist_spec.rb +51 -0
- data/spec/models/update_referral_batch_spec.rb +65 -0
- data/spec/models/update_referral_spec.rb +2 -2
- data/spec/models/update_role_spec.rb +3 -3
- 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 +828 -243
- data/docs/ApplicationCustomerSearch.md +0 -21
- data/docs/FeatureFlags.md +0 -23
- data/docs/LoyaltyPoints.md +0 -25
- data/docs/NewFeatureFlags.md +0 -21
- data/docs/UpdateLoyaltyTier.md +0 -19
- data/spec/models/application_customer_search_spec.rb +0 -53
- data/spec/models/feature_flags_spec.rb +0 -59
- data/spec/models/loyalty_points_spec.rb +0 -65
- data/spec/models/new_feature_flags_spec.rb +0 -53
- data/spec/models/update_loyalty_tier_spec.rb +0 -47
data/docs/IntegrationApi.md
CHANGED
|
@@ -1,33 +1,46 @@
|
|
|
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
|
------------- | ------------- | -------------
|
|
7
|
-
[**
|
|
8
|
-
[**
|
|
7
|
+
[**create_audience_v2**](IntegrationApi.md#create_audience_v2) | **POST** /v2/audiences | Create audience
|
|
8
|
+
[**create_coupon_reservation**](IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create coupon reservation
|
|
9
|
+
[**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create referral code for an advocate
|
|
9
10
|
[**create_referrals_for_multiple_advocates**](IntegrationApi.md#create_referrals_for_multiple_advocates) | **POST** /v1/referrals_for_multiple_advocates | Create referral codes for multiple advocates
|
|
11
|
+
[**delete_audience_memberships_v2**](IntegrationApi.md#delete_audience_memberships_v2) | **DELETE** /v2/audiences/{audienceId}/memberships | Delete audience memberships
|
|
12
|
+
[**delete_audience_v2**](IntegrationApi.md#delete_audience_v2) | **DELETE** /v2/audiences/{audienceId} | Delete audience
|
|
10
13
|
[**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
|
11
|
-
[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete
|
|
12
|
-
[**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory |
|
|
13
|
-
[**
|
|
14
|
-
[**
|
|
15
|
-
[**
|
|
16
|
-
[**
|
|
17
|
-
[**
|
|
18
|
-
[**
|
|
19
|
-
[**
|
|
20
|
-
[**
|
|
14
|
+
[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete customer's personal data
|
|
15
|
+
[**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data
|
|
16
|
+
[**get_customer_session**](IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session
|
|
17
|
+
[**get_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
|
|
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
|
|
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
|
|
26
|
+
[**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track event
|
|
27
|
+
[**track_event_v2**](IntegrationApi.md#track_event_v2) | **POST** /v2/events | Track event V2
|
|
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
|
|
29
|
+
[**update_audience_v2**](IntegrationApi.md#update_audience_v2) | **PUT** /v2/audiences/{audienceId} | Update audience name
|
|
30
|
+
[**update_customer_profile_audiences**](IntegrationApi.md#update_customer_profile_audiences) | **POST** /v2/customer_audiences | Update multiple customer profiles' audiences
|
|
31
|
+
[**update_customer_profile_v2**](IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{integrationId} | Update customer profile
|
|
32
|
+
[**update_customer_profiles_v2**](IntegrationApi.md#update_customer_profiles_v2) | **PUT** /v2/customer_profiles | Update multiple customer profiles
|
|
33
|
+
[**update_customer_session_v2**](IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update customer session
|
|
21
34
|
|
|
22
35
|
|
|
23
36
|
|
|
24
|
-
##
|
|
37
|
+
## create_audience_v2
|
|
25
38
|
|
|
26
|
-
>
|
|
39
|
+
> Audience create_audience_v2(body)
|
|
27
40
|
|
|
28
|
-
Create
|
|
41
|
+
Create audience
|
|
29
42
|
|
|
30
|
-
|
|
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.
|
|
31
44
|
|
|
32
45
|
### Example
|
|
33
46
|
|
|
@@ -40,19 +53,68 @@ TalonOne.configure do |config|
|
|
|
40
53
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
41
54
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
42
55
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
59
|
+
body = TalonOne::NewAudience.new # NewAudience | body
|
|
60
|
+
|
|
61
|
+
begin
|
|
62
|
+
#Create audience
|
|
63
|
+
result = api_instance.create_audience_v2(body)
|
|
64
|
+
p result
|
|
65
|
+
rescue TalonOne::ApiError => e
|
|
66
|
+
puts "Exception when calling IntegrationApi->create_audience_v2: #{e}"
|
|
67
|
+
end
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Parameters
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
Name | Type | Description | Notes
|
|
74
|
+
------------- | ------------- | ------------- | -------------
|
|
75
|
+
**body** | [**NewAudience**](NewAudience.md)| body |
|
|
76
|
+
|
|
77
|
+
### Return type
|
|
78
|
+
|
|
79
|
+
[**Audience**](Audience.md)
|
|
80
|
+
|
|
81
|
+
### Authorization
|
|
82
|
+
|
|
83
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
84
|
+
|
|
85
|
+
### HTTP request headers
|
|
86
|
+
|
|
87
|
+
- **Content-Type**: application/json
|
|
88
|
+
- **Accept**: application/json
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
## create_coupon_reservation
|
|
43
92
|
|
|
44
|
-
|
|
45
|
-
|
|
93
|
+
> Coupon create_coupon_reservation(coupon_value, body)
|
|
94
|
+
|
|
95
|
+
Create coupon reservation
|
|
96
|
+
|
|
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.
|
|
98
|
+
|
|
99
|
+
### Example
|
|
100
|
+
|
|
101
|
+
```ruby
|
|
102
|
+
# load the gem
|
|
103
|
+
require 'talon_one'
|
|
104
|
+
# setup authorization
|
|
105
|
+
TalonOne.configure do |config|
|
|
106
|
+
# Configure API key authorization: api_key_v1
|
|
107
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
46
108
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
47
|
-
#config.api_key_prefix['
|
|
109
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
48
110
|
end
|
|
49
111
|
|
|
50
112
|
api_instance = TalonOne::IntegrationApi.new
|
|
51
|
-
coupon_value = 'coupon_value_example' # String | The
|
|
52
|
-
body = TalonOne::CouponReservations.new # CouponReservations |
|
|
113
|
+
coupon_value = 'coupon_value_example' # String | The code of the coupon.
|
|
114
|
+
body = TalonOne::CouponReservations.new # CouponReservations | body
|
|
53
115
|
|
|
54
116
|
begin
|
|
55
|
-
#Create
|
|
117
|
+
#Create coupon reservation
|
|
56
118
|
result = api_instance.create_coupon_reservation(coupon_value, body)
|
|
57
119
|
p result
|
|
58
120
|
rescue TalonOne::ApiError => e
|
|
@@ -65,8 +127,8 @@ end
|
|
|
65
127
|
|
|
66
128
|
Name | Type | Description | Notes
|
|
67
129
|
------------- | ------------- | ------------- | -------------
|
|
68
|
-
**coupon_value** | **String**| The
|
|
69
|
-
**body** | [**CouponReservations**](CouponReservations.md)|
|
|
130
|
+
**coupon_value** | **String**| The code of the coupon. |
|
|
131
|
+
**body** | [**CouponReservations**](CouponReservations.md)| body |
|
|
70
132
|
|
|
71
133
|
### Return type
|
|
72
134
|
|
|
@@ -74,7 +136,7 @@ Name | Type | Description | Notes
|
|
|
74
136
|
|
|
75
137
|
### Authorization
|
|
76
138
|
|
|
77
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
139
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
78
140
|
|
|
79
141
|
### HTTP request headers
|
|
80
142
|
|
|
@@ -86,7 +148,7 @@ Name | Type | Description | Notes
|
|
|
86
148
|
|
|
87
149
|
> Referral create_referral(body)
|
|
88
150
|
|
|
89
|
-
Create
|
|
151
|
+
Create referral code for an advocate
|
|
90
152
|
|
|
91
153
|
Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
|
|
92
154
|
|
|
@@ -101,18 +163,13 @@ TalonOne.configure do |config|
|
|
|
101
163
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
102
164
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
103
165
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
104
|
-
|
|
105
|
-
# Configure API key authorization: integration_auth
|
|
106
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
107
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
108
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
109
166
|
end
|
|
110
167
|
|
|
111
168
|
api_instance = TalonOne::IntegrationApi.new
|
|
112
|
-
body = TalonOne::NewReferral.new # NewReferral |
|
|
169
|
+
body = TalonOne::NewReferral.new # NewReferral | body
|
|
113
170
|
|
|
114
171
|
begin
|
|
115
|
-
#Create
|
|
172
|
+
#Create referral code for an advocate
|
|
116
173
|
result = api_instance.create_referral(body)
|
|
117
174
|
p result
|
|
118
175
|
rescue TalonOne::ApiError => e
|
|
@@ -125,7 +182,7 @@ end
|
|
|
125
182
|
|
|
126
183
|
Name | Type | Description | Notes
|
|
127
184
|
------------- | ------------- | ------------- | -------------
|
|
128
|
-
**body** | [**NewReferral**](NewReferral.md)|
|
|
185
|
+
**body** | [**NewReferral**](NewReferral.md)| body |
|
|
129
186
|
|
|
130
187
|
### Return type
|
|
131
188
|
|
|
@@ -133,7 +190,7 @@ Name | Type | Description | Notes
|
|
|
133
190
|
|
|
134
191
|
### Authorization
|
|
135
192
|
|
|
136
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
193
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
137
194
|
|
|
138
195
|
### HTTP request headers
|
|
139
196
|
|
|
@@ -160,17 +217,12 @@ TalonOne.configure do |config|
|
|
|
160
217
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
161
218
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
162
219
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
163
|
-
|
|
164
|
-
# Configure API key authorization: integration_auth
|
|
165
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
166
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
167
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
168
220
|
end
|
|
169
221
|
|
|
170
222
|
api_instance = TalonOne::IntegrationApi.new
|
|
171
|
-
body = TalonOne::NewReferralsForMultipleAdvocates.new # NewReferralsForMultipleAdvocates |
|
|
223
|
+
body = TalonOne::NewReferralsForMultipleAdvocates.new # NewReferralsForMultipleAdvocates | body
|
|
172
224
|
opts = {
|
|
173
|
-
silent: '
|
|
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.
|
|
174
226
|
}
|
|
175
227
|
|
|
176
228
|
begin
|
|
@@ -187,8 +239,8 @@ end
|
|
|
187
239
|
|
|
188
240
|
Name | Type | Description | Notes
|
|
189
241
|
------------- | ------------- | ------------- | -------------
|
|
190
|
-
**body** | [**NewReferralsForMultipleAdvocates**](NewReferralsForMultipleAdvocates.md)|
|
|
191
|
-
**silent** | **String**|
|
|
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']
|
|
192
244
|
|
|
193
245
|
### Return type
|
|
194
246
|
|
|
@@ -196,7 +248,7 @@ Name | Type | Description | Notes
|
|
|
196
248
|
|
|
197
249
|
### Authorization
|
|
198
250
|
|
|
199
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
251
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
200
252
|
|
|
201
253
|
### HTTP request headers
|
|
202
254
|
|
|
@@ -204,13 +256,119 @@ Name | Type | Description | Notes
|
|
|
204
256
|
- **Accept**: application/json
|
|
205
257
|
|
|
206
258
|
|
|
259
|
+
## delete_audience_memberships_v2
|
|
260
|
+
|
|
261
|
+
> delete_audience_memberships_v2(audience_id)
|
|
262
|
+
|
|
263
|
+
Delete audience memberships
|
|
264
|
+
|
|
265
|
+
Remove all members from this audience.
|
|
266
|
+
|
|
267
|
+
### Example
|
|
268
|
+
|
|
269
|
+
```ruby
|
|
270
|
+
# load the gem
|
|
271
|
+
require 'talon_one'
|
|
272
|
+
# setup authorization
|
|
273
|
+
TalonOne.configure do |config|
|
|
274
|
+
# Configure API key authorization: api_key_v1
|
|
275
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
276
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
277
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
281
|
+
audience_id = 56 # Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
|
|
282
|
+
|
|
283
|
+
begin
|
|
284
|
+
#Delete audience memberships
|
|
285
|
+
api_instance.delete_audience_memberships_v2(audience_id)
|
|
286
|
+
rescue TalonOne::ApiError => e
|
|
287
|
+
puts "Exception when calling IntegrationApi->delete_audience_memberships_v2: #{e}"
|
|
288
|
+
end
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### Parameters
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
Name | Type | Description | Notes
|
|
295
|
+
------------- | ------------- | ------------- | -------------
|
|
296
|
+
**audience_id** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
|
|
297
|
+
|
|
298
|
+
### Return type
|
|
299
|
+
|
|
300
|
+
nil (empty response body)
|
|
301
|
+
|
|
302
|
+
### Authorization
|
|
303
|
+
|
|
304
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
305
|
+
|
|
306
|
+
### HTTP request headers
|
|
307
|
+
|
|
308
|
+
- **Content-Type**: Not defined
|
|
309
|
+
- **Accept**: application/json
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
## delete_audience_v2
|
|
313
|
+
|
|
314
|
+
> delete_audience_v2(audience_id)
|
|
315
|
+
|
|
316
|
+
Delete audience
|
|
317
|
+
|
|
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).
|
|
319
|
+
|
|
320
|
+
### Example
|
|
321
|
+
|
|
322
|
+
```ruby
|
|
323
|
+
# load the gem
|
|
324
|
+
require 'talon_one'
|
|
325
|
+
# setup authorization
|
|
326
|
+
TalonOne.configure do |config|
|
|
327
|
+
# Configure API key authorization: api_key_v1
|
|
328
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
329
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
330
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
331
|
+
end
|
|
332
|
+
|
|
333
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
334
|
+
audience_id = 56 # Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
|
|
335
|
+
|
|
336
|
+
begin
|
|
337
|
+
#Delete audience
|
|
338
|
+
api_instance.delete_audience_v2(audience_id)
|
|
339
|
+
rescue TalonOne::ApiError => e
|
|
340
|
+
puts "Exception when calling IntegrationApi->delete_audience_v2: #{e}"
|
|
341
|
+
end
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### Parameters
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
Name | Type | Description | Notes
|
|
348
|
+
------------- | ------------- | ------------- | -------------
|
|
349
|
+
**audience_id** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
|
|
350
|
+
|
|
351
|
+
### Return type
|
|
352
|
+
|
|
353
|
+
nil (empty response body)
|
|
354
|
+
|
|
355
|
+
### Authorization
|
|
356
|
+
|
|
357
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
358
|
+
|
|
359
|
+
### HTTP request headers
|
|
360
|
+
|
|
361
|
+
- **Content-Type**: Not defined
|
|
362
|
+
- **Accept**: application/json
|
|
363
|
+
|
|
364
|
+
|
|
207
365
|
## delete_coupon_reservation
|
|
208
366
|
|
|
209
367
|
> delete_coupon_reservation(coupon_value, body)
|
|
210
368
|
|
|
211
369
|
Delete coupon reservations
|
|
212
370
|
|
|
213
|
-
|
|
371
|
+
Remove all the coupon reservations from the provided customer profile integration IDs and the provided coupon code.
|
|
214
372
|
|
|
215
373
|
### Example
|
|
216
374
|
|
|
@@ -223,16 +381,11 @@ TalonOne.configure do |config|
|
|
|
223
381
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
224
382
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
225
383
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
226
|
-
|
|
227
|
-
# Configure API key authorization: integration_auth
|
|
228
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
229
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
230
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
231
384
|
end
|
|
232
385
|
|
|
233
386
|
api_instance = TalonOne::IntegrationApi.new
|
|
234
|
-
coupon_value = 'coupon_value_example' # String | The
|
|
235
|
-
body = TalonOne::CouponReservations.new # CouponReservations |
|
|
387
|
+
coupon_value = 'coupon_value_example' # String | The code of the coupon.
|
|
388
|
+
body = TalonOne::CouponReservations.new # CouponReservations | body
|
|
236
389
|
|
|
237
390
|
begin
|
|
238
391
|
#Delete coupon reservations
|
|
@@ -247,8 +400,8 @@ end
|
|
|
247
400
|
|
|
248
401
|
Name | Type | Description | Notes
|
|
249
402
|
------------- | ------------- | ------------- | -------------
|
|
250
|
-
**coupon_value** | **String**| The
|
|
251
|
-
**body** | [**CouponReservations**](CouponReservations.md)|
|
|
403
|
+
**coupon_value** | **String**| The code of the coupon. |
|
|
404
|
+
**body** | [**CouponReservations**](CouponReservations.md)| body |
|
|
252
405
|
|
|
253
406
|
### Return type
|
|
254
407
|
|
|
@@ -256,21 +409,21 @@ nil (empty response body)
|
|
|
256
409
|
|
|
257
410
|
### Authorization
|
|
258
411
|
|
|
259
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
412
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
260
413
|
|
|
261
414
|
### HTTP request headers
|
|
262
415
|
|
|
263
416
|
- **Content-Type**: application/json
|
|
264
|
-
- **Accept**:
|
|
417
|
+
- **Accept**: application/json
|
|
265
418
|
|
|
266
419
|
|
|
267
420
|
## delete_customer_data
|
|
268
421
|
|
|
269
422
|
> delete_customer_data(integration_id)
|
|
270
423
|
|
|
271
|
-
Delete
|
|
424
|
+
Delete customer's personal data
|
|
272
425
|
|
|
273
|
-
Delete all attributes on the customer profile and on entities that reference
|
|
426
|
+
Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
|
|
274
427
|
|
|
275
428
|
### Example
|
|
276
429
|
|
|
@@ -283,18 +436,13 @@ TalonOne.configure do |config|
|
|
|
283
436
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
284
437
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
285
438
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
286
|
-
|
|
287
|
-
# Configure API key authorization: integration_auth
|
|
288
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
289
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
290
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
291
439
|
end
|
|
292
440
|
|
|
293
441
|
api_instance = TalonOne::IntegrationApi.new
|
|
294
|
-
integration_id = 'integration_id_example' # String | The
|
|
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.
|
|
295
443
|
|
|
296
444
|
begin
|
|
297
|
-
#Delete
|
|
445
|
+
#Delete customer's personal data
|
|
298
446
|
api_instance.delete_customer_data(integration_id)
|
|
299
447
|
rescue TalonOne::ApiError => e
|
|
300
448
|
puts "Exception when calling IntegrationApi->delete_customer_data: #{e}"
|
|
@@ -306,7 +454,7 @@ end
|
|
|
306
454
|
|
|
307
455
|
Name | Type | Description | Notes
|
|
308
456
|
------------- | ------------- | ------------- | -------------
|
|
309
|
-
**integration_id** | **String**| The
|
|
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. |
|
|
310
458
|
|
|
311
459
|
### Return type
|
|
312
460
|
|
|
@@ -314,21 +462,21 @@ nil (empty response body)
|
|
|
314
462
|
|
|
315
463
|
### Authorization
|
|
316
464
|
|
|
317
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
465
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
318
466
|
|
|
319
467
|
### HTTP request headers
|
|
320
468
|
|
|
321
469
|
- **Content-Type**: Not defined
|
|
322
|
-
- **Accept**:
|
|
470
|
+
- **Accept**: application/json
|
|
323
471
|
|
|
324
472
|
|
|
325
473
|
## get_customer_inventory
|
|
326
474
|
|
|
327
475
|
> CustomerInventory get_customer_inventory(integration_id, opts)
|
|
328
476
|
|
|
329
|
-
|
|
477
|
+
List customer data
|
|
330
478
|
|
|
331
|
-
|
|
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.
|
|
332
480
|
|
|
333
481
|
### Example
|
|
334
482
|
|
|
@@ -341,25 +489,20 @@ TalonOne.configure do |config|
|
|
|
341
489
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
342
490
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
343
491
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
344
|
-
|
|
345
|
-
# Configure API key authorization: integration_auth
|
|
346
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
347
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
348
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
349
492
|
end
|
|
350
493
|
|
|
351
494
|
api_instance = TalonOne::IntegrationApi.new
|
|
352
|
-
integration_id = 'integration_id_example' # String | The
|
|
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.
|
|
353
496
|
opts = {
|
|
354
|
-
profile: true, # Boolean |
|
|
355
|
-
referrals: true, # Boolean |
|
|
356
|
-
coupons: true, # Boolean |
|
|
357
|
-
loyalty: true, # Boolean |
|
|
358
|
-
giveaways: true # Boolean |
|
|
497
|
+
profile: true, # Boolean | Set to `true` to include customer profile information in the response.
|
|
498
|
+
referrals: true, # Boolean | Set to `true` to include referral information in the response.
|
|
499
|
+
coupons: true, # Boolean | Set to `true` to include coupon information in the response.
|
|
500
|
+
loyalty: true, # Boolean | Set to `true` to include loyalty information in the response.
|
|
501
|
+
giveaways: true # Boolean | Set to `true` to include giveaways information in the response.
|
|
359
502
|
}
|
|
360
503
|
|
|
361
504
|
begin
|
|
362
|
-
#
|
|
505
|
+
#List customer data
|
|
363
506
|
result = api_instance.get_customer_inventory(integration_id, opts)
|
|
364
507
|
p result
|
|
365
508
|
rescue TalonOne::ApiError => e
|
|
@@ -372,12 +515,12 @@ end
|
|
|
372
515
|
|
|
373
516
|
Name | Type | Description | Notes
|
|
374
517
|
------------- | ------------- | ------------- | -------------
|
|
375
|
-
**integration_id** | **String**| The
|
|
376
|
-
**profile** | **Boolean**|
|
|
377
|
-
**referrals** | **Boolean**|
|
|
378
|
-
**coupons** | **Boolean**|
|
|
379
|
-
**loyalty** | **Boolean**|
|
|
380
|
-
**giveaways** | **Boolean**|
|
|
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. |
|
|
519
|
+
**profile** | **Boolean**| Set to `true` to include customer profile information in the response. | [optional]
|
|
520
|
+
**referrals** | **Boolean**| Set to `true` to include referral information in the response. | [optional]
|
|
521
|
+
**coupons** | **Boolean**| Set to `true` to include coupon information in the response. | [optional]
|
|
522
|
+
**loyalty** | **Boolean**| Set to `true` to include loyalty information in the response. | [optional]
|
|
523
|
+
**giveaways** | **Boolean**| Set to `true` to include giveaways information in the response. | [optional]
|
|
381
524
|
|
|
382
525
|
### Return type
|
|
383
526
|
|
|
@@ -385,7 +528,7 @@ Name | Type | Description | Notes
|
|
|
385
528
|
|
|
386
529
|
### Authorization
|
|
387
530
|
|
|
388
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
531
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
389
532
|
|
|
390
533
|
### HTTP request headers
|
|
391
534
|
|
|
@@ -393,13 +536,13 @@ Name | Type | Description | Notes
|
|
|
393
536
|
- **Accept**: application/json
|
|
394
537
|
|
|
395
538
|
|
|
396
|
-
##
|
|
539
|
+
## get_customer_session
|
|
397
540
|
|
|
398
|
-
>
|
|
541
|
+
> IntegrationCustomerSessionResponse get_customer_session(customer_session_id)
|
|
399
542
|
|
|
400
|
-
Get
|
|
543
|
+
Get customer session
|
|
401
544
|
|
|
402
|
-
|
|
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)
|
|
403
546
|
|
|
404
547
|
### Example
|
|
405
548
|
|
|
@@ -412,22 +555,17 @@ TalonOne.configure do |config|
|
|
|
412
555
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
413
556
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
414
557
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
415
|
-
|
|
416
|
-
# Configure API key authorization: integration_auth
|
|
417
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
418
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
419
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
420
558
|
end
|
|
421
559
|
|
|
422
560
|
api_instance = TalonOne::IntegrationApi.new
|
|
423
|
-
|
|
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.
|
|
424
562
|
|
|
425
563
|
begin
|
|
426
|
-
#Get
|
|
427
|
-
result = api_instance.
|
|
564
|
+
#Get customer session
|
|
565
|
+
result = api_instance.get_customer_session(customer_session_id)
|
|
428
566
|
p result
|
|
429
567
|
rescue TalonOne::ApiError => e
|
|
430
|
-
puts "Exception when calling IntegrationApi->
|
|
568
|
+
puts "Exception when calling IntegrationApi->get_customer_session: #{e}"
|
|
431
569
|
end
|
|
432
570
|
```
|
|
433
571
|
|
|
@@ -436,15 +574,15 @@ end
|
|
|
436
574
|
|
|
437
575
|
Name | Type | Description | Notes
|
|
438
576
|
------------- | ------------- | ------------- | -------------
|
|
439
|
-
**
|
|
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. |
|
|
440
578
|
|
|
441
579
|
### Return type
|
|
442
580
|
|
|
443
|
-
[**
|
|
581
|
+
[**IntegrationCustomerSessionResponse**](IntegrationCustomerSessionResponse.md)
|
|
444
582
|
|
|
445
583
|
### Authorization
|
|
446
584
|
|
|
447
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
585
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
448
586
|
|
|
449
587
|
### HTTP request headers
|
|
450
588
|
|
|
@@ -452,13 +590,13 @@ Name | Type | Description | Notes
|
|
|
452
590
|
- **Accept**: application/json
|
|
453
591
|
|
|
454
592
|
|
|
455
|
-
##
|
|
593
|
+
## get_loyalty_balances
|
|
456
594
|
|
|
457
|
-
>
|
|
595
|
+
> LoyaltyBalances get_loyalty_balances(loyalty_program_id, integration_id, opts)
|
|
458
596
|
|
|
459
|
-
|
|
597
|
+
Get customer's loyalty points
|
|
460
598
|
|
|
461
|
-
|
|
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).
|
|
462
600
|
|
|
463
601
|
### Example
|
|
464
602
|
|
|
@@ -471,25 +609,21 @@ TalonOne.configure do |config|
|
|
|
471
609
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
472
610
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
473
611
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
474
|
-
|
|
475
|
-
# Configure API key authorization: integration_auth
|
|
476
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
477
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
478
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
479
612
|
end
|
|
480
613
|
|
|
481
614
|
api_instance = TalonOne::IntegrationApi.new
|
|
482
|
-
|
|
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.
|
|
483
617
|
opts = {
|
|
484
|
-
|
|
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.
|
|
485
619
|
}
|
|
486
620
|
|
|
487
621
|
begin
|
|
488
|
-
#
|
|
489
|
-
result = api_instance.
|
|
622
|
+
#Get customer's loyalty points
|
|
623
|
+
result = api_instance.get_loyalty_balances(loyalty_program_id, integration_id, opts)
|
|
490
624
|
p result
|
|
491
625
|
rescue TalonOne::ApiError => e
|
|
492
|
-
puts "Exception when calling IntegrationApi->
|
|
626
|
+
puts "Exception when calling IntegrationApi->get_loyalty_balances: #{e}"
|
|
493
627
|
end
|
|
494
628
|
```
|
|
495
629
|
|
|
@@ -498,30 +632,31 @@ end
|
|
|
498
632
|
|
|
499
633
|
Name | Type | Description | Notes
|
|
500
634
|
------------- | ------------- | ------------- | -------------
|
|
501
|
-
**
|
|
502
|
-
**
|
|
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]
|
|
503
638
|
|
|
504
639
|
### Return type
|
|
505
640
|
|
|
506
|
-
[**
|
|
641
|
+
[**LoyaltyBalances**](LoyaltyBalances.md)
|
|
507
642
|
|
|
508
643
|
### Authorization
|
|
509
644
|
|
|
510
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
645
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
511
646
|
|
|
512
647
|
### HTTP request headers
|
|
513
648
|
|
|
514
|
-
- **Content-Type**:
|
|
649
|
+
- **Content-Type**: Not defined
|
|
515
650
|
- **Accept**: application/json
|
|
516
651
|
|
|
517
652
|
|
|
518
|
-
##
|
|
653
|
+
## get_loyalty_card_balances
|
|
519
654
|
|
|
520
|
-
>
|
|
655
|
+
> LoyaltyBalances get_loyalty_card_balances(loyalty_program_id, loyalty_card_identifier, opts)
|
|
521
656
|
|
|
522
|
-
|
|
657
|
+
Get loyalty balances for a loyalty card
|
|
523
658
|
|
|
524
|
-
|
|
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.
|
|
525
660
|
|
|
526
661
|
### Example
|
|
527
662
|
|
|
@@ -534,26 +669,21 @@ TalonOne.configure do |config|
|
|
|
534
669
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
535
670
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
536
671
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
537
|
-
|
|
538
|
-
# Configure API key authorization: integration_auth
|
|
539
|
-
config.api_key['Content-Signature'] = 'YOUR API KEY'
|
|
540
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
541
|
-
#config.api_key_prefix['Content-Signature'] = 'Bearer'
|
|
542
672
|
end
|
|
543
673
|
|
|
544
674
|
api_instance = TalonOne::IntegrationApi.new
|
|
545
|
-
|
|
546
|
-
|
|
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.
|
|
547
677
|
opts = {
|
|
548
|
-
|
|
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.
|
|
549
679
|
}
|
|
550
680
|
|
|
551
681
|
begin
|
|
552
|
-
#
|
|
553
|
-
result = api_instance.
|
|
682
|
+
#Get loyalty balances for a loyalty card
|
|
683
|
+
result = api_instance.get_loyalty_card_balances(loyalty_program_id, loyalty_card_identifier, opts)
|
|
554
684
|
p result
|
|
555
685
|
rescue TalonOne::ApiError => e
|
|
556
|
-
puts "Exception when calling IntegrationApi->
|
|
686
|
+
puts "Exception when calling IntegrationApi->get_loyalty_card_balances: #{e}"
|
|
557
687
|
end
|
|
558
688
|
```
|
|
559
689
|
|
|
@@ -562,31 +692,31 @@ end
|
|
|
562
692
|
|
|
563
693
|
Name | Type | Description | Notes
|
|
564
694
|
------------- | ------------- | ------------- | -------------
|
|
565
|
-
**
|
|
566
|
-
**
|
|
567
|
-
**
|
|
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]
|
|
568
698
|
|
|
569
699
|
### Return type
|
|
570
700
|
|
|
571
|
-
[**
|
|
701
|
+
[**LoyaltyBalances**](LoyaltyBalances.md)
|
|
572
702
|
|
|
573
703
|
### Authorization
|
|
574
704
|
|
|
575
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
705
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
576
706
|
|
|
577
707
|
### HTTP request headers
|
|
578
708
|
|
|
579
|
-
- **Content-Type**:
|
|
709
|
+
- **Content-Type**: Not defined
|
|
580
710
|
- **Accept**: application/json
|
|
581
711
|
|
|
582
712
|
|
|
583
|
-
##
|
|
713
|
+
## get_loyalty_card_transactions
|
|
584
714
|
|
|
585
|
-
>
|
|
715
|
+
> CardLedgerTransactionLogEntryIntegrationAPI get_loyalty_card_transactions(loyalty_program_id, loyalty_card_identifier, opts)
|
|
586
716
|
|
|
587
|
-
|
|
717
|
+
Get loyalty card transaction logs
|
|
588
718
|
|
|
589
|
-
|
|
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.
|
|
590
720
|
|
|
591
721
|
### Example
|
|
592
722
|
|
|
@@ -602,13 +732,22 @@ TalonOne.configure do |config|
|
|
|
602
732
|
end
|
|
603
733
|
|
|
604
734
|
api_instance = TalonOne::IntegrationApi.new
|
|
605
|
-
|
|
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
|
+
}
|
|
606
744
|
|
|
607
745
|
begin
|
|
608
|
-
#
|
|
609
|
-
api_instance.
|
|
746
|
+
#Get loyalty card transaction logs
|
|
747
|
+
result = api_instance.get_loyalty_card_transactions(loyalty_program_id, loyalty_card_identifier, opts)
|
|
748
|
+
p result
|
|
610
749
|
rescue TalonOne::ApiError => e
|
|
611
|
-
puts "Exception when calling IntegrationApi->
|
|
750
|
+
puts "Exception when calling IntegrationApi->get_loyalty_card_transactions: #{e}"
|
|
612
751
|
end
|
|
613
752
|
```
|
|
614
753
|
|
|
@@ -617,11 +756,17 @@ end
|
|
|
617
756
|
|
|
618
757
|
Name | Type | Description | Notes
|
|
619
758
|
------------- | ------------- | ------------- | -------------
|
|
620
|
-
**
|
|
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]
|
|
621
766
|
|
|
622
767
|
### Return type
|
|
623
768
|
|
|
624
|
-
|
|
769
|
+
[**CardLedgerTransactionLogEntryIntegrationAPI**](CardLedgerTransactionLogEntryIntegrationAPI.md)
|
|
625
770
|
|
|
626
771
|
### Authorization
|
|
627
772
|
|
|
@@ -629,17 +774,17 @@ nil (empty response body)
|
|
|
629
774
|
|
|
630
775
|
### HTTP request headers
|
|
631
776
|
|
|
632
|
-
- **Content-Type**:
|
|
633
|
-
- **Accept**:
|
|
777
|
+
- **Content-Type**: Not defined
|
|
778
|
+
- **Accept**: application/json
|
|
634
779
|
|
|
635
780
|
|
|
636
|
-
##
|
|
781
|
+
## get_loyalty_program_profile_transactions
|
|
637
782
|
|
|
638
|
-
>
|
|
783
|
+
> InlineResponse2001 get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
|
|
639
784
|
|
|
640
|
-
|
|
785
|
+
List customer's loyalty transactions
|
|
641
786
|
|
|
642
|
-
|
|
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.
|
|
643
788
|
|
|
644
789
|
### Example
|
|
645
790
|
|
|
@@ -655,19 +800,22 @@ TalonOne.configure do |config|
|
|
|
655
800
|
end
|
|
656
801
|
|
|
657
802
|
api_instance = TalonOne::IntegrationApi.new
|
|
658
|
-
|
|
659
|
-
|
|
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.
|
|
660
805
|
opts = {
|
|
661
|
-
|
|
662
|
-
|
|
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.
|
|
663
811
|
}
|
|
664
812
|
|
|
665
813
|
begin
|
|
666
|
-
#
|
|
667
|
-
result = api_instance.
|
|
814
|
+
#List customer's loyalty transactions
|
|
815
|
+
result = api_instance.get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts)
|
|
668
816
|
p result
|
|
669
817
|
rescue TalonOne::ApiError => e
|
|
670
|
-
puts "Exception when calling IntegrationApi->
|
|
818
|
+
puts "Exception when calling IntegrationApi->get_loyalty_program_profile_transactions: #{e}"
|
|
671
819
|
end
|
|
672
820
|
```
|
|
673
821
|
|
|
@@ -676,14 +824,17 @@ end
|
|
|
676
824
|
|
|
677
825
|
Name | Type | Description | Notes
|
|
678
826
|
------------- | ------------- | ------------- | -------------
|
|
679
|
-
**
|
|
680
|
-
**
|
|
681
|
-
**
|
|
682
|
-
**
|
|
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]
|
|
683
834
|
|
|
684
835
|
### Return type
|
|
685
836
|
|
|
686
|
-
[**
|
|
837
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
|
687
838
|
|
|
688
839
|
### Authorization
|
|
689
840
|
|
|
@@ -691,17 +842,17 @@ Name | Type | Description | Notes
|
|
|
691
842
|
|
|
692
843
|
### HTTP request headers
|
|
693
844
|
|
|
694
|
-
- **Content-Type**:
|
|
845
|
+
- **Content-Type**: Not defined
|
|
695
846
|
- **Accept**: application/json
|
|
696
847
|
|
|
697
848
|
|
|
698
|
-
##
|
|
849
|
+
## get_reserved_customers
|
|
699
850
|
|
|
700
|
-
>
|
|
851
|
+
> InlineResponse200 get_reserved_customers(coupon_value)
|
|
701
852
|
|
|
702
|
-
|
|
853
|
+
List customers that have this coupon reserved
|
|
703
854
|
|
|
704
|
-
|
|
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.
|
|
705
856
|
|
|
706
857
|
### Example
|
|
707
858
|
|
|
@@ -717,17 +868,14 @@ TalonOne.configure do |config|
|
|
|
717
868
|
end
|
|
718
869
|
|
|
719
870
|
api_instance = TalonOne::IntegrationApi.new
|
|
720
|
-
|
|
721
|
-
opts = {
|
|
722
|
-
silent: 'silent_example' # String | If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
|
|
723
|
-
}
|
|
871
|
+
coupon_value = 'coupon_value_example' # String | The code of the coupon.
|
|
724
872
|
|
|
725
873
|
begin
|
|
726
|
-
#
|
|
727
|
-
result = api_instance.
|
|
874
|
+
#List customers that have this coupon reserved
|
|
875
|
+
result = api_instance.get_reserved_customers(coupon_value)
|
|
728
876
|
p result
|
|
729
877
|
rescue TalonOne::ApiError => e
|
|
730
|
-
puts "Exception when calling IntegrationApi->
|
|
878
|
+
puts "Exception when calling IntegrationApi->get_reserved_customers: #{e}"
|
|
731
879
|
end
|
|
732
880
|
```
|
|
733
881
|
|
|
@@ -736,12 +884,11 @@ end
|
|
|
736
884
|
|
|
737
885
|
Name | Type | Description | Notes
|
|
738
886
|
------------- | ------------- | ------------- | -------------
|
|
739
|
-
**
|
|
740
|
-
**silent** | **String**| If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000). | [optional]
|
|
887
|
+
**coupon_value** | **String**| The code of the coupon. |
|
|
741
888
|
|
|
742
889
|
### Return type
|
|
743
890
|
|
|
744
|
-
[**
|
|
891
|
+
[**InlineResponse200**](InlineResponse200.md)
|
|
745
892
|
|
|
746
893
|
### Authorization
|
|
747
894
|
|
|
@@ -749,17 +896,17 @@ Name | Type | Description | Notes
|
|
|
749
896
|
|
|
750
897
|
### HTTP request headers
|
|
751
898
|
|
|
752
|
-
- **Content-Type**:
|
|
899
|
+
- **Content-Type**: Not defined
|
|
753
900
|
- **Accept**: application/json
|
|
754
901
|
|
|
755
902
|
|
|
756
|
-
##
|
|
903
|
+
## link_loyalty_card_to_profile
|
|
757
904
|
|
|
758
|
-
>
|
|
905
|
+
> LoyaltyCard link_loyalty_card_to_profile(loyalty_program_id, loyalty_card_identifier, body)
|
|
759
906
|
|
|
760
|
-
|
|
907
|
+
Link customer profile to loyalty card
|
|
761
908
|
|
|
762
|
-
|
|
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.
|
|
763
910
|
|
|
764
911
|
### Example
|
|
765
912
|
|
|
@@ -772,26 +919,75 @@ TalonOne.configure do |config|
|
|
|
772
919
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
773
920
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
774
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.
|
|
775
968
|
|
|
776
|
-
|
|
777
|
-
|
|
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'
|
|
778
978
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
779
|
-
#config.api_key_prefix['
|
|
979
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
780
980
|
end
|
|
781
981
|
|
|
782
982
|
api_instance = TalonOne::IntegrationApi.new
|
|
783
|
-
customer_session_id = 'customer_session_id_example' # String | The
|
|
784
|
-
body = TalonOne::NewCustomerSession.new # NewCustomerSession |
|
|
785
|
-
opts = {
|
|
786
|
-
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
787
|
-
}
|
|
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.
|
|
788
984
|
|
|
789
985
|
begin
|
|
790
|
-
#
|
|
791
|
-
result = api_instance.
|
|
986
|
+
#Reopen customer session
|
|
987
|
+
result = api_instance.reopen_customer_session(customer_session_id)
|
|
792
988
|
p result
|
|
793
989
|
rescue TalonOne::ApiError => e
|
|
794
|
-
puts "Exception when calling IntegrationApi->
|
|
990
|
+
puts "Exception when calling IntegrationApi->reopen_customer_session: #{e}"
|
|
795
991
|
end
|
|
796
992
|
```
|
|
797
993
|
|
|
@@ -800,17 +996,533 @@ end
|
|
|
800
996
|
|
|
801
997
|
Name | Type | Description | Notes
|
|
802
998
|
------------- | ------------- | ------------- | -------------
|
|
803
|
-
**customer_session_id** | **String**| The
|
|
804
|
-
**body** | [**NewCustomerSession**](NewCustomerSession.md)| |
|
|
805
|
-
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
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. |
|
|
806
1000
|
|
|
807
1001
|
### Return type
|
|
808
1002
|
|
|
809
|
-
[**
|
|
1003
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
|
810
1004
|
|
|
811
1005
|
### Authorization
|
|
812
1006
|
|
|
813
|
-
[api_key_v1](../README.md#api_key_v1)
|
|
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
|
+
|
|
1015
|
+
## return_cart_items
|
|
1016
|
+
|
|
1017
|
+
> IntegrationStateV2 return_cart_items(customer_session_id, body, opts)
|
|
1018
|
+
|
|
1019
|
+
Return cart items
|
|
1020
|
+
|
|
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).
|
|
1022
|
+
|
|
1023
|
+
### Example
|
|
1024
|
+
|
|
1025
|
+
```ruby
|
|
1026
|
+
# load the gem
|
|
1027
|
+
require 'talon_one'
|
|
1028
|
+
# setup authorization
|
|
1029
|
+
TalonOne.configure do |config|
|
|
1030
|
+
# Configure API key authorization: api_key_v1
|
|
1031
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1032
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1033
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1034
|
+
end
|
|
1035
|
+
|
|
1036
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
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
|
|
1039
|
+
opts = {
|
|
1040
|
+
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1041
|
+
}
|
|
1042
|
+
|
|
1043
|
+
begin
|
|
1044
|
+
#Return cart items
|
|
1045
|
+
result = api_instance.return_cart_items(customer_session_id, body, opts)
|
|
1046
|
+
p result
|
|
1047
|
+
rescue TalonOne::ApiError => e
|
|
1048
|
+
puts "Exception when calling IntegrationApi->return_cart_items: #{e}"
|
|
1049
|
+
end
|
|
1050
|
+
```
|
|
1051
|
+
|
|
1052
|
+
### Parameters
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
Name | Type | Description | Notes
|
|
1056
|
+
------------- | ------------- | ------------- | -------------
|
|
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]
|
|
1060
|
+
|
|
1061
|
+
### Return type
|
|
1062
|
+
|
|
1063
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
|
1064
|
+
|
|
1065
|
+
### Authorization
|
|
1066
|
+
|
|
1067
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
1068
|
+
|
|
1069
|
+
### HTTP request headers
|
|
1070
|
+
|
|
1071
|
+
- **Content-Type**: application/json
|
|
1072
|
+
- **Accept**: application/json
|
|
1073
|
+
|
|
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
|
+
|
|
1131
|
+
## track_event
|
|
1132
|
+
|
|
1133
|
+
> IntegrationState track_event(body, opts)
|
|
1134
|
+
|
|
1135
|
+
Track event
|
|
1136
|
+
|
|
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.
|
|
1138
|
+
|
|
1139
|
+
### Example
|
|
1140
|
+
|
|
1141
|
+
```ruby
|
|
1142
|
+
# load the gem
|
|
1143
|
+
require 'talon_one'
|
|
1144
|
+
# setup authorization
|
|
1145
|
+
TalonOne.configure do |config|
|
|
1146
|
+
# Configure API key authorization: api_key_v1
|
|
1147
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1148
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1149
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1150
|
+
end
|
|
1151
|
+
|
|
1152
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
1153
|
+
body = TalonOne::NewEvent.new # NewEvent | body
|
|
1154
|
+
opts = {
|
|
1155
|
+
dry: true # Boolean | Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
1156
|
+
}
|
|
1157
|
+
|
|
1158
|
+
begin
|
|
1159
|
+
#Track event
|
|
1160
|
+
result = api_instance.track_event(body, opts)
|
|
1161
|
+
p result
|
|
1162
|
+
rescue TalonOne::ApiError => e
|
|
1163
|
+
puts "Exception when calling IntegrationApi->track_event: #{e}"
|
|
1164
|
+
end
|
|
1165
|
+
```
|
|
1166
|
+
|
|
1167
|
+
### Parameters
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
Name | Type | Description | Notes
|
|
1171
|
+
------------- | ------------- | ------------- | -------------
|
|
1172
|
+
**body** | [**NewEvent**](NewEvent.md)| body |
|
|
1173
|
+
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are ignored when `dry=true`. | [optional]
|
|
1174
|
+
|
|
1175
|
+
### Return type
|
|
1176
|
+
|
|
1177
|
+
[**IntegrationState**](IntegrationState.md)
|
|
1178
|
+
|
|
1179
|
+
### Authorization
|
|
1180
|
+
|
|
1181
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
1182
|
+
|
|
1183
|
+
### HTTP request headers
|
|
1184
|
+
|
|
1185
|
+
- **Content-Type**: application/json
|
|
1186
|
+
- **Accept**: application/json
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
## track_event_v2
|
|
1190
|
+
|
|
1191
|
+
> IntegrationStateV2 track_event_v2(body, opts)
|
|
1192
|
+
|
|
1193
|
+
Track event V2
|
|
1194
|
+
|
|
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.
|
|
1196
|
+
|
|
1197
|
+
### Example
|
|
1198
|
+
|
|
1199
|
+
```ruby
|
|
1200
|
+
# load the gem
|
|
1201
|
+
require 'talon_one'
|
|
1202
|
+
# setup authorization
|
|
1203
|
+
TalonOne.configure do |config|
|
|
1204
|
+
# Configure API key authorization: api_key_v1
|
|
1205
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1206
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1207
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1208
|
+
end
|
|
1209
|
+
|
|
1210
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
1211
|
+
body = TalonOne::IntegrationEventV2Request.new # IntegrationEventV2Request | body
|
|
1212
|
+
opts = {
|
|
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`.
|
|
1215
|
+
}
|
|
1216
|
+
|
|
1217
|
+
begin
|
|
1218
|
+
#Track event V2
|
|
1219
|
+
result = api_instance.track_event_v2(body, opts)
|
|
1220
|
+
p result
|
|
1221
|
+
rescue TalonOne::ApiError => e
|
|
1222
|
+
puts "Exception when calling IntegrationApi->track_event_v2: #{e}"
|
|
1223
|
+
end
|
|
1224
|
+
```
|
|
1225
|
+
|
|
1226
|
+
### Parameters
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
Name | Type | Description | Notes
|
|
1230
|
+
------------- | ------------- | ------------- | -------------
|
|
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]
|
|
1234
|
+
|
|
1235
|
+
### Return type
|
|
1236
|
+
|
|
1237
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
|
1238
|
+
|
|
1239
|
+
### Authorization
|
|
1240
|
+
|
|
1241
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
1242
|
+
|
|
1243
|
+
### HTTP request headers
|
|
1244
|
+
|
|
1245
|
+
- **Content-Type**: application/json
|
|
1246
|
+
- **Accept**: application/json
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
## update_audience_customers_attributes
|
|
1250
|
+
|
|
1251
|
+
> update_audience_customers_attributes(audience_id, body)
|
|
1252
|
+
|
|
1253
|
+
Update profile attributes for all customers in audience
|
|
1254
|
+
|
|
1255
|
+
Update the specified profile attributes to the provided values for all customers in the specified audience.
|
|
1256
|
+
|
|
1257
|
+
### Example
|
|
1258
|
+
|
|
1259
|
+
```ruby
|
|
1260
|
+
# load the gem
|
|
1261
|
+
require 'talon_one'
|
|
1262
|
+
# setup authorization
|
|
1263
|
+
TalonOne.configure do |config|
|
|
1264
|
+
# Configure API key authorization: api_key_v1
|
|
1265
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1266
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1267
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1268
|
+
end
|
|
1269
|
+
|
|
1270
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
1271
|
+
audience_id = 56 # Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
|
|
1272
|
+
body = nil # Object | body
|
|
1273
|
+
|
|
1274
|
+
begin
|
|
1275
|
+
#Update profile attributes for all customers in audience
|
|
1276
|
+
api_instance.update_audience_customers_attributes(audience_id, body)
|
|
1277
|
+
rescue TalonOne::ApiError => e
|
|
1278
|
+
puts "Exception when calling IntegrationApi->update_audience_customers_attributes: #{e}"
|
|
1279
|
+
end
|
|
1280
|
+
```
|
|
1281
|
+
|
|
1282
|
+
### Parameters
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
Name | Type | Description | Notes
|
|
1286
|
+
------------- | ------------- | ------------- | -------------
|
|
1287
|
+
**audience_id** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
|
|
1288
|
+
**body** | **Object**| body |
|
|
1289
|
+
|
|
1290
|
+
### Return type
|
|
1291
|
+
|
|
1292
|
+
nil (empty response body)
|
|
1293
|
+
|
|
1294
|
+
### Authorization
|
|
1295
|
+
|
|
1296
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
1297
|
+
|
|
1298
|
+
### HTTP request headers
|
|
1299
|
+
|
|
1300
|
+
- **Content-Type**: application/json
|
|
1301
|
+
- **Accept**: application/json
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
## update_audience_v2
|
|
1305
|
+
|
|
1306
|
+
> Audience update_audience_v2(audience_id, body)
|
|
1307
|
+
|
|
1308
|
+
Update audience name
|
|
1309
|
+
|
|
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.
|
|
1311
|
+
|
|
1312
|
+
### Example
|
|
1313
|
+
|
|
1314
|
+
```ruby
|
|
1315
|
+
# load the gem
|
|
1316
|
+
require 'talon_one'
|
|
1317
|
+
# setup authorization
|
|
1318
|
+
TalonOne.configure do |config|
|
|
1319
|
+
# Configure API key authorization: api_key_v1
|
|
1320
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1321
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1322
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1323
|
+
end
|
|
1324
|
+
|
|
1325
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
1326
|
+
audience_id = 56 # Integer | The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
|
|
1327
|
+
body = TalonOne::UpdateAudience.new # UpdateAudience | body
|
|
1328
|
+
|
|
1329
|
+
begin
|
|
1330
|
+
#Update audience name
|
|
1331
|
+
result = api_instance.update_audience_v2(audience_id, body)
|
|
1332
|
+
p result
|
|
1333
|
+
rescue TalonOne::ApiError => e
|
|
1334
|
+
puts "Exception when calling IntegrationApi->update_audience_v2: #{e}"
|
|
1335
|
+
end
|
|
1336
|
+
```
|
|
1337
|
+
|
|
1338
|
+
### Parameters
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
Name | Type | Description | Notes
|
|
1342
|
+
------------- | ------------- | ------------- | -------------
|
|
1343
|
+
**audience_id** | **Integer**| The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2). |
|
|
1344
|
+
**body** | [**UpdateAudience**](UpdateAudience.md)| body |
|
|
1345
|
+
|
|
1346
|
+
### Return type
|
|
1347
|
+
|
|
1348
|
+
[**Audience**](Audience.md)
|
|
1349
|
+
|
|
1350
|
+
### Authorization
|
|
1351
|
+
|
|
1352
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
1353
|
+
|
|
1354
|
+
### HTTP request headers
|
|
1355
|
+
|
|
1356
|
+
- **Content-Type**: application/json
|
|
1357
|
+
- **Accept**: application/json
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
## update_customer_profile_audiences
|
|
1361
|
+
|
|
1362
|
+
> update_customer_profile_audiences(body)
|
|
1363
|
+
|
|
1364
|
+
Update multiple customer profiles' audiences
|
|
1365
|
+
|
|
1366
|
+
Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences. The limit of customer profiles per request is 1000.
|
|
1367
|
+
|
|
1368
|
+
### Example
|
|
1369
|
+
|
|
1370
|
+
```ruby
|
|
1371
|
+
# load the gem
|
|
1372
|
+
require 'talon_one'
|
|
1373
|
+
# setup authorization
|
|
1374
|
+
TalonOne.configure do |config|
|
|
1375
|
+
# Configure API key authorization: api_key_v1
|
|
1376
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1377
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1378
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1379
|
+
end
|
|
1380
|
+
|
|
1381
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
1382
|
+
body = TalonOne::CustomerProfileAudienceRequest.new # CustomerProfileAudienceRequest | body
|
|
1383
|
+
|
|
1384
|
+
begin
|
|
1385
|
+
#Update multiple customer profiles' audiences
|
|
1386
|
+
api_instance.update_customer_profile_audiences(body)
|
|
1387
|
+
rescue TalonOne::ApiError => e
|
|
1388
|
+
puts "Exception when calling IntegrationApi->update_customer_profile_audiences: #{e}"
|
|
1389
|
+
end
|
|
1390
|
+
```
|
|
1391
|
+
|
|
1392
|
+
### Parameters
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
Name | Type | Description | Notes
|
|
1396
|
+
------------- | ------------- | ------------- | -------------
|
|
1397
|
+
**body** | [**CustomerProfileAudienceRequest**](CustomerProfileAudienceRequest.md)| body |
|
|
1398
|
+
|
|
1399
|
+
### Return type
|
|
1400
|
+
|
|
1401
|
+
nil (empty response body)
|
|
1402
|
+
|
|
1403
|
+
### Authorization
|
|
1404
|
+
|
|
1405
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
1406
|
+
|
|
1407
|
+
### HTTP request headers
|
|
1408
|
+
|
|
1409
|
+
- **Content-Type**: application/json
|
|
1410
|
+
- **Accept**: application/json
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
## update_customer_profile_v2
|
|
1414
|
+
|
|
1415
|
+
> IntegrationStateV2 update_customer_profile_v2(integration_id, body, opts)
|
|
1416
|
+
|
|
1417
|
+
Update customer profile
|
|
1418
|
+
|
|
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>
|
|
1420
|
+
|
|
1421
|
+
### Example
|
|
1422
|
+
|
|
1423
|
+
```ruby
|
|
1424
|
+
# load the gem
|
|
1425
|
+
require 'talon_one'
|
|
1426
|
+
# setup authorization
|
|
1427
|
+
TalonOne.configure do |config|
|
|
1428
|
+
# Configure API key authorization: api_key_v1
|
|
1429
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1430
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1431
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1432
|
+
end
|
|
1433
|
+
|
|
1434
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
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.
|
|
1436
|
+
body = TalonOne::CustomerProfileIntegrationRequestV2.new # CustomerProfileIntegrationRequestV2 | body
|
|
1437
|
+
opts = {
|
|
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.
|
|
1440
|
+
}
|
|
1441
|
+
|
|
1442
|
+
begin
|
|
1443
|
+
#Update customer profile
|
|
1444
|
+
result = api_instance.update_customer_profile_v2(integration_id, body, opts)
|
|
1445
|
+
p result
|
|
1446
|
+
rescue TalonOne::ApiError => e
|
|
1447
|
+
puts "Exception when calling IntegrationApi->update_customer_profile_v2: #{e}"
|
|
1448
|
+
end
|
|
1449
|
+
```
|
|
1450
|
+
|
|
1451
|
+
### Parameters
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
Name | Type | Description | Notes
|
|
1455
|
+
------------- | ------------- | ------------- | -------------
|
|
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. |
|
|
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]
|
|
1460
|
+
|
|
1461
|
+
### Return type
|
|
1462
|
+
|
|
1463
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
|
1464
|
+
|
|
1465
|
+
### Authorization
|
|
1466
|
+
|
|
1467
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
1468
|
+
|
|
1469
|
+
### HTTP request headers
|
|
1470
|
+
|
|
1471
|
+
- **Content-Type**: application/json
|
|
1472
|
+
- **Accept**: application/json
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
## update_customer_profiles_v2
|
|
1476
|
+
|
|
1477
|
+
> MultipleCustomerProfileIntegrationResponseV2 update_customer_profiles_v2(body, opts)
|
|
1478
|
+
|
|
1479
|
+
Update multiple customer profiles
|
|
1480
|
+
|
|
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).
|
|
1482
|
+
|
|
1483
|
+
### Example
|
|
1484
|
+
|
|
1485
|
+
```ruby
|
|
1486
|
+
# load the gem
|
|
1487
|
+
require 'talon_one'
|
|
1488
|
+
# setup authorization
|
|
1489
|
+
TalonOne.configure do |config|
|
|
1490
|
+
# Configure API key authorization: api_key_v1
|
|
1491
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1492
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1493
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1494
|
+
end
|
|
1495
|
+
|
|
1496
|
+
api_instance = TalonOne::IntegrationApi.new
|
|
1497
|
+
body = TalonOne::MultipleCustomerProfileIntegrationRequest.new # MultipleCustomerProfileIntegrationRequest | body
|
|
1498
|
+
opts = {
|
|
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.
|
|
1500
|
+
}
|
|
1501
|
+
|
|
1502
|
+
begin
|
|
1503
|
+
#Update multiple customer profiles
|
|
1504
|
+
result = api_instance.update_customer_profiles_v2(body, opts)
|
|
1505
|
+
p result
|
|
1506
|
+
rescue TalonOne::ApiError => e
|
|
1507
|
+
puts "Exception when calling IntegrationApi->update_customer_profiles_v2: #{e}"
|
|
1508
|
+
end
|
|
1509
|
+
```
|
|
1510
|
+
|
|
1511
|
+
### Parameters
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
Name | Type | Description | Notes
|
|
1515
|
+
------------- | ------------- | ------------- | -------------
|
|
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']
|
|
1518
|
+
|
|
1519
|
+
### Return type
|
|
1520
|
+
|
|
1521
|
+
[**MultipleCustomerProfileIntegrationResponseV2**](MultipleCustomerProfileIntegrationResponseV2.md)
|
|
1522
|
+
|
|
1523
|
+
### Authorization
|
|
1524
|
+
|
|
1525
|
+
[api_key_v1](../README.md#api_key_v1)
|
|
814
1526
|
|
|
815
1527
|
### HTTP request headers
|
|
816
1528
|
|
|
@@ -822,9 +1534,9 @@ Name | Type | Description | Notes
|
|
|
822
1534
|
|
|
823
1535
|
> IntegrationStateV2 update_customer_session_v2(customer_session_id, body, opts)
|
|
824
1536
|
|
|
825
|
-
Update
|
|
1537
|
+
Update customer session
|
|
826
1538
|
|
|
827
|
-
Update
|
|
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).
|
|
828
1540
|
|
|
829
1541
|
### Example
|
|
830
1542
|
|
|
@@ -840,14 +1552,14 @@ TalonOne.configure do |config|
|
|
|
840
1552
|
end
|
|
841
1553
|
|
|
842
1554
|
api_instance = TalonOne::IntegrationApi.new
|
|
843
|
-
customer_session_id = 'customer_session_id_example' # String | The
|
|
844
|
-
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
|
|
845
1557
|
opts = {
|
|
846
|
-
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.
|
|
847
1559
|
}
|
|
848
1560
|
|
|
849
1561
|
begin
|
|
850
|
-
#Update
|
|
1562
|
+
#Update customer session
|
|
851
1563
|
result = api_instance.update_customer_session_v2(customer_session_id, body, opts)
|
|
852
1564
|
p result
|
|
853
1565
|
rescue TalonOne::ApiError => e
|
|
@@ -860,9 +1572,9 @@ end
|
|
|
860
1572
|
|
|
861
1573
|
Name | Type | Description | Notes
|
|
862
1574
|
------------- | ------------- | ------------- | -------------
|
|
863
|
-
**customer_session_id** | **String**| The
|
|
864
|
-
**body** | [**IntegrationRequest**](IntegrationRequest.md)|
|
|
865
|
-
**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]
|
|
866
1578
|
|
|
867
1579
|
### Return type
|
|
868
1580
|
|