talon_one 2.5.1 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +164 -56
- data/docs/AcceptCouponEffectProps.md +1 -1
- data/docs/AcceptReferralEffectProps.md +1 -1
- data/docs/AccessLogEntry.md +15 -10
- data/docs/Account.md +6 -6
- data/docs/AccountAdditionalCost.md +10 -10
- data/docs/AccountAnalytics.md +19 -19
- data/docs/AccountDashboardStatistic.md +27 -0
- data/docs/AccountDashboardStatisticApiCalls.md +19 -0
- data/docs/AccountDashboardStatisticCampaigns.md +19 -0
- data/docs/AccountDashboardStatisticDiscount.md +21 -0
- data/docs/AccountDashboardStatisticLoyaltyPoints.md +19 -0
- data/docs/AccountDashboardStatisticReferrals.md +19 -0
- data/docs/AccountDashboardStatisticRevenue.md +21 -0
- data/docs/AccountLimits.md +12 -12
- data/docs/AddFreeItemEffectProps.md +2 -2
- data/docs/AddItemCatalogAction.md +23 -0
- data/docs/AddLoyaltyPoints.md +31 -0
- data/docs/AddLoyaltyPointsEffectProps.md +8 -4
- data/docs/AddedDeductedPointsNotificationPolicy.md +19 -0
- data/docs/Application.md +13 -13
- data/docs/ApplicationAPIKey.md +7 -7
- data/docs/ApplicationApiHealth.md +2 -2
- data/docs/ApplicationCampaignStats.md +6 -6
- data/docs/ApplicationCustomer.md +9 -7
- data/docs/ApplicationEvent.md +3 -3
- data/docs/ApplicationReferee.md +4 -4
- data/docs/ApplicationSession.md +5 -5
- data/docs/ApplicationSessionEntity.md +1 -1
- data/docs/Attribute.md +17 -13
- data/docs/Audience.md +14 -6
- data/docs/AudienceAnalytics.md +19 -0
- data/docs/AudienceCustomer.md +41 -0
- data/docs/AudienceIntegrationID.md +17 -0
- data/docs/AudienceMembership.md +2 -2
- data/docs/AwardGiveawayEffectProps.md +5 -5
- data/docs/BaseLoyaltyProgram.md +7 -5
- data/docs/BaseNotification.md +21 -0
- data/docs/BaseNotificationEntity.md +17 -0
- data/docs/BaseNotificationWebhook.md +25 -0
- data/docs/BaseNotifications.md +17 -0
- data/docs/BaseSamlConnection.md +1 -1
- data/docs/BulkApplicationNotification.md +1 -1
- data/docs/BulkCampaignNotification.md +1 -1
- data/docs/Campaign.md +27 -25
- data/docs/CampaignActivationRequest.md +17 -0
- data/docs/CampaignAnalytics.md +8 -8
- data/docs/CampaignCollection.md +3 -3
- data/docs/CampaignCollectionWithoutPayload.md +3 -3
- data/docs/CampaignCopy.md +8 -8
- data/docs/CampaignCreatedNotification.md +5 -1
- data/docs/CampaignDeletedNotification.md +3 -1
- data/docs/CampaignEditedNotification.md +3 -1
- data/docs/CampaignGroup.md +8 -8
- data/docs/CampaignNotification.md +1 -1
- data/docs/CampaignPrioritiesChangedNotification.md +4 -4
- data/docs/CampaignRulesetChangedNotification.md +1 -1
- data/docs/CampaignSearch.md +1 -1
- data/docs/CampaignSet.md +7 -5
- data/docs/CampaignSetBranchNode.md +6 -6
- data/docs/CampaignSetIDs.md +1 -1
- data/docs/CampaignSetLeafNode.md +1 -1
- data/docs/CampaignSetNode.md +1 -1
- data/docs/CampaignSetV2.md +4 -4
- data/docs/CampaignStateChangedNotification.md +4 -2
- data/docs/CampaignTemplate.md +23 -21
- data/docs/CampaignTemplateParams.md +5 -3
- data/docs/CardLedgerTransactionLogEntry.md +41 -0
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +41 -0
- data/docs/CartItem.md +15 -13
- data/docs/Catalog.md +8 -8
- data/docs/CatalogAction.md +19 -0
- data/docs/CatalogActionFilter.md +21 -0
- data/docs/CatalogItem.md +29 -0
- data/docs/CatalogSyncRequest.md +19 -0
- data/docs/CatalogsStrikethroughNotificationPolicy.md +17 -0
- data/docs/Change.md +10 -8
- data/docs/ChangeProfilePassword.md +2 -2
- data/docs/CodeGeneratorSettings.md +2 -2
- data/docs/Collection.md +3 -3
- data/docs/CollectionItem.md +17 -0
- data/docs/CollectionWithoutPayload.md +3 -3
- data/docs/Coupon.md +18 -12
- data/docs/CouponConstraints.md +6 -4
- data/docs/CouponCreatedEffectProps.md +2 -2
- data/docs/CouponCreationJob.md +16 -14
- data/docs/CouponReservations.md +2 -2
- data/docs/CouponSearch.md +1 -1
- data/docs/CouponsNotificationPolicy.md +19 -0
- data/docs/CreateApplicationAPIKey.md +2 -2
- data/docs/CreateManagementKey.md +23 -0
- data/docs/CreateTemplateCampaign.md +2 -0
- data/docs/CustomEffect.md +8 -6
- data/docs/CustomEffectProps.md +11 -3
- data/docs/CustomerActivityReport.md +2 -2
- data/docs/CustomerAnalytics.md +7 -7
- data/docs/CustomerProfile.md +10 -8
- data/docs/CustomerProfileIntegrationRequestV2.md +4 -2
- data/docs/CustomerProfileUpdateV2Response.md +17 -0
- data/docs/CustomerSession.md +10 -10
- data/docs/CustomerSessionV2.md +17 -15
- data/docs/DeductLoyaltyPoints.md +23 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +7 -7
- data/docs/Effect.md +9 -7
- data/docs/EffectEntity.md +9 -7
- data/docs/Endpoint.md +17 -0
- data/docs/Entity.md +2 -2
- data/docs/EntityWithTalangVisibleID.md +2 -2
- data/docs/Environment.md +3 -3
- data/docs/ErrorSource.md +1 -1
- data/docs/EvaluableCampaignIds.md +17 -0
- data/docs/Event.md +6 -6
- data/docs/EventType.md +8 -8
- data/docs/EventV2.md +6 -4
- data/docs/ExpiringPointsNotificationPolicy.md +19 -0
- data/docs/ExpiringPointsNotificationTrigger.md +19 -0
- data/docs/Export.md +5 -5
- data/docs/FeatureFlag.md +7 -7
- data/docs/FeedNotification.md +6 -6
- data/docs/FrontendState.md +16 -0
- data/docs/Giveaway.md +10 -6
- data/docs/GiveawaysPool.md +8 -6
- data/docs/Import.md +4 -4
- data/docs/ImportEntity.md +1 -1
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +3 -3
- data/docs/InlineResponse20012.md +3 -3
- data/docs/InlineResponse20013.md +3 -5
- data/docs/InlineResponse20014.md +4 -2
- data/docs/InlineResponse20015.md +1 -1
- data/docs/InlineResponse20016.md +4 -2
- data/docs/InlineResponse20017.md +2 -2
- data/docs/InlineResponse20018.md +3 -3
- data/docs/InlineResponse20019.md +2 -2
- data/docs/InlineResponse2002.md +2 -2
- data/docs/InlineResponse20020.md +4 -4
- data/docs/InlineResponse20021.md +3 -3
- data/docs/InlineResponse20022.md +5 -3
- data/docs/InlineResponse20023.md +3 -3
- data/docs/InlineResponse20024.md +3 -3
- data/docs/InlineResponse20025.md +3 -3
- data/docs/InlineResponse20026.md +3 -3
- data/docs/InlineResponse20027.md +2 -2
- data/docs/InlineResponse20028.md +5 -3
- data/docs/InlineResponse20029.md +4 -4
- data/docs/InlineResponse2003.md +2 -2
- data/docs/InlineResponse20030.md +2 -2
- data/docs/InlineResponse20031.md +2 -2
- data/docs/InlineResponse20032.md +19 -0
- data/docs/InlineResponse20033.md +19 -0
- data/docs/InlineResponse20034.md +19 -0
- data/docs/InlineResponse20035.md +19 -0
- data/docs/InlineResponse20036.md +19 -0
- data/docs/InlineResponse20037.md +21 -0
- data/docs/InlineResponse20038.md +19 -0
- data/docs/InlineResponse20039.md +19 -0
- data/docs/InlineResponse2004.md +2 -2
- data/docs/InlineResponse2005.md +3 -3
- data/docs/InlineResponse2006.md +3 -3
- data/docs/InlineResponse2007.md +3 -3
- data/docs/InlineResponse2008.md +3 -5
- data/docs/InlineResponse2009.md +3 -5
- data/docs/InlineResponse201.md +1 -1
- data/docs/IntegrationApi.md +516 -87
- data/docs/IntegrationCoupon.md +59 -0
- data/docs/IntegrationCustomerSessionResponse.md +3 -1
- data/docs/IntegrationEntity.md +2 -2
- data/docs/IntegrationEvent.md +2 -2
- data/docs/IntegrationEventV2Request.md +6 -4
- data/docs/IntegrationProfileEntity.md +1 -1
- data/docs/IntegrationRequest.md +1 -1
- data/docs/IntegrationStateV2.md +2 -2
- data/docs/InventoryCoupon.md +18 -12
- data/docs/InventoryReferral.md +6 -6
- data/docs/ItemAttribute.md +21 -0
- data/docs/LedgerEntry.md +12 -12
- data/docs/LedgerInfo.md +12 -12
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +39 -0
- data/docs/LimitCounter.md +9 -9
- data/docs/LoyaltyBalance.md +23 -0
- data/docs/LoyaltyBalances.md +19 -0
- data/docs/LoyaltyCard.md +13 -9
- data/docs/LoyaltyCardProfileRegistration.md +3 -3
- data/docs/LoyaltyCardRegistration.md +1 -1
- data/docs/LoyaltyDashboardData.md +6 -6
- data/docs/LoyaltyDashboardPointsBreakdown.md +2 -2
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyLedgerEntry.md +17 -15
- data/docs/LoyaltyLedgerTransactions.md +19 -0
- data/docs/LoyaltyProgram.md +8 -6
- data/docs/LoyaltyProgramBalance.md +11 -9
- data/docs/LoyaltyProgramLedgers.md +4 -4
- data/docs/LoyaltyProgramTransaction.md +49 -0
- data/docs/LoyaltyStatistics.md +6 -6
- data/docs/LoyaltySubLedger.md +1 -1
- data/docs/LoyaltyTier.md +3 -3
- data/docs/ManagementApi.md +2620 -735
- data/docs/ManagementKey.md +31 -0
- data/docs/ModelReturn.md +3 -3
- data/docs/MultipleAudiences.md +19 -0
- data/docs/MultipleAudiencesItem.md +25 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +2 -2
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +1 -1
- data/docs/MultipleNewAudiences.md +17 -0
- data/docs/MutableEntity.md +1 -1
- data/docs/NewAdditionalCost.md +8 -8
- data/docs/NewApplication.md +10 -10
- data/docs/NewApplicationAPIKey.md +8 -8
- data/docs/NewAttribute.md +15 -11
- data/docs/NewAudience.md +12 -4
- data/docs/NewBaseNotification.md +19 -0
- data/docs/NewCampaign.md +6 -6
- data/docs/NewCampaignGroup.md +5 -5
- data/docs/NewCampaignSet.md +2 -2
- data/docs/NewCampaignSetV2.md +2 -2
- data/docs/NewCampaignTemplate.md +7 -5
- data/docs/NewCatalog.md +5 -5
- data/docs/NewCouponCreationJob.md +8 -6
- data/docs/NewCoupons.md +14 -10
- data/docs/NewCouponsForMultipleRecipients.md +12 -10
- data/docs/NewCustomEffect.md +3 -1
- data/docs/NewCustomerProfile.md +1 -1
- data/docs/NewCustomerSession.md +6 -6
- data/docs/NewCustomerSessionV2.md +7 -5
- data/docs/NewEvent.md +2 -2
- data/docs/NewEventType.md +6 -6
- data/docs/NewGiveawaysPool.md +6 -4
- data/docs/NewInternalAudience.md +21 -0
- data/docs/NewInvitation.md +4 -4
- data/docs/NewLoyaltyProgram.md +7 -5
- data/docs/NewLoyaltyTier.md +1 -1
- data/docs/NewManagementKey.md +33 -0
- data/docs/NewMultipleAudiencesItem.md +19 -0
- data/docs/NewNotificationWebhook.md +4 -4
- data/docs/NewPassword.md +2 -2
- data/docs/NewPicklist.md +19 -0
- data/docs/NewReferral.md +3 -3
- data/docs/NewReferralsForMultipleAdvocates.md +4 -4
- data/docs/NewReturn.md +1 -1
- data/docs/NewRole.md +8 -8
- data/docs/NewRuleset.md +3 -1
- data/docs/NewSamlConnection.md +1 -1
- data/docs/NewWebhook.md +16 -14
- data/docs/Notification.md +3 -3
- data/docs/NotificationWebhook.md +7 -7
- data/docs/OutgoingIntegrationBrazePolicy.md +19 -0
- data/docs/OutgoingIntegrationConfiguration.md +21 -0
- data/docs/OutgoingIntegrationType.md +25 -0
- data/docs/OutgoingIntegrationTypes.md +17 -0
- data/docs/OutgoingIntegrationWebhookTemplate.md +27 -0
- data/docs/OutgoingIntegrationWebhookTemplates.md +17 -0
- data/docs/PatchItemCatalogAction.md +23 -0
- data/docs/PatchManyItemsCatalogAction.md +21 -0
- data/docs/Picklist.md +31 -0
- data/docs/PriorityPosition.md +19 -0
- data/docs/ProfileAudiencesChanges.md +2 -2
- data/docs/RedeemReferralEffectProps.md +2 -2
- data/docs/Referral.md +6 -6
- data/docs/ReferralConstraints.md +1 -1
- data/docs/ReferralCreatedEffectProps.md +1 -1
- data/docs/ReferralRejectionReason.md +1 -1
- data/docs/RejectCouponEffectProps.md +5 -5
- data/docs/RejectReferralEffectProps.md +5 -5
- data/docs/RemoveItemCatalogAction.md +17 -0
- data/docs/RemoveManyItemsCatalogAction.md +17 -0
- data/docs/ReserveCouponEffectProps.md +21 -0
- data/docs/ReturnIntegrationRequest.md +1 -1
- data/docs/ReturnedCartItem.md +1 -1
- data/docs/Role.md +13 -13
- data/docs/RoleAssign.md +4 -4
- data/docs/RoleMembership.md +2 -2
- data/docs/RoleV2.md +25 -0
- data/docs/RoleV2ApplicationDetails.md +21 -0
- data/docs/RoleV2PermissionSet.md +19 -0
- data/docs/RoleV2Permissions.md +19 -0
- data/docs/RoleV2PermissionsRoles.md +21 -0
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +8 -8
- data/docs/RollbackCouponEffectProps.md +1 -1
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +10 -10
- data/docs/RollbackDiscountEffectProps.md +3 -3
- data/docs/RollbackReferralEffectProps.md +1 -1
- data/docs/Rule.md +5 -1
- data/docs/RuleFailureReason.md +12 -12
- data/docs/Ruleset.md +7 -5
- data/docs/SamlConnection.md +3 -3
- data/docs/Session.md +2 -2
- data/docs/SetDiscountEffectProps.md +4 -4
- data/docs/SetDiscountPerAdditionalCostEffectProps.md +5 -5
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +5 -5
- data/docs/SetDiscountPerItemEffectProps.md +9 -5
- data/docs/ShowBundleMetadataEffectProps.md +3 -3
- data/docs/ShowNotificationEffectProps.md +3 -3
- data/docs/StrikethroughChangedItem.md +29 -0
- data/docs/StrikethroughEffect.md +27 -0
- data/docs/StrikethroughLabelingNotification.md +25 -0
- data/docs/StrikethroughSetDiscountPerItemEffectProps.md +19 -0
- data/docs/StrikethroughTrigger.md +25 -0
- data/docs/TalangAttribute.md +33 -0
- data/docs/TalangAttributeVisibility.md +19 -0
- data/docs/TemplateArgDef.md +5 -1
- data/docs/TemplateDef.md +2 -2
- data/docs/Tier.md +2 -2
- data/docs/TransferLoyaltyCard.md +17 -0
- data/docs/TriggerWebhookEffectProps.md +2 -2
- data/docs/UpdateAccount.md +2 -2
- data/docs/UpdateApplication.md +9 -9
- data/docs/UpdateAttributeEffectProps.md +2 -2
- data/docs/UpdateAudience.md +1 -1
- data/docs/UpdateCampaign.md +12 -12
- data/docs/UpdateCampaignGroup.md +5 -5
- data/docs/UpdateCampaignTemplate.md +16 -14
- data/docs/UpdateCatalog.md +2 -2
- data/docs/UpdateCoupon.md +12 -8
- data/docs/UpdateCouponBatch.md +7 -5
- data/docs/UpdateCustomEffect.md +3 -1
- data/docs/UpdateLoyaltyCard.md +2 -2
- data/docs/UpdateLoyaltyProgram.md +7 -5
- data/docs/UpdatePicklist.md +19 -0
- data/docs/UpdateReferral.md +3 -3
- data/docs/UpdateReferralBatch.md +2 -2
- data/docs/UpdateRole.md +8 -8
- data/docs/UpdateUser.md +7 -7
- data/docs/UpdateUserLatestFeedTimestamp.md +1 -1
- data/docs/User.md +5 -5
- data/docs/UserEntity.md +2 -2
- data/docs/UserFeedNotifications.md +2 -2
- data/docs/Webhook.md +19 -17
- data/docs/WebhookActivationLogEntry.md +9 -9
- data/docs/WebhookLogEntry.md +18 -15
- data/docs/WillAwardGiveawayEffectProps.md +3 -3
- data/lib/talon_one/api/integration_api.rb +640 -99
- data/lib/talon_one/api/management_api.rb +2413 -780
- data/lib/talon_one/api_client.rb +2 -2
- data/lib/talon_one/api_error.rb +2 -2
- data/lib/talon_one/configuration.rb +12 -5
- data/lib/talon_one/models/accept_coupon_effect_props.rb +3 -3
- data/lib/talon_one/models/accept_referral_effect_props.rb +3 -3
- data/lib/talon_one/models/access_log_entry.rb +6 -6
- data/lib/talon_one/models/account.rb +8 -8
- data/lib/talon_one/models/account_additional_cost.rb +7 -7
- data/lib/talon_one/models/account_analytics.rb +21 -21
- data/lib/talon_one/models/account_dashboard_statistic.rb +271 -0
- data/lib/talon_one/models/account_dashboard_statistic_api_calls.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_campaigns.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_discount.rb +242 -0
- data/lib/talon_one/models/account_dashboard_statistic_loyalty_points.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_referrals.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_revenue.rb +242 -0
- data/lib/talon_one/models/account_entity.rb +2 -2
- data/lib/talon_one/models/account_limits.rb +14 -14
- data/lib/talon_one/models/add_free_item_effect_props.rb +4 -4
- data/lib/talon_one/models/add_item_catalog_action.rb +245 -0
- data/lib/talon_one/models/add_loyalty_points.rb +311 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +43 -8
- data/lib/talon_one/models/added_deducted_points_notification_policy.rb +269 -0
- data/lib/talon_one/models/additional_cost.rb +2 -2
- data/lib/talon_one/models/api_error.rb +2 -2
- data/lib/talon_one/models/application.rb +7 -7
- data/lib/talon_one/models/application_api_health.rb +5 -5
- data/lib/talon_one/models/application_api_key.rb +11 -11
- data/lib/talon_one/models/application_campaign_stats.rb +9 -9
- data/lib/talon_one/models/application_customer.rb +20 -10
- data/lib/talon_one/models/application_customer_entity.rb +2 -2
- data/lib/talon_one/models/application_entity.rb +2 -2
- data/lib/talon_one/models/application_event.rb +5 -5
- data/lib/talon_one/models/application_notification.rb +2 -2
- data/lib/talon_one/models/application_referee.rb +6 -6
- data/lib/talon_one/models/application_session.rb +7 -7
- data/lib/talon_one/models/application_session_entity.rb +2 -2
- data/lib/talon_one/models/async_coupon_creation_response.rb +2 -2
- data/lib/talon_one/models/attribute.rb +30 -6
- data/lib/talon_one/models/attributes_mandatory.rb +2 -2
- data/lib/talon_one/models/attributes_settings.rb +2 -2
- data/lib/talon_one/models/audience.rb +50 -10
- data/lib/talon_one/models/audience_analytics.rb +218 -0
- data/lib/talon_one/models/audience_customer.rb +395 -0
- data/lib/talon_one/models/{loyalty_projection_data.rb → audience_integration_id.rb} +33 -59
- data/lib/talon_one/models/audience_membership.rb +2 -2
- data/lib/talon_one/models/award_giveaway_effect_props.rb +2 -2
- data/lib/talon_one/models/base_loyalty_program.rb +19 -9
- data/lib/talon_one/models/base_notification.rb +260 -0
- data/lib/talon_one/models/base_notification_entity.rb +211 -0
- data/lib/talon_one/models/base_notification_webhook.rb +275 -0
- data/lib/talon_one/models/base_notifications.rb +209 -0
- data/lib/talon_one/models/base_saml_connection.rb +2 -2
- data/lib/talon_one/models/binding.rb +2 -2
- data/lib/talon_one/models/bulk_application_notification.rb +2 -2
- data/lib/talon_one/models/bulk_campaign_notification.rb +2 -2
- data/lib/talon_one/models/campaign.rb +18 -8
- data/lib/talon_one/models/campaign_activation_request.rb +214 -0
- data/lib/talon_one/models/campaign_analytics.rb +2 -2
- data/lib/talon_one/models/campaign_collection.rb +5 -5
- data/lib/talon_one/models/campaign_collection_without_payload.rb +5 -5
- data/lib/talon_one/models/campaign_copy.rb +4 -4
- data/lib/talon_one/models/campaign_created_notification.rb +29 -6
- data/lib/talon_one/models/campaign_deleted_notification.rb +21 -6
- data/lib/talon_one/models/campaign_edited_notification.rb +15 -6
- data/lib/talon_one/models/campaign_entity.rb +2 -2
- data/lib/talon_one/models/campaign_group.rb +7 -7
- data/lib/talon_one/models/campaign_group_entity.rb +2 -2
- data/lib/talon_one/models/campaign_notification.rb +2 -2
- data/lib/talon_one/models/campaign_priorities_changed_notification.rb +17 -22
- data/lib/talon_one/models/campaign_priorities_v2.rb +2 -2
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +2 -7
- data/lib/talon_one/models/campaign_search.rb +3 -3
- data/lib/talon_one/models/campaign_set.rb +19 -9
- data/lib/talon_one/models/campaign_set_branch_node.rb +5 -5
- data/lib/talon_one/models/campaign_set_i_ds.rb +2 -2
- data/lib/talon_one/models/campaign_set_leaf_node.rb +3 -3
- data/lib/talon_one/models/campaign_set_node.rb +2 -2
- data/lib/talon_one/models/campaign_set_v2.rb +5 -5
- data/lib/talon_one/models/campaign_state_changed_notification.rb +15 -6
- data/lib/talon_one/models/campaign_template.rb +25 -15
- data/lib/talon_one/models/campaign_template_collection.rb +2 -2
- data/lib/talon_one/models/campaign_template_params.rb +16 -6
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +508 -0
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +508 -0
- data/lib/talon_one/models/cart_item.rb +28 -47
- data/lib/talon_one/models/catalog.rb +7 -7
- data/lib/talon_one/models/catalog_action.rb +261 -0
- data/lib/talon_one/models/catalog_action_filter.rb +277 -0
- data/lib/talon_one/models/catalog_item.rb +313 -0
- data/lib/talon_one/models/catalog_sync_request.rb +238 -0
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +231 -0
- data/lib/talon_one/models/change.rb +20 -10
- data/lib/talon_one/models/change_profile_password.rb +2 -2
- data/lib/talon_one/models/code_generator_settings.rb +3 -3
- data/lib/talon_one/models/collection.rb +5 -5
- data/lib/talon_one/models/collection_item.rb +212 -0
- data/lib/talon_one/models/collection_without_payload.rb +5 -5
- data/lib/talon_one/models/coupon.rb +68 -12
- data/lib/talon_one/models/coupon_constraints.rb +39 -5
- data/lib/talon_one/models/coupon_created_effect_props.rb +4 -4
- data/lib/talon_one/models/coupon_creation_job.rb +58 -15
- data/lib/talon_one/models/coupon_limit_configs.rb +2 -2
- data/lib/talon_one/models/coupon_rejection_reason.rb +4 -4
- data/lib/talon_one/models/coupon_reservations.rb +3 -3
- data/lib/talon_one/models/coupon_search.rb +3 -3
- data/lib/talon_one/models/coupon_value.rb +2 -2
- data/lib/talon_one/models/coupons_notification_policy.rb +269 -0
- data/lib/talon_one/models/create_application_api_key.rb +6 -6
- data/lib/talon_one/models/create_management_key.rb +256 -0
- data/lib/talon_one/models/create_template_campaign.rb +15 -3
- data/lib/talon_one/models/create_template_campaign_response.rb +2 -2
- data/lib/talon_one/models/custom_effect.rb +17 -7
- data/lib/talon_one/models/custom_effect_props.rb +44 -4
- data/lib/talon_one/models/customer_activity_report.rb +5 -5
- data/lib/talon_one/models/customer_analytics.rb +10 -10
- data/lib/talon_one/models/customer_inventory.rb +2 -2
- data/lib/talon_one/models/customer_profile.rb +23 -13
- data/lib/talon_one/models/customer_profile_audience_request.rb +2 -2
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +2 -2
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +17 -5
- data/lib/talon_one/models/customer_profile_search_query.rb +2 -2
- data/lib/talon_one/models/customer_profile_update_v2_response.rb +212 -0
- data/lib/talon_one/models/customer_session.rb +8 -8
- data/lib/talon_one/models/customer_session_v2.rb +27 -15
- data/lib/talon_one/models/{loyalty_points.rb → deduct_loyalty_points.rb} +23 -33
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +23 -8
- data/lib/talon_one/models/effect.rb +20 -9
- data/lib/talon_one/models/effect_entity.rb +23 -13
- data/lib/talon_one/models/email_entity.rb +2 -2
- data/lib/talon_one/models/endpoint.rb +212 -0
- data/lib/talon_one/models/entity.rb +4 -4
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +2 -2
- data/lib/talon_one/models/environment.rb +5 -5
- data/lib/talon_one/models/error_effect_props.rb +2 -2
- data/lib/talon_one/models/error_response.rb +2 -2
- data/lib/talon_one/models/error_response_with_status.rb +2 -2
- data/lib/talon_one/models/error_source.rb +3 -3
- data/lib/talon_one/models/evaluable_campaign_ids.rb +209 -0
- data/lib/talon_one/models/event.rb +6 -6
- data/lib/talon_one/models/event_type.rb +7 -7
- data/lib/talon_one/models/event_v2.rb +18 -6
- data/lib/talon_one/models/expiring_points_notification_policy.rb +247 -0
- data/lib/talon_one/models/expiring_points_notification_trigger.rb +280 -0
- data/lib/talon_one/models/export.rb +6 -6
- data/lib/talon_one/models/feature_flag.rb +6 -6
- data/lib/talon_one/models/features_feed.rb +2 -2
- data/lib/talon_one/models/feed_notification.rb +9 -9
- data/lib/talon_one/models/frontend_state.rb +39 -0
- data/lib/talon_one/models/func_arg_def.rb +4 -4
- data/lib/talon_one/models/function_def.rb +2 -2
- data/lib/talon_one/models/giveaway.rb +28 -8
- data/lib/talon_one/models/giveaways_pool.rb +22 -7
- data/lib/talon_one/models/import.rb +5 -5
- data/lib/talon_one/models/import_entity.rb +2 -2
- data/lib/talon_one/models/inline_response200.rb +2 -2
- data/lib/talon_one/models/inline_response2001.rb +13 -13
- data/lib/talon_one/models/inline_response20010.rb +13 -13
- data/lib/talon_one/models/inline_response20011.rb +13 -13
- data/lib/talon_one/models/inline_response20012.rb +13 -13
- data/lib/talon_one/models/inline_response20013.rb +11 -13
- data/lib/talon_one/models/inline_response20014.rb +13 -9
- data/lib/talon_one/models/inline_response20015.rb +3 -3
- data/lib/talon_one/models/inline_response20016.rb +13 -9
- data/lib/talon_one/models/inline_response20017.rb +8 -3
- data/lib/talon_one/models/inline_response20018.rb +13 -13
- data/lib/talon_one/models/inline_response20019.rb +3 -3
- data/lib/talon_one/models/inline_response2002.rb +3 -3
- data/lib/talon_one/models/inline_response20020.rb +13 -13
- data/lib/talon_one/models/inline_response20021.rb +3 -13
- data/lib/talon_one/models/inline_response20022.rb +13 -9
- data/lib/talon_one/models/inline_response20023.rb +13 -13
- data/lib/talon_one/models/inline_response20024.rb +13 -13
- data/lib/talon_one/models/inline_response20025.rb +10 -15
- data/lib/talon_one/models/inline_response20026.rb +13 -13
- data/lib/talon_one/models/inline_response20027.rb +3 -3
- data/lib/talon_one/models/inline_response20028.rb +13 -9
- data/lib/talon_one/models/inline_response20029.rb +13 -13
- data/lib/talon_one/models/inline_response2003.rb +3 -3
- data/lib/talon_one/models/inline_response20030.rb +3 -3
- data/lib/talon_one/models/inline_response20031.rb +3 -3
- data/lib/talon_one/models/inline_response20032.rb +227 -0
- data/lib/talon_one/models/inline_response20033.rb +227 -0
- data/lib/talon_one/models/inline_response20034.rb +227 -0
- data/lib/talon_one/models/inline_response20035.rb +227 -0
- data/lib/talon_one/models/inline_response20036.rb +227 -0
- data/lib/talon_one/models/inline_response20037.rb +231 -0
- data/lib/talon_one/models/inline_response20038.rb +227 -0
- data/lib/talon_one/models/inline_response20039.rb +227 -0
- data/lib/talon_one/models/inline_response2004.rb +3 -3
- data/lib/talon_one/models/inline_response2005.rb +13 -13
- data/lib/talon_one/models/inline_response2006.rb +13 -13
- data/lib/talon_one/models/inline_response2007.rb +13 -13
- data/lib/talon_one/models/inline_response2008.rb +9 -13
- data/lib/talon_one/models/inline_response2009.rb +9 -13
- data/lib/talon_one/models/inline_response201.rb +2 -2
- data/lib/talon_one/models/integration_coupon.rb +569 -0
- data/lib/talon_one/models/integration_customer_session_response.rb +17 -6
- data/lib/talon_one/models/integration_entity.rb +4 -4
- data/lib/talon_one/models/integration_event.rb +3 -3
- data/lib/talon_one/models/integration_event_v2_request.rb +18 -6
- data/lib/talon_one/models/integration_profile_entity.rb +3 -3
- data/lib/talon_one/models/integration_request.rb +3 -3
- data/lib/talon_one/models/integration_state.rb +2 -2
- data/lib/talon_one/models/integration_state_v2.rb +5 -4
- data/lib/talon_one/models/inventory_coupon.rb +65 -9
- data/lib/talon_one/models/inventory_referral.rb +6 -6
- data/lib/talon_one/models/item_attribute.rb +243 -0
- data/lib/talon_one/models/ledger_entry.rb +11 -11
- data/lib/talon_one/models/ledger_info.rb +21 -20
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +474 -0
- data/lib/talon_one/models/library_attribute.rb +2 -2
- data/lib/talon_one/models/limit_config.rb +2 -2
- data/lib/talon_one/models/limit_counter.rb +4 -4
- data/lib/talon_one/models/login_params.rb +2 -2
- data/lib/talon_one/models/loyalty.rb +2 -2
- data/lib/talon_one/models/loyalty_balance.rb +238 -0
- data/lib/talon_one/models/loyalty_balances.rb +219 -0
- data/lib/talon_one/models/loyalty_card.rb +81 -12
- data/lib/talon_one/models/loyalty_card_profile_registration.rb +4 -4
- data/lib/talon_one/models/loyalty_card_registration.rb +2 -2
- data/lib/talon_one/models/loyalty_dashboard_data.rb +2 -2
- data/lib/talon_one/models/loyalty_dashboard_points_breakdown.rb +2 -2
- data/lib/talon_one/models/loyalty_ledger.rb +2 -2
- data/lib/talon_one/models/loyalty_ledger_entry.rb +18 -8
- data/lib/talon_one/models/loyalty_ledger_transactions.rb +220 -0
- data/lib/talon_one/models/loyalty_membership.rb +2 -2
- data/lib/talon_one/models/loyalty_program.rb +23 -8
- data/lib/talon_one/models/loyalty_program_balance.rb +21 -11
- data/lib/talon_one/models/loyalty_program_entity.rb +2 -2
- data/lib/talon_one/models/loyalty_program_ledgers.rb +6 -6
- data/lib/talon_one/models/loyalty_program_transaction.rb +553 -0
- data/lib/talon_one/models/loyalty_statistics.rb +2 -2
- data/lib/talon_one/models/loyalty_sub_ledger.rb +3 -3
- data/lib/talon_one/models/loyalty_tier.rb +5 -5
- data/lib/talon_one/models/management_key.rb +317 -0
- data/lib/talon_one/models/manager_config.rb +2 -2
- data/lib/talon_one/models/meta.rb +2 -2
- data/lib/talon_one/models/model_return.rb +5 -5
- data/lib/talon_one/models/multi_application_entity.rb +2 -2
- data/lib/talon_one/models/multiple_attribute.rb +2 -2
- data/lib/talon_one/models/{loyalty_projection.rb → multiple_audiences.rb} +27 -38
- data/lib/talon_one/models/multiple_audiences_item.rb +354 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +2 -2
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +4 -4
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +3 -3
- data/lib/talon_one/models/multiple_new_attribute.rb +2 -2
- data/lib/talon_one/models/multiple_new_audiences.rb +213 -0
- data/lib/talon_one/models/mutable_entity.rb +3 -3
- data/lib/talon_one/models/new_account.rb +2 -2
- data/lib/talon_one/models/new_account_sign_up.rb +2 -2
- data/lib/talon_one/models/new_additional_cost.rb +5 -5
- data/lib/talon_one/models/new_application.rb +4 -4
- data/lib/talon_one/models/new_application_api_key.rb +12 -12
- data/lib/talon_one/models/new_attribute.rb +31 -7
- data/lib/talon_one/models/new_audience.rb +49 -8
- data/lib/talon_one/models/new_base_notification.rb +226 -0
- data/lib/talon_one/models/new_campaign.rb +6 -6
- data/lib/talon_one/models/new_campaign_collection.rb +2 -2
- data/lib/talon_one/models/new_campaign_group.rb +4 -4
- data/lib/talon_one/models/new_campaign_set.rb +3 -3
- data/lib/talon_one/models/new_campaign_set_v2.rb +3 -3
- data/lib/talon_one/models/new_campaign_template.rb +20 -10
- data/lib/talon_one/models/new_catalog.rb +4 -4
- data/lib/talon_one/models/new_collection.rb +2 -2
- data/lib/talon_one/models/new_coupon_creation_job.rb +50 -7
- data/lib/talon_one/models/new_coupons.rb +57 -11
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +41 -7
- data/lib/talon_one/models/new_custom_effect.rb +14 -4
- data/lib/talon_one/models/new_customer_profile.rb +3 -3
- data/lib/talon_one/models/new_customer_session.rb +5 -5
- data/lib/talon_one/models/new_customer_session_v2.rb +21 -9
- data/lib/talon_one/models/new_event.rb +3 -3
- data/lib/talon_one/models/new_event_type.rb +5 -5
- data/lib/talon_one/models/new_giveaways_pool.rb +22 -7
- data/lib/talon_one/models/new_internal_audience.rb +251 -0
- data/lib/talon_one/models/new_invitation.rb +5 -5
- data/lib/talon_one/models/new_invite_email.rb +2 -2
- data/lib/talon_one/models/new_loyalty_program.rb +22 -7
- data/lib/talon_one/models/new_loyalty_tier.rb +4 -4
- data/lib/talon_one/models/new_management_key.rb +332 -0
- data/lib/talon_one/models/new_multiple_audiences_item.rb +266 -0
- data/lib/talon_one/models/new_notification_webhook.rb +4 -4
- data/lib/talon_one/models/new_password.rb +2 -2
- data/lib/talon_one/models/new_password_email.rb +2 -2
- data/lib/talon_one/models/new_picklist.rb +263 -0
- data/lib/talon_one/models/new_referral.rb +4 -4
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +4 -4
- data/lib/talon_one/models/new_return.rb +3 -3
- data/lib/talon_one/models/new_role.rb +6 -6
- data/lib/talon_one/models/new_ruleset.rb +15 -3
- data/lib/talon_one/models/new_saml_connection.rb +2 -2
- data/lib/talon_one/models/new_template_def.rb +2 -2
- data/lib/talon_one/models/new_user.rb +2 -2
- data/lib/talon_one/models/new_webhook.rb +9 -9
- data/lib/talon_one/models/notification.rb +5 -5
- data/lib/talon_one/models/notification_webhook.rb +7 -7
- data/lib/talon_one/models/outgoing_integration_braze_policy.rb +227 -0
- data/lib/talon_one/models/outgoing_integration_configuration.rb +241 -0
- data/lib/talon_one/models/outgoing_integration_type.rb +357 -0
- data/lib/talon_one/models/outgoing_integration_types.rb +209 -0
- data/lib/talon_one/models/outgoing_integration_webhook_template.rb +328 -0
- data/lib/talon_one/models/outgoing_integration_webhook_templates.rb +209 -0
- data/lib/talon_one/models/patch_item_catalog_action.rb +245 -0
- data/lib/talon_one/models/patch_many_items_catalog_action.rb +230 -0
- data/lib/talon_one/models/picklist.rb +339 -0
- data/lib/talon_one/models/priority_position.rb +264 -0
- data/lib/talon_one/models/profile_audiences_changes.rb +2 -2
- data/lib/talon_one/models/redeem_referral_effect_props.rb +5 -5
- data/lib/talon_one/models/referral.rb +6 -6
- data/lib/talon_one/models/referral_constraints.rb +3 -3
- data/lib/talon_one/models/referral_created_effect_props.rb +3 -3
- data/lib/talon_one/models/referral_rejection_reason.rb +4 -4
- data/lib/talon_one/models/reject_coupon_effect_props.rb +7 -7
- data/lib/talon_one/models/reject_referral_effect_props.rb +7 -7
- data/lib/talon_one/models/remove_item_catalog_action.rb +213 -0
- data/lib/talon_one/models/remove_many_items_catalog_action.rb +210 -0
- data/lib/talon_one/models/reserve_coupon_effect_props.rb +243 -0
- data/lib/talon_one/models/return_integration_request.rb +3 -3
- data/lib/talon_one/models/returned_cart_item.rb +3 -3
- data/lib/talon_one/models/role.rb +10 -10
- data/lib/talon_one/models/role_assign.rb +4 -4
- data/lib/talon_one/models/role_membership.rb +4 -4
- data/lib/talon_one/models/role_v2.rb +248 -0
- data/lib/talon_one/models/role_v2_application_details.rb +227 -0
- data/lib/talon_one/models/role_v2_permission_set.rb +228 -0
- data/lib/talon_one/models/role_v2_permissions.rb +218 -0
- data/lib/talon_one/models/role_v2_permissions_roles.rb +230 -0
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +23 -8
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +3 -3
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +25 -10
- data/lib/talon_one/models/rollback_discount_effect_props.rb +5 -5
- data/lib/talon_one/models/rollback_referral_effect_props.rb +3 -3
- data/lib/talon_one/models/rule.rb +23 -3
- data/lib/talon_one/models/rule_failure_reason.rb +14 -14
- data/lib/talon_one/models/ruleset.rb +18 -6
- data/lib/talon_one/models/saml_connection.rb +4 -4
- data/lib/talon_one/models/saml_connection_metadata.rb +2 -2
- data/lib/talon_one/models/saml_login_endpoint.rb +2 -2
- data/lib/talon_one/models/session.rb +3 -3
- data/lib/talon_one/models/set_discount_effect_props.rb +6 -6
- data/lib/talon_one/models/set_discount_per_additional_cost_effect_props.rb +7 -7
- data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +7 -7
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +30 -10
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +6 -6
- data/lib/talon_one/models/show_notification_effect_props.rb +5 -5
- data/lib/talon_one/models/slot_def.rb +2 -2
- data/lib/talon_one/models/strikethrough_changed_item.rb +318 -0
- data/lib/talon_one/models/strikethrough_effect.rb +287 -0
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +273 -0
- data/lib/talon_one/models/strikethrough_set_discount_per_item_effect_props.rb +228 -0
- data/lib/talon_one/models/strikethrough_trigger.rb +273 -0
- data/lib/talon_one/models/talang_attribute.rb +363 -0
- data/lib/talon_one/models/talang_attribute_visibility.rb +221 -0
- data/lib/talon_one/models/template_arg_def.rb +28 -8
- data/lib/talon_one/models/template_def.rb +4 -4
- data/lib/talon_one/models/template_limit_config.rb +2 -2
- data/lib/talon_one/models/tier.rb +4 -4
- data/lib/talon_one/models/transfer_loyalty_card.rb +231 -0
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +4 -4
- data/lib/talon_one/models/update_account.rb +4 -4
- data/lib/talon_one/models/update_application.rb +3 -3
- data/lib/talon_one/models/update_attribute_effect_props.rb +4 -4
- data/lib/talon_one/models/update_audience.rb +2 -2
- data/lib/talon_one/models/update_campaign.rb +4 -4
- data/lib/talon_one/models/update_campaign_collection.rb +2 -2
- data/lib/talon_one/models/update_campaign_group.rb +4 -4
- data/lib/talon_one/models/update_campaign_template.rb +23 -13
- data/lib/talon_one/models/update_catalog.rb +4 -4
- data/lib/talon_one/models/update_collection.rb +2 -2
- data/lib/talon_one/models/update_coupon.rb +56 -10
- data/lib/talon_one/models/update_coupon_batch.rb +40 -6
- data/lib/talon_one/models/update_custom_effect.rb +14 -4
- data/lib/talon_one/models/update_loyalty_card.rb +3 -3
- data/lib/talon_one/models/update_loyalty_program.rb +17 -7
- data/lib/talon_one/models/update_picklist.rb +264 -0
- data/lib/talon_one/models/update_referral.rb +5 -5
- data/lib/talon_one/models/update_referral_batch.rb +4 -4
- data/lib/talon_one/models/update_role.rb +6 -6
- data/lib/talon_one/models/update_user.rb +5 -5
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +4 -4
- data/lib/talon_one/models/user.rb +7 -7
- data/lib/talon_one/models/user_entity.rb +3 -3
- data/lib/talon_one/models/user_feed_notifications.rb +5 -5
- data/lib/talon_one/models/webhook.rb +12 -12
- data/lib/talon_one/models/webhook_activation_log_entry.rb +7 -7
- data/lib/talon_one/models/webhook_log_entry.rb +8 -8
- data/lib/talon_one/models/will_award_giveaway_effect_props.rb +2 -2
- data/lib/talon_one/version.rb +3 -3
- data/lib/talon_one.rb +88 -5
- data/spec/api/integration_api_spec.rb +151 -49
- data/spec/api/management_api_spec.rb +564 -260
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +5 -5
- data/spec/models/accept_coupon_effect_props_spec.rb +2 -2
- data/spec/models/accept_referral_effect_props_spec.rb +2 -2
- data/spec/models/access_log_entry_spec.rb +2 -2
- data/spec/models/account_additional_cost_spec.rb +2 -2
- data/spec/models/account_analytics_spec.rb +2 -2
- data/spec/models/account_dashboard_statistic_api_calls_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_campaigns_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_discount_spec.rb +53 -0
- data/spec/models/account_dashboard_statistic_loyalty_points_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_referrals_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_revenue_spec.rb +53 -0
- data/spec/models/account_dashboard_statistic_spec.rb +71 -0
- data/spec/models/account_entity_spec.rb +2 -2
- data/spec/models/account_limits_spec.rb +2 -2
- data/spec/models/account_spec.rb +2 -2
- data/spec/models/add_free_item_effect_props_spec.rb +2 -2
- data/spec/models/{loyalty_projection_data_spec.rb → add_item_catalog_action_spec.rb} +12 -12
- data/spec/models/add_loyalty_points_effect_props_spec.rb +14 -2
- data/spec/models/add_loyalty_points_spec.rb +83 -0
- data/spec/models/added_deducted_points_notification_policy_spec.rb +51 -0
- data/spec/models/additional_cost_spec.rb +2 -2
- data/spec/models/api_error_spec.rb +2 -2
- data/spec/models/application_api_health_spec.rb +2 -2
- data/spec/models/application_api_key_spec.rb +3 -3
- data/spec/models/application_campaign_stats_spec.rb +2 -2
- data/spec/models/application_customer_entity_spec.rb +2 -2
- data/spec/models/application_customer_spec.rb +8 -2
- data/spec/models/application_entity_spec.rb +2 -2
- data/spec/models/application_event_spec.rb +2 -2
- data/spec/models/application_notification_spec.rb +2 -2
- data/spec/models/application_referee_spec.rb +2 -2
- data/spec/models/application_session_entity_spec.rb +2 -2
- data/spec/models/application_session_spec.rb +2 -2
- data/spec/models/application_spec.rb +2 -2
- data/spec/models/async_coupon_creation_response_spec.rb +2 -2
- data/spec/models/attribute_spec.rb +18 -2
- data/spec/models/attributes_mandatory_spec.rb +2 -2
- data/spec/models/attributes_settings_spec.rb +2 -2
- data/spec/models/audience_analytics_spec.rb +47 -0
- data/spec/models/audience_customer_spec.rb +113 -0
- data/spec/models/audience_integration_id_spec.rb +41 -0
- data/spec/models/audience_membership_spec.rb +2 -2
- data/spec/models/audience_spec.rb +26 -2
- data/spec/models/award_giveaway_effect_props_spec.rb +2 -2
- data/spec/models/base_loyalty_program_spec.rb +8 -2
- data/spec/models/base_notification_entity_spec.rb +41 -0
- data/spec/models/{loyalty_projection_spec.rb → base_notification_spec.rb} +11 -11
- data/spec/models/base_notification_webhook_spec.rb +65 -0
- data/spec/models/base_notifications_spec.rb +41 -0
- data/spec/models/base_saml_connection_spec.rb +2 -2
- data/spec/models/binding_spec.rb +2 -2
- data/spec/models/bulk_application_notification_spec.rb +2 -2
- data/spec/models/bulk_campaign_notification_spec.rb +2 -2
- data/spec/models/campaign_activation_request_spec.rb +41 -0
- data/spec/models/campaign_analytics_spec.rb +2 -2
- data/spec/models/campaign_collection_spec.rb +2 -2
- data/spec/models/campaign_collection_without_payload_spec.rb +2 -2
- data/spec/models/campaign_copy_spec.rb +2 -2
- data/spec/models/campaign_created_notification_spec.rb +14 -2
- data/spec/models/campaign_deleted_notification_spec.rb +8 -2
- data/spec/models/campaign_edited_notification_spec.rb +8 -2
- data/spec/models/campaign_entity_spec.rb +2 -2
- data/spec/models/campaign_group_entity_spec.rb +2 -2
- data/spec/models/campaign_group_spec.rb +2 -2
- data/spec/models/campaign_notification_spec.rb +2 -2
- data/spec/models/campaign_priorities_changed_notification_spec.rb +3 -3
- data/spec/models/campaign_priorities_v2_spec.rb +2 -2
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +2 -2
- data/spec/models/campaign_search_spec.rb +2 -2
- data/spec/models/campaign_set_branch_node_spec.rb +2 -2
- data/spec/models/campaign_set_i_ds_spec.rb +2 -2
- data/spec/models/campaign_set_leaf_node_spec.rb +2 -2
- data/spec/models/campaign_set_node_spec.rb +2 -2
- data/spec/models/campaign_set_spec.rb +8 -2
- data/spec/models/campaign_set_v2_spec.rb +2 -2
- data/spec/models/campaign_spec.rb +9 -3
- data/spec/models/campaign_state_changed_notification_spec.rb +8 -2
- data/spec/models/campaign_template_collection_spec.rb +2 -2
- data/spec/models/campaign_template_params_spec.rb +8 -2
- data/spec/models/campaign_template_spec.rb +9 -3
- data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +117 -0
- data/spec/models/card_ledger_transaction_log_entry_spec.rb +117 -0
- data/spec/models/cart_item_spec.rb +8 -2
- data/spec/models/catalog_action_filter_spec.rb +57 -0
- data/spec/models/catalog_action_spec.rb +51 -0
- data/spec/models/catalog_item_spec.rb +77 -0
- data/spec/models/catalog_spec.rb +2 -2
- data/spec/models/catalog_sync_request_spec.rb +47 -0
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +41 -0
- data/spec/models/change_profile_password_spec.rb +2 -2
- data/spec/models/change_spec.rb +8 -2
- data/spec/models/code_generator_settings_spec.rb +2 -2
- data/spec/models/collection_item_spec.rb +41 -0
- data/spec/models/collection_spec.rb +2 -2
- data/spec/models/collection_without_payload_spec.rb +2 -2
- data/spec/models/coupon_constraints_spec.rb +8 -2
- data/spec/models/coupon_created_effect_props_spec.rb +2 -2
- data/spec/models/coupon_creation_job_spec.rb +8 -2
- data/spec/models/coupon_limit_configs_spec.rb +2 -2
- data/spec/models/coupon_rejection_reason_spec.rb +3 -3
- data/spec/models/coupon_reservations_spec.rb +2 -2
- data/spec/models/coupon_search_spec.rb +2 -2
- data/spec/models/coupon_spec.rb +20 -2
- data/spec/models/coupon_value_spec.rb +2 -2
- data/spec/models/coupons_notification_policy_spec.rb +51 -0
- data/spec/models/create_application_api_key_spec.rb +3 -3
- data/spec/models/create_management_key_spec.rb +59 -0
- data/spec/models/create_template_campaign_response_spec.rb +2 -2
- data/spec/models/create_template_campaign_spec.rb +8 -2
- data/spec/models/custom_effect_props_spec.rb +26 -2
- data/spec/models/custom_effect_spec.rb +8 -2
- data/spec/models/customer_activity_report_spec.rb +2 -2
- data/spec/models/customer_analytics_spec.rb +2 -2
- data/spec/models/customer_inventory_spec.rb +2 -2
- data/spec/models/customer_profile_audience_request_item_spec.rb +2 -2
- data/spec/models/customer_profile_audience_request_spec.rb +2 -2
- data/spec/models/customer_profile_integration_request_v2_spec.rb +8 -2
- data/spec/models/customer_profile_search_query_spec.rb +2 -2
- data/spec/models/customer_profile_spec.rb +8 -2
- data/spec/models/customer_profile_update_v2_response_spec.rb +41 -0
- data/spec/models/customer_session_spec.rb +2 -2
- data/spec/models/customer_session_v2_spec.rb +8 -2
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +2 -2
- data/spec/models/deduct_loyalty_points_spec.rb +59 -0
- data/spec/models/effect_entity_spec.rb +8 -2
- data/spec/models/effect_spec.rb +8 -2
- data/spec/models/email_entity_spec.rb +2 -2
- data/spec/models/endpoint_spec.rb +41 -0
- data/spec/models/entity_spec.rb +2 -2
- data/spec/models/entity_with_talang_visible_id_spec.rb +2 -2
- data/spec/models/environment_spec.rb +2 -2
- data/spec/models/error_effect_props_spec.rb +2 -2
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_response_with_status_spec.rb +2 -2
- data/spec/models/error_source_spec.rb +2 -2
- data/spec/models/evaluable_campaign_ids_spec.rb +41 -0
- data/spec/models/event_spec.rb +2 -2
- data/spec/models/event_type_spec.rb +2 -2
- data/spec/models/event_v2_spec.rb +8 -2
- data/spec/models/expiring_points_notification_policy_spec.rb +47 -0
- data/spec/models/expiring_points_notification_trigger_spec.rb +51 -0
- data/spec/models/export_spec.rb +2 -2
- data/spec/models/feature_flag_spec.rb +2 -2
- data/spec/models/features_feed_spec.rb +2 -2
- data/spec/models/feed_notification_spec.rb +2 -2
- data/spec/models/frontend_state_spec.rb +35 -0
- data/spec/models/func_arg_def_spec.rb +3 -3
- data/spec/models/function_def_spec.rb +2 -2
- data/spec/models/giveaway_spec.rb +14 -2
- data/spec/models/giveaways_pool_spec.rb +8 -2
- data/spec/models/import_entity_spec.rb +2 -2
- data/spec/models/import_spec.rb +2 -2
- data/spec/models/inline_response20010_spec.rb +3 -3
- data/spec/models/inline_response20011_spec.rb +3 -3
- data/spec/models/inline_response20012_spec.rb +3 -3
- data/spec/models/inline_response20013_spec.rb +2 -8
- data/spec/models/inline_response20014_spec.rb +8 -2
- data/spec/models/inline_response20015_spec.rb +2 -2
- data/spec/models/inline_response20016_spec.rb +8 -2
- data/spec/models/inline_response20017_spec.rb +2 -2
- data/spec/models/inline_response20018_spec.rb +3 -3
- data/spec/models/inline_response20019_spec.rb +2 -2
- data/spec/models/inline_response2001_spec.rb +3 -3
- data/spec/models/inline_response20020_spec.rb +4 -4
- data/spec/models/inline_response20021_spec.rb +2 -2
- data/spec/models/inline_response20022_spec.rb +8 -2
- data/spec/models/inline_response20023_spec.rb +3 -3
- data/spec/models/inline_response20024_spec.rb +3 -3
- data/spec/models/inline_response20025_spec.rb +3 -3
- data/spec/models/inline_response20026_spec.rb +3 -3
- data/spec/models/inline_response20027_spec.rb +2 -2
- data/spec/models/inline_response20028_spec.rb +8 -2
- data/spec/models/inline_response20029_spec.rb +4 -4
- data/spec/models/inline_response2002_spec.rb +2 -2
- data/spec/models/inline_response20030_spec.rb +2 -2
- data/spec/models/inline_response20031_spec.rb +2 -2
- data/spec/models/inline_response20032_spec.rb +47 -0
- data/spec/models/inline_response20033_spec.rb +47 -0
- data/spec/models/inline_response20034_spec.rb +47 -0
- data/spec/models/inline_response20035_spec.rb +47 -0
- data/spec/models/inline_response20036_spec.rb +47 -0
- data/spec/models/inline_response20037_spec.rb +53 -0
- data/spec/models/inline_response20038_spec.rb +47 -0
- data/spec/models/inline_response20039_spec.rb +47 -0
- data/spec/models/inline_response2003_spec.rb +2 -2
- data/spec/models/inline_response2004_spec.rb +2 -2
- data/spec/models/inline_response2005_spec.rb +3 -3
- data/spec/models/inline_response2006_spec.rb +3 -3
- data/spec/models/inline_response2007_spec.rb +3 -3
- data/spec/models/inline_response2008_spec.rb +2 -8
- data/spec/models/inline_response2009_spec.rb +2 -8
- data/spec/models/inline_response200_spec.rb +2 -2
- data/spec/models/inline_response201_spec.rb +2 -2
- data/spec/models/integration_coupon_spec.rb +167 -0
- data/spec/models/integration_customer_session_response_spec.rb +8 -2
- data/spec/models/integration_entity_spec.rb +2 -2
- data/spec/models/integration_event_spec.rb +2 -2
- data/spec/models/integration_event_v2_request_spec.rb +8 -2
- data/spec/models/integration_profile_entity_spec.rb +2 -2
- data/spec/models/integration_request_spec.rb +2 -2
- data/spec/models/integration_state_spec.rb +2 -2
- data/spec/models/integration_state_v2_spec.rb +2 -2
- data/spec/models/inventory_coupon_spec.rb +20 -2
- data/spec/models/inventory_referral_spec.rb +2 -2
- data/spec/models/item_attribute_spec.rb +53 -0
- data/spec/models/ledger_entry_spec.rb +2 -2
- data/spec/models/ledger_info_spec.rb +5 -5
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +111 -0
- data/spec/models/library_attribute_spec.rb +2 -2
- data/spec/models/limit_config_spec.rb +2 -2
- data/spec/models/limit_counter_spec.rb +2 -2
- data/spec/models/login_params_spec.rb +2 -2
- data/spec/models/loyalty_balance_spec.rb +59 -0
- data/spec/models/loyalty_balances_spec.rb +47 -0
- data/spec/models/loyalty_card_profile_registration_spec.rb +2 -2
- data/spec/models/loyalty_card_registration_spec.rb +2 -2
- data/spec/models/loyalty_card_spec.rb +14 -2
- data/spec/models/loyalty_dashboard_data_spec.rb +2 -2
- data/spec/models/loyalty_dashboard_points_breakdown_spec.rb +2 -2
- data/spec/models/loyalty_ledger_entry_spec.rb +8 -2
- data/spec/models/loyalty_ledger_spec.rb +2 -2
- data/spec/models/loyalty_ledger_transactions_spec.rb +47 -0
- data/spec/models/loyalty_membership_spec.rb +2 -2
- data/spec/models/loyalty_program_balance_spec.rb +8 -2
- data/spec/models/loyalty_program_entity_spec.rb +2 -2
- data/spec/models/loyalty_program_ledgers_spec.rb +2 -2
- data/spec/models/loyalty_program_spec.rb +8 -2
- data/spec/models/loyalty_program_transaction_spec.rb +141 -0
- data/spec/models/loyalty_spec.rb +2 -2
- data/spec/models/loyalty_statistics_spec.rb +2 -2
- data/spec/models/loyalty_sub_ledger_spec.rb +2 -2
- data/spec/models/loyalty_tier_spec.rb +2 -2
- data/spec/models/management_key_spec.rb +83 -0
- data/spec/models/manager_config_spec.rb +2 -2
- data/spec/models/meta_spec.rb +2 -2
- data/spec/models/model_return_spec.rb +2 -2
- data/spec/models/multi_application_entity_spec.rb +2 -2
- data/spec/models/multiple_attribute_spec.rb +2 -2
- data/spec/models/multiple_audiences_item_spec.rb +69 -0
- data/spec/models/multiple_audiences_spec.rb +47 -0
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +2 -2
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +2 -2
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +2 -2
- data/spec/models/multiple_new_attribute_spec.rb +2 -2
- data/spec/models/multiple_new_audiences_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +2 -2
- data/spec/models/new_account_sign_up_spec.rb +2 -2
- data/spec/models/new_account_spec.rb +2 -2
- data/spec/models/new_additional_cost_spec.rb +2 -2
- data/spec/models/new_application_api_key_spec.rb +3 -3
- data/spec/models/new_application_spec.rb +2 -2
- data/spec/models/new_attribute_spec.rb +18 -2
- data/spec/models/new_audience_spec.rb +26 -2
- data/spec/models/new_base_notification_spec.rb +47 -0
- data/spec/models/new_campaign_collection_spec.rb +2 -2
- data/spec/models/new_campaign_group_spec.rb +2 -2
- data/spec/models/new_campaign_set_spec.rb +2 -2
- data/spec/models/new_campaign_set_v2_spec.rb +2 -2
- data/spec/models/new_campaign_spec.rb +3 -3
- data/spec/models/new_campaign_template_spec.rb +9 -3
- data/spec/models/new_catalog_spec.rb +2 -2
- data/spec/models/new_collection_spec.rb +2 -2
- data/spec/models/new_coupon_creation_job_spec.rb +8 -2
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +8 -2
- data/spec/models/new_coupons_spec.rb +14 -2
- data/spec/models/new_custom_effect_spec.rb +8 -2
- data/spec/models/new_customer_profile_spec.rb +2 -2
- data/spec/models/new_customer_session_spec.rb +2 -2
- data/spec/models/new_customer_session_v2_spec.rb +8 -2
- data/spec/models/new_event_spec.rb +2 -2
- data/spec/models/new_event_type_spec.rb +2 -2
- data/spec/models/new_giveaways_pool_spec.rb +8 -2
- data/spec/models/new_internal_audience_spec.rb +53 -0
- data/spec/models/new_invitation_spec.rb +2 -2
- data/spec/models/new_invite_email_spec.rb +2 -2
- data/spec/models/new_loyalty_program_spec.rb +8 -2
- data/spec/models/new_loyalty_tier_spec.rb +2 -2
- data/spec/models/new_management_key_spec.rb +89 -0
- data/spec/models/new_multiple_audiences_item_spec.rb +47 -0
- data/spec/models/new_notification_webhook_spec.rb +2 -2
- data/spec/models/new_password_email_spec.rb +2 -2
- data/spec/models/new_password_spec.rb +2 -2
- data/spec/models/new_picklist_spec.rb +51 -0
- data/spec/models/new_referral_spec.rb +2 -2
- data/spec/models/new_referrals_for_multiple_advocates_spec.rb +2 -2
- data/spec/models/new_return_spec.rb +2 -2
- data/spec/models/new_role_spec.rb +2 -2
- data/spec/models/new_ruleset_spec.rb +8 -2
- data/spec/models/new_saml_connection_spec.rb +2 -2
- data/spec/models/new_template_def_spec.rb +2 -2
- data/spec/models/new_user_spec.rb +2 -2
- data/spec/models/new_webhook_spec.rb +2 -2
- data/spec/models/notification_spec.rb +2 -2
- data/spec/models/notification_webhook_spec.rb +2 -2
- data/spec/models/outgoing_integration_braze_policy_spec.rb +47 -0
- data/spec/models/outgoing_integration_configuration_spec.rb +53 -0
- data/spec/models/outgoing_integration_type_spec.rb +65 -0
- data/spec/models/outgoing_integration_types_spec.rb +41 -0
- data/spec/models/outgoing_integration_webhook_template_spec.rb +65 -0
- data/spec/models/outgoing_integration_webhook_templates_spec.rb +41 -0
- data/spec/models/patch_item_catalog_action_spec.rb +59 -0
- data/spec/models/patch_many_items_catalog_action_spec.rb +53 -0
- data/spec/models/picklist_spec.rb +87 -0
- data/spec/models/priority_position_spec.rb +51 -0
- data/spec/models/profile_audiences_changes_spec.rb +2 -2
- data/spec/models/redeem_referral_effect_props_spec.rb +2 -2
- data/spec/models/referral_constraints_spec.rb +2 -2
- data/spec/models/referral_created_effect_props_spec.rb +2 -2
- data/spec/models/referral_rejection_reason_spec.rb +3 -3
- data/spec/models/referral_spec.rb +2 -2
- data/spec/models/reject_coupon_effect_props_spec.rb +2 -2
- data/spec/models/reject_referral_effect_props_spec.rb +2 -2
- data/spec/models/remove_item_catalog_action_spec.rb +41 -0
- data/spec/models/remove_many_items_catalog_action_spec.rb +41 -0
- data/spec/models/reserve_coupon_effect_props_spec.rb +53 -0
- data/spec/models/return_integration_request_spec.rb +2 -2
- data/spec/models/returned_cart_item_spec.rb +2 -2
- data/spec/models/role_assign_spec.rb +2 -2
- data/spec/models/role_membership_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/role_v2_application_details_spec.rb +53 -0
- data/spec/models/role_v2_permission_set_spec.rb +47 -0
- data/spec/models/role_v2_permissions_roles_spec.rb +53 -0
- data/spec/models/role_v2_permissions_spec.rb +47 -0
- data/spec/models/{loyalty_points_spec.rb → role_v2_spec.rb} +13 -13
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +2 -2
- data/spec/models/rollback_coupon_effect_props_spec.rb +2 -2
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +2 -2
- data/spec/models/rollback_discount_effect_props_spec.rb +2 -2
- data/spec/models/rollback_referral_effect_props_spec.rb +2 -2
- data/spec/models/rule_failure_reason_spec.rb +2 -2
- data/spec/models/rule_spec.rb +14 -2
- data/spec/models/ruleset_spec.rb +8 -2
- data/spec/models/saml_connection_metadata_spec.rb +2 -2
- data/spec/models/saml_connection_spec.rb +2 -2
- data/spec/models/saml_login_endpoint_spec.rb +2 -2
- data/spec/models/session_spec.rb +2 -2
- data/spec/models/set_discount_effect_props_spec.rb +2 -2
- data/spec/models/set_discount_per_additional_cost_effect_props_spec.rb +2 -2
- data/spec/models/set_discount_per_additional_cost_per_item_effect_props_spec.rb +2 -2
- data/spec/models/set_discount_per_item_effect_props_spec.rb +14 -2
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +2 -2
- data/spec/models/show_notification_effect_props_spec.rb +2 -2
- data/spec/models/slot_def_spec.rb +2 -2
- data/spec/models/strikethrough_changed_item_spec.rb +77 -0
- data/spec/models/strikethrough_effect_spec.rb +71 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +65 -0
- data/spec/models/strikethrough_set_discount_per_item_effect_props_spec.rb +47 -0
- data/spec/models/strikethrough_trigger_spec.rb +65 -0
- data/spec/models/talang_attribute_spec.rb +97 -0
- data/spec/models/talang_attribute_visibility_spec.rb +47 -0
- data/spec/models/template_arg_def_spec.rb +15 -3
- data/spec/models/template_def_spec.rb +2 -2
- data/spec/models/template_limit_config_spec.rb +2 -2
- data/spec/models/tier_spec.rb +2 -2
- data/spec/models/transfer_loyalty_card_spec.rb +41 -0
- data/spec/models/trigger_webhook_effect_props_spec.rb +2 -2
- data/spec/models/update_account_spec.rb +2 -2
- data/spec/models/update_application_spec.rb +2 -2
- data/spec/models/update_attribute_effect_props_spec.rb +2 -2
- data/spec/models/update_audience_spec.rb +2 -2
- data/spec/models/update_campaign_collection_spec.rb +2 -2
- data/spec/models/update_campaign_group_spec.rb +2 -2
- data/spec/models/update_campaign_spec.rb +3 -3
- data/spec/models/update_campaign_template_spec.rb +9 -3
- data/spec/models/update_catalog_spec.rb +2 -2
- data/spec/models/update_collection_spec.rb +2 -2
- data/spec/models/update_coupon_batch_spec.rb +8 -2
- data/spec/models/update_coupon_spec.rb +14 -2
- data/spec/models/update_custom_effect_spec.rb +8 -2
- data/spec/models/update_loyalty_card_spec.rb +2 -2
- data/spec/models/update_loyalty_program_spec.rb +8 -2
- data/spec/models/update_picklist_spec.rb +51 -0
- data/spec/models/update_referral_batch_spec.rb +2 -2
- data/spec/models/update_referral_spec.rb +2 -2
- data/spec/models/update_role_spec.rb +2 -2
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +2 -2
- data/spec/models/update_user_spec.rb +2 -2
- data/spec/models/user_entity_spec.rb +2 -2
- data/spec/models/user_feed_notifications_spec.rb +2 -2
- data/spec/models/user_spec.rb +2 -2
- data/spec/models/webhook_activation_log_entry_spec.rb +2 -2
- data/spec/models/webhook_log_entry_spec.rb +2 -2
- data/spec/models/webhook_spec.rb +2 -2
- data/spec/models/will_award_giveaway_effect_props_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/talon_one.gemspec +2 -2
- metadata +346 -14
- data/docs/LoyaltyPoints.md +0 -25
- data/docs/LoyaltyProjection.md +0 -21
- data/docs/LoyaltyProjectionData.md +0 -23
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::CustomerProfileUpdateV2Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**customer_profile** | [**CustomerProfile**](CustomerProfile.md) | |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::CustomerProfileUpdateV2Response.new(customer_profile: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/CustomerSession.md
CHANGED
|
@@ -4,20 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**integration_id** | **String** | The integration ID
|
|
8
|
-
**created** | **DateTime** | The
|
|
7
|
+
**integration_id** | **String** | The integration ID set by your integration layer. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
10
|
-
**profile_id** | **String** | ID of the
|
|
10
|
+
**profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. |
|
|
11
11
|
**coupon** | **String** | Any coupon code entered. |
|
|
12
12
|
**referral** | **String** | Any referral code entered. |
|
|
13
|
-
**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [
|
|
13
|
+
**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | [default to 'open']
|
|
14
14
|
**cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. |
|
|
15
|
-
**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers
|
|
15
|
+
**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). | [optional]
|
|
16
16
|
**total** | **Float** | The total sum of the cart in one session. |
|
|
17
17
|
**attributes** | [**Object**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. |
|
|
18
18
|
**first_session** | **Boolean** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. |
|
|
19
19
|
**discounts** | **Hash<String, Float>** | A map of labelled discount values, values will be in the same currency as the application associated with the session. |
|
|
20
|
-
**updated** | **DateTime** | Timestamp of the most recent event received on this session |
|
|
20
|
+
**updated** | **DateTime** | Timestamp of the most recent event received on this session. |
|
|
21
21
|
|
|
22
22
|
## Code Sample
|
|
23
23
|
|
|
@@ -28,14 +28,14 @@ instance = TalonOne::CustomerSession.new(integration_id: null,
|
|
|
28
28
|
created: 2020-02-07T08:15:22Z,
|
|
29
29
|
application_id: 322,
|
|
30
30
|
profile_id: URNGV8294NV,
|
|
31
|
-
coupon:
|
|
32
|
-
referral:
|
|
33
|
-
state:
|
|
31
|
+
coupon: XMAS-2021,
|
|
32
|
+
referral: 2740-tbjua-6720,
|
|
33
|
+
state: open,
|
|
34
34
|
cart_items: null,
|
|
35
35
|
identifiers: [91.11.156.141],
|
|
36
36
|
total: null,
|
|
37
37
|
attributes: null,
|
|
38
|
-
first_session:
|
|
38
|
+
first_session: true,
|
|
39
39
|
discounts: null,
|
|
40
40
|
updated: 2021-09-12T10:12:42Z)
|
|
41
41
|
```
|
data/docs/CustomerSessionV2.md
CHANGED
|
@@ -4,24 +4,25 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
8
|
-
**created** | **DateTime** | The
|
|
9
|
-
**integration_id** | **String** | The integration ID
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. The time this entity was created. |
|
|
9
|
+
**integration_id** | **String** | The integration ID set by your integration layer. |
|
|
10
10
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
11
|
-
**profile_id** | **String** | ID of the
|
|
11
|
+
**profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. |
|
|
12
|
+
**evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
|
|
12
13
|
**coupon_codes** | **Array<String>** | Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional]
|
|
13
14
|
**referral_code** | **String** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional]
|
|
14
15
|
**loyalty_cards** | **Array<String>** | Any loyalty cards used. | [optional]
|
|
15
|
-
**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`
|
|
16
|
+
**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | [default to 'open']
|
|
16
17
|
**cart_items** | [**Array<CartItem>**](CartItem.md) | The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. |
|
|
17
|
-
**additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) |
|
|
18
|
-
**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers
|
|
19
|
-
**attributes** | [**Object**](.md) |
|
|
18
|
+
**additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional]
|
|
19
|
+
**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). | [optional]
|
|
20
|
+
**attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. |
|
|
20
21
|
**first_session** | **Boolean** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. |
|
|
21
|
-
**total** | **Float** | The total sum of cart-items, as well as additional costs, before any discounts applied |
|
|
22
|
-
**cart_item_total** | **Float** | The total sum of cart-items before any discounts applied |
|
|
23
|
-
**additional_cost_total** | **Float** | The total sum of additional costs before any discounts applied |
|
|
24
|
-
**updated** | **DateTime** | Timestamp of the most recent event received on this session |
|
|
22
|
+
**total** | **Float** | The total sum of cart-items, as well as additional costs, before any discounts applied. |
|
|
23
|
+
**cart_item_total** | **Float** | The total sum of cart-items before any discounts applied. |
|
|
24
|
+
**additional_cost_total** | **Float** | The total sum of additional costs before any discounts applied. |
|
|
25
|
+
**updated** | **DateTime** | Timestamp of the most recent event received on this session. |
|
|
25
26
|
|
|
26
27
|
## Code Sample
|
|
27
28
|
|
|
@@ -33,6 +34,7 @@ instance = TalonOne::CustomerSessionV2.new(id: 6,
|
|
|
33
34
|
integration_id: URNGV8294NV,
|
|
34
35
|
application_id: 322,
|
|
35
36
|
profile_id: URNGV8294NV,
|
|
37
|
+
evaluable_campaign_ids: [10, 12],
|
|
36
38
|
coupon_codes: [XMAS-20-2021],
|
|
37
39
|
referral_code: NT2K54D9,
|
|
38
40
|
loyalty_cards: [loyalty-card-1],
|
|
@@ -41,10 +43,10 @@ instance = TalonOne::CustomerSessionV2.new(id: 6,
|
|
|
41
43
|
additional_costs: {"shipping":{"price":9}},
|
|
42
44
|
identifiers: [91.11.156.141],
|
|
43
45
|
attributes: {"ShippingCity":"Berlin"},
|
|
44
|
-
first_session:
|
|
45
|
-
total:
|
|
46
|
+
first_session: true,
|
|
47
|
+
total: 119.99,
|
|
46
48
|
cart_item_total: 99.99,
|
|
47
|
-
additional_cost_total:
|
|
49
|
+
additional_cost_total: 20.0,
|
|
48
50
|
updated: 2020-02-08T14:15:22Z)
|
|
49
51
|
```
|
|
50
52
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::DeductLoyaltyPoints
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**points** | **Float** | Amount of loyalty points. |
|
|
8
|
+
**name** | **String** | Name / reason for the point deduction. | [optional]
|
|
9
|
+
**subledger_id** | **String** | ID of the subledger the points are deducted from. | [optional]
|
|
10
|
+
**application_id** | **Integer** | ID of the Application that is connected to the loyalty program. | [optional]
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::DeductLoyaltyPoints.new(points: 300.0,
|
|
18
|
+
name: Penalty,
|
|
19
|
+
subledger_id: sub-123,
|
|
20
|
+
application_id: 322)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**rule_title** | **String** | The title of the rule that contained triggered this points deduction |
|
|
8
|
-
**program_id** | **Integer** | The ID of the loyalty program where these points were added |
|
|
9
|
-
**sub_ledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added |
|
|
10
|
-
**value** | **Float** | The amount of points that were deducted |
|
|
11
|
-
**transaction_uuid** | **String** | The identifier of this deduction in the loyalty ledger |
|
|
7
|
+
**rule_title** | **String** | The title of the rule that contained triggered this points deduction. |
|
|
8
|
+
**program_id** | **Integer** | The ID of the loyalty program where these points were added. |
|
|
9
|
+
**sub_ledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added. |
|
|
10
|
+
**value** | **Float** | The amount of points that were deducted. |
|
|
11
|
+
**transaction_uuid** | **String** | The identifier of this deduction in the loyalty ledger. |
|
|
12
12
|
**name** | **String** | The name property gets one of the following two values. It can be the loyalty program name or it can represent a reason for the respective deduction of loyalty points. The latter is an optional value defined in a deduction rule. |
|
|
13
|
-
**card_identifier** | **String** | The
|
|
13
|
+
**card_identifier** | **String** | The alphanumeric identifier of the loyalty card. | [optional]
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
|
16
16
|
|
|
@@ -23,7 +23,7 @@ instance = TalonOne::DeductLoyaltyPointsEffectProps.new(rule_title: null,
|
|
|
23
23
|
value: null,
|
|
24
24
|
transaction_uuid: null,
|
|
25
25
|
name: null,
|
|
26
|
-
card_identifier:
|
|
26
|
+
card_identifier: summer-loyalty-card-0543)
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
|
data/docs/Effect.md
CHANGED
|
@@ -4,13 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**campaign_id** | **Integer** | The ID of the campaign that triggered this effect |
|
|
8
|
-
**ruleset_id** | **Integer** | The ID of the ruleset that was active in the campaign when this effect was triggered |
|
|
9
|
-
**rule_index** | **Integer** | The position of the rule that triggered this effect within the ruleset |
|
|
10
|
-
**rule_name** | **String** | The name of the rule that triggered this effect |
|
|
11
|
-
**effect_type** | **String** | The type of effect that was triggered |
|
|
12
|
-
**triggered_by_coupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered | [optional]
|
|
13
|
-
**
|
|
7
|
+
**campaign_id** | **Integer** | The ID of the campaign that triggered this effect. |
|
|
8
|
+
**ruleset_id** | **Integer** | The ID of the ruleset that was active in the campaign when this effect was triggered. |
|
|
9
|
+
**rule_index** | **Integer** | The position of the rule that triggered this effect within the ruleset. |
|
|
10
|
+
**rule_name** | **String** | The name of the rule that triggered this effect. |
|
|
11
|
+
**effect_type** | **String** | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
|
|
12
|
+
**triggered_by_coupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional]
|
|
13
|
+
**triggered_for_catalog_item** | **Integer** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional]
|
|
14
|
+
**props** | [**Object**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
@@ -23,6 +24,7 @@ instance = TalonOne::Effect.new(campaign_id: 244,
|
|
|
23
24
|
rule_name: Give 20% discount,
|
|
24
25
|
effect_type: rejectCoupon,
|
|
25
26
|
triggered_by_coupon: 4928,
|
|
27
|
+
triggered_for_catalog_item: 786,
|
|
26
28
|
props: null)
|
|
27
29
|
```
|
|
28
30
|
|
data/docs/EffectEntity.md
CHANGED
|
@@ -4,12 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**campaign_id** | **Integer** | The ID of the campaign that triggered this effect |
|
|
8
|
-
**ruleset_id** | **Integer** | The ID of the ruleset that was active in the campaign when this effect was triggered |
|
|
9
|
-
**rule_index** | **Integer** | The position of the rule that triggered this effect within the ruleset |
|
|
10
|
-
**rule_name** | **String** | The name of the rule that triggered this effect |
|
|
11
|
-
**effect_type** | **String** | The type of effect that was triggered |
|
|
12
|
-
**triggered_by_coupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered | [optional]
|
|
7
|
+
**campaign_id** | **Integer** | The ID of the campaign that triggered this effect. |
|
|
8
|
+
**ruleset_id** | **Integer** | The ID of the ruleset that was active in the campaign when this effect was triggered. |
|
|
9
|
+
**rule_index** | **Integer** | The position of the rule that triggered this effect within the ruleset. |
|
|
10
|
+
**rule_name** | **String** | The name of the rule that triggered this effect. |
|
|
11
|
+
**effect_type** | **String** | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
|
|
12
|
+
**triggered_by_coupon** | **Integer** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional]
|
|
13
|
+
**triggered_for_catalog_item** | **Integer** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional]
|
|
13
14
|
|
|
14
15
|
## Code Sample
|
|
15
16
|
|
|
@@ -21,7 +22,8 @@ instance = TalonOne::EffectEntity.new(campaign_id: 244,
|
|
|
21
22
|
rule_index: 2,
|
|
22
23
|
rule_name: Give 20% discount,
|
|
23
24
|
effect_type: rejectCoupon,
|
|
24
|
-
triggered_by_coupon: 4928
|
|
25
|
+
triggered_by_coupon: 4928,
|
|
26
|
+
triggered_for_catalog_item: 786)
|
|
25
27
|
```
|
|
26
28
|
|
|
27
29
|
|
data/docs/Endpoint.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::Endpoint
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**path** | **String** | allowed endpoint |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::Endpoint.new(path: /coupons)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/Entity.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
8
|
-
**created** | **DateTime** | The
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'TalonOne'
|
|
14
14
|
|
|
15
|
-
instance = TalonOne::EntityWithTalangVisibleID.new(id:
|
|
16
|
-
created:
|
|
15
|
+
instance = TalonOne::EntityWithTalangVisibleID.new(id: 4,
|
|
16
|
+
created: 2020-06-10T09:05:27.993483Z)
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
|
data/docs/Environment.md
CHANGED
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
8
|
-
**created** | **DateTime** | The
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
10
10
|
**slots** | [**Array<SlotDef>**](SlotDef.md) | The slots defined for this application. |
|
|
11
11
|
**functions** | [**Array<FunctionDef>**](FunctionDef.md) | The functions defined for this application. |
|
|
12
12
|
**templates** | [**Array<TemplateDef>**](TemplateDef.md) | The templates defined for this application. |
|
|
13
|
-
**variables** | **String** | A stringified version of the environment's Talang variables scope |
|
|
13
|
+
**variables** | **String** | A stringified version of the environment's Talang variables scope. |
|
|
14
14
|
**giveaways_pools** | [**Array<GiveawaysPool>**](GiveawaysPool.md) | The giveaways pools that the application is subscribed to. | [optional]
|
|
15
15
|
**loyalty_programs** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | The loyalty programs that the application is subscribed to. | [optional]
|
|
16
16
|
**attributes** | [**Array<Attribute>**](Attribute.md) | The attributes that the application is subscribed to. | [optional]
|
data/docs/ErrorSource.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**pointer** | **String** | Pointer to the path in the payload that caused this error. | [optional]
|
|
8
8
|
**parameter** | **String** | Query parameter that caused this error. | [optional]
|
|
9
9
|
**line** | **String** | Line number in uploaded multipart file that caused this error. 'N/A' if unknown. | [optional]
|
|
10
|
-
**resource** | **String** | Pointer to the resource that caused this error | [optional]
|
|
10
|
+
**resource** | **String** | Pointer to the resource that caused this error. | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::EvaluableCampaignIds
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::EvaluableCampaignIds.new(evaluable_campaign_ids: [10, 12])
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/Event.md
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
8
|
-
**created** | **DateTime** | The
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
10
|
-
**profile_id** | **String** | ID of the
|
|
10
|
+
**profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
|
|
11
11
|
**type** | **String** | A string representing the event. Must not be a reserved event name. |
|
|
12
12
|
**attributes** | [**Object**](.md) | Arbitrary additional JSON data associated with the event. |
|
|
13
13
|
**session_id** | **String** | The ID of the session that this event occurred in. | [optional]
|
|
14
|
-
**effects** | **Array<Object>** | An array of
|
|
14
|
+
**effects** | **Array<Object>** | An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
|
|
15
15
|
**ledger_entries** | [**Array<LedgerEntry>**](LedgerEntry.md) | Ledger entries for the event. |
|
|
16
16
|
**meta** | [**Meta**](Meta.md) | | [optional]
|
|
17
17
|
|
|
@@ -24,10 +24,10 @@ instance = TalonOne::Event.new(id: 6,
|
|
|
24
24
|
created: 2020-06-10T09:05:27.993483Z,
|
|
25
25
|
application_id: 322,
|
|
26
26
|
profile_id: URNGV8294NV,
|
|
27
|
-
type:
|
|
27
|
+
type: pageViewed,
|
|
28
28
|
attributes: {"myAttribute":"myValue"},
|
|
29
29
|
session_id: 175KJPS947296,
|
|
30
|
-
effects:
|
|
30
|
+
effects: null,
|
|
31
31
|
ledger_entries: null,
|
|
32
32
|
meta: null)
|
|
33
33
|
```
|
data/docs/EventType.md
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
8
|
-
**created** | **DateTime** | The
|
|
9
|
-
**title** | **String** | The human-friendly
|
|
10
|
-
**name** | **String** | The
|
|
11
|
-
**description** | **String** |
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
|
+
**title** | **String** | The human-friendly name for this event type. |
|
|
10
|
+
**name** | **String** | The integration name for this event type. This will be used in URLs and cannot be changed after an event type has been created. |
|
|
11
|
+
**description** | **String** | A description of what the event represents. | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
|
@@ -17,9 +17,9 @@ require 'TalonOne'
|
|
|
17
17
|
|
|
18
18
|
instance = TalonOne::EventType.new(id: 6,
|
|
19
19
|
created: 2020-06-10T09:05:27.993483Z,
|
|
20
|
-
title:
|
|
21
|
-
name:
|
|
22
|
-
description:
|
|
20
|
+
title: Survey Completed,
|
|
21
|
+
name: surveyCompleted,
|
|
22
|
+
description: The survey was submitted by the customer.)
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
|
data/docs/EventV2.md
CHANGED
|
@@ -4,9 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**profile_id** | **String** | ID of the
|
|
8
|
-
**
|
|
9
|
-
**
|
|
7
|
+
**profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
|
|
8
|
+
**evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
|
|
9
|
+
**type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/events#creating-a-custom-event) of type `event` in the Campaign Manager. |
|
|
10
|
+
**attributes** | [**Object**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-custom-attributes). | [optional]
|
|
10
11
|
|
|
11
12
|
## Code Sample
|
|
12
13
|
|
|
@@ -14,7 +15,8 @@ Name | Type | Description | Notes
|
|
|
14
15
|
require 'TalonOne'
|
|
15
16
|
|
|
16
17
|
instance = TalonOne::EventV2.new(profile_id: URNGV8294NV,
|
|
17
|
-
|
|
18
|
+
evaluable_campaign_ids: [10, 12],
|
|
19
|
+
type: pageViewed,
|
|
18
20
|
attributes: {"myAttribute":"myValue"})
|
|
19
21
|
```
|
|
20
22
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::ExpiringPointsNotificationPolicy
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | Notification name. |
|
|
8
|
+
**triggers** | [**Array<ExpiringPointsNotificationTrigger>**](ExpiringPointsNotificationTrigger.md) | |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::ExpiringPointsNotificationPolicy.new(name: notification to google.,
|
|
16
|
+
triggers: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::ExpiringPointsNotificationTrigger
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**amount** | **Integer** | The amount of period. |
|
|
8
|
+
**period** | **String** | Notification period indicated by a letter; \"w\" means week, \"d\" means day. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::ExpiringPointsNotificationTrigger.new(amount: null,
|
|
16
|
+
period: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/Export.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
8
|
-
**created** | **DateTime** | The
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
10
|
-
**user_id** | **Integer** | The ID of the
|
|
10
|
+
**user_id** | **Integer** | The ID of the user associated with this entity. |
|
|
11
11
|
**entity** | **String** | The name of the entity that was exported. |
|
|
12
|
-
**filter** | [**Object**](.md) | Map of keys and values that were used to filter the exported rows |
|
|
12
|
+
**filter** | [**Object**](.md) | Map of keys and values that were used to filter the exported rows. |
|
|
13
13
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
@@ -19,7 +19,7 @@ require 'TalonOne'
|
|
|
19
19
|
instance = TalonOne::Export.new(id: 6,
|
|
20
20
|
created: 2020-06-10T09:05:27.993483Z,
|
|
21
21
|
account_id: 3886,
|
|
22
|
-
user_id:
|
|
22
|
+
user_id: 388,
|
|
23
23
|
entity: null,
|
|
24
24
|
filter: null)
|
|
25
25
|
```
|
data/docs/FeatureFlag.md
CHANGED
|
@@ -4,19 +4,19 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**name** | **String** | The name
|
|
8
|
-
**value** | **String** | The value
|
|
9
|
-
**created** | **DateTime** | The
|
|
10
|
-
**modified** | **DateTime** | The
|
|
7
|
+
**name** | **String** | The name of the feature flag. |
|
|
8
|
+
**value** | **String** | The value of the feature flag. |
|
|
9
|
+
**created** | **DateTime** | The time this entity was last created. | [optional]
|
|
10
|
+
**modified** | **DateTime** | The time this entity was last modified. | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'TalonOne'
|
|
16
16
|
|
|
17
|
-
instance = TalonOne::FeatureFlag.new(name:
|
|
18
|
-
value:
|
|
19
|
-
created:
|
|
17
|
+
instance = TalonOne::FeatureFlag.new(name: canCreateCampaignFromTemplate,
|
|
18
|
+
value: true,
|
|
19
|
+
created: 2021-09-22T12:24:14.956203Z,
|
|
20
20
|
modified: null)
|
|
21
21
|
```
|
|
22
22
|
|
data/docs/FeedNotification.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**title** | **String** | Title of the feed notification |
|
|
8
|
-
**created** | **DateTime** | Timestamp of the moment this feed notification was created |
|
|
9
|
-
**updated** | **DateTime** | Timestamp of the moment this feed notification was last updated |
|
|
10
|
-
**article_url** | **String** | URL to the feed notification in the help center |
|
|
11
|
-
**type** | **String** | The type of the feed notification |
|
|
12
|
-
**body** | **String** | Body of the feed notification |
|
|
7
|
+
**title** | **String** | Title of the feed notification. |
|
|
8
|
+
**created** | **DateTime** | Timestamp of the moment this feed notification was created. |
|
|
9
|
+
**updated** | **DateTime** | Timestamp of the moment this feed notification was last updated. |
|
|
10
|
+
**article_url** | **String** | URL to the feed notification in the help center. |
|
|
11
|
+
**type** | **String** | The type of the feed notification. |
|
|
12
|
+
**body** | **String** | Body of the feed notification. |
|
|
13
13
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# TalonOne::FrontendState
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
|
|
8
|
+
## Code Sample
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'TalonOne'
|
|
12
|
+
|
|
13
|
+
instance = TalonOne::FrontendState.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
|
data/docs/Giveaway.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
8
|
-
**created** | **DateTime** | The
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**code** | **String** | The code value of this giveaway. |
|
|
10
10
|
**pool_id** | **Integer** | The ID of the pool to return giveaway codes from. |
|
|
11
11
|
**start_date** | **DateTime** | Timestamp at which point the giveaway becomes valid. | [optional]
|
|
@@ -13,6 +13,8 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this giveaway. | [optional]
|
|
14
14
|
**used** | **Boolean** | Indicates whether this giveaway code was given before. | [optional]
|
|
15
15
|
**import_id** | **Integer** | The ID of the Import which created this giveaway. | [optional]
|
|
16
|
+
**profile_integration_id** | **String** | The third-party integration ID of the customer profile that was awarded the giveaway, if the giveaway was awarded. | [optional]
|
|
17
|
+
**profile_id** | **Integer** | The internal ID of the customer profile that was awarded the giveaway, if the giveaway was awarded and an internal ID exists. | [optional]
|
|
16
18
|
|
|
17
19
|
## Code Sample
|
|
18
20
|
|
|
@@ -21,13 +23,15 @@ require 'TalonOne'
|
|
|
21
23
|
|
|
22
24
|
instance = TalonOne::Giveaway.new(id: 6,
|
|
23
25
|
created: 2020-06-10T09:05:27.993483Z,
|
|
24
|
-
code:
|
|
25
|
-
pool_id:
|
|
26
|
+
code: GIVEAWAY1,
|
|
27
|
+
pool_id: 1,
|
|
26
28
|
start_date: null,
|
|
27
29
|
end_date: null,
|
|
28
30
|
attributes: null,
|
|
29
|
-
used:
|
|
30
|
-
import_id:
|
|
31
|
+
used: true,
|
|
32
|
+
import_id: 4,
|
|
33
|
+
profile_integration_id: R195412,
|
|
34
|
+
profile_id: 1)
|
|
31
35
|
```
|
|
32
36
|
|
|
33
37
|
|