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
data/docs/ApplicationEvent.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
10
|
**profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
|
|
11
11
|
**session_id** | **Integer** | The globally unique Talon.One ID of the session that contains this event. | [optional]
|
|
12
12
|
**type** | **String** | A string representing the event. Must not be a reserved event name. |
|
|
13
13
|
**attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. |
|
|
14
|
-
**effects** | **Array<
|
|
14
|
+
**effects** | [**Array<Effect>**](Effect.md) | An array containing the effects that were applied as a result of this event. |
|
|
15
15
|
**rule_failure_reasons** | [**Array<RuleFailureReason>**](RuleFailureReason.md) | An array containing the rule failure reasons which happened during this event. | [optional]
|
|
16
16
|
|
|
17
17
|
## Code Sample
|
data/docs/ApplicationReferee.md
CHANGED
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
8
|
-
**session_id** | **String** | Integration ID of the session in which the customer redeemed the referral |
|
|
9
|
-
**advocate_integration_id** | **String** | Integration ID of the Advocate's Profile |
|
|
10
|
-
**friend_integration_id** | **String** | Integration ID of the Friend's Profile |
|
|
8
|
+
**session_id** | **String** | Integration ID of the session in which the customer redeemed the referral. |
|
|
9
|
+
**advocate_integration_id** | **String** | Integration ID of the Advocate's Profile. |
|
|
10
|
+
**friend_integration_id** | **String** | Integration ID of the Friend's Profile. |
|
|
11
11
|
**code** | **String** | Advocate's referral code. |
|
|
12
|
-
**created** | **DateTime** | Timestamp of the moment the customer redeemed the referral |
|
|
12
|
+
**created** | **DateTime** | Timestamp of the moment the customer redeemed the referral. |
|
|
13
13
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
data/docs/ApplicationSession.md
CHANGED
|
@@ -4,20 +4,20 @@
|
|
|
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. The time this entity was created. |
|
|
9
9
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
10
10
|
**profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
|
|
11
|
-
**integration_id** | **String** | The integration ID
|
|
11
|
+
**integration_id** | **String** | The integration ID set by your integration layer. |
|
|
12
12
|
**profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional]
|
|
13
13
|
**coupon** | **String** | Any coupon code entered. |
|
|
14
14
|
**referral** | **String** | Any referral code entered. |
|
|
15
|
-
**state** | **String** |
|
|
15
|
+
**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). |
|
|
16
16
|
**cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. |
|
|
17
17
|
**discounts** | **Hash<String, Float>** | **API V1 only.** A map of labeled discount values, in the same currency as the session. If you are using the V2 endpoints, refer to the `totalDiscounts` property instead. |
|
|
18
18
|
**total_discounts** | **Float** | The total sum of the discounts applied to this session. |
|
|
19
19
|
**total** | **Float** | The total sum of the session before any discounts applied. |
|
|
20
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
20
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
21
21
|
|
|
22
22
|
## Code Sample
|
|
23
23
|
|
data/docs/Attribute.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
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
10
10
|
**entity** | **String** | The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type. |
|
|
11
11
|
**event_type** | **String** | | [optional]
|
|
@@ -17,7 +17,9 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**has_allowed_list** | **Boolean** | Whether or not this attribute has an allowed list of values associated with it. | [optional] [default to false]
|
|
18
18
|
**restricted_by_suggestions** | **Boolean** | Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property). | [optional] [default to false]
|
|
19
19
|
**editable** | **Boolean** | Whether or not this attribute can be edited. |
|
|
20
|
-
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications
|
|
20
|
+
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications where this attribute is available. | [optional]
|
|
21
|
+
**subscribed_catalogs_ids** | **Array<Integer>** | A list of the IDs of the catalogs where this attribute is available. | [optional]
|
|
22
|
+
**allowed_subscriptions** | **Array<String>** | A list of allowed subscription types for this attribute. **Note:** This only applies to attributes associated with the `CartItem` entity. | [optional]
|
|
21
23
|
**event_type_id** | **Integer** | | [optional]
|
|
22
24
|
|
|
23
25
|
## Code Sample
|
|
@@ -28,17 +30,19 @@ require 'TalonOne'
|
|
|
28
30
|
instance = TalonOne::Attribute.new(id: 6,
|
|
29
31
|
created: 2020-06-10T09:05:27.993483Z,
|
|
30
32
|
account_id: 3886,
|
|
31
|
-
entity:
|
|
32
|
-
event_type:
|
|
33
|
-
name:
|
|
34
|
-
title:
|
|
35
|
-
type:
|
|
36
|
-
description:
|
|
33
|
+
entity: Event,
|
|
34
|
+
event_type: pageViewed,
|
|
35
|
+
name: pageViewed,
|
|
36
|
+
title: Page view event,
|
|
37
|
+
type: string,
|
|
38
|
+
description: Event triggered when a customer displays a page.,
|
|
37
39
|
suggestions: null,
|
|
38
|
-
has_allowed_list:
|
|
39
|
-
restricted_by_suggestions:
|
|
40
|
-
editable:
|
|
41
|
-
subscribed_applications_ids:
|
|
40
|
+
has_allowed_list: false,
|
|
41
|
+
restricted_by_suggestions: false,
|
|
42
|
+
editable: true,
|
|
43
|
+
subscribed_applications_ids: [1, 4, 9],
|
|
44
|
+
subscribed_catalogs_ids: [2, 5],
|
|
45
|
+
allowed_subscriptions: [application, catalog],
|
|
42
46
|
event_type_id: 22)
|
|
43
47
|
```
|
|
44
48
|
|
data/docs/Audience.md
CHANGED
|
@@ -5,11 +5,15 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
8
|
-
**id** | **Integer** |
|
|
9
|
-
**created** | **DateTime** | The
|
|
8
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
9
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
10
10
|
**name** | **String** | The human-friendly display name for this audience. |
|
|
11
|
-
**
|
|
12
|
-
**
|
|
11
|
+
**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
|
|
12
|
+
**description** | **String** | A description of the audience. | [optional]
|
|
13
|
+
**integration** | **String** | The Talon.One-supported [3rd-party platform](https://docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, `mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`. **Note:** If you do not integrate with any of these platforms, do not use this property. | [optional]
|
|
14
|
+
**integration_id** | **String** | The ID of this audience in the third-party integration. **Note:** To create an audience that doesn't come from a 3rd party platform, do not use this property. | [optional]
|
|
15
|
+
**created_in3rd_party** | **Boolean** | Determines if this audience is a 3rd party audience or not. | [optional]
|
|
16
|
+
**last_update** | **DateTime** | The last time that the audience memberships changed. | [optional]
|
|
13
17
|
|
|
14
18
|
## Code Sample
|
|
15
19
|
|
|
@@ -19,9 +23,13 @@ require 'TalonOne'
|
|
|
19
23
|
instance = TalonOne::Audience.new(account_id: 3886,
|
|
20
24
|
id: 6,
|
|
21
25
|
created: 2020-06-10T09:05:27.993483Z,
|
|
22
|
-
name:
|
|
26
|
+
name: Travel audience,
|
|
27
|
+
sandbox: true,
|
|
28
|
+
description: Travel audience 18-25,
|
|
23
29
|
integration: mparticle,
|
|
24
|
-
integration_id: 382370BKDB946
|
|
30
|
+
integration_id: 382370BKDB946,
|
|
31
|
+
created_in3rd_party: false,
|
|
32
|
+
last_update: 2022-04-26T11:02:38Z)
|
|
25
33
|
```
|
|
26
34
|
|
|
27
35
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::AudienceAnalytics
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**audience_id** | **Integer** | The ID of the audience. | [optional]
|
|
8
|
+
**members_count** | **Integer** | The count of members under a single audience. | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::AudienceAnalytics.new(audience_id: 1,
|
|
16
|
+
members_count: 1234)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# TalonOne::AudienceCustomer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
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
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. |
|
|
11
|
+
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
|
12
|
+
**closed_sessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. |
|
|
13
|
+
**total_sales** | **Float** | The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items. |
|
|
14
|
+
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
|
|
15
|
+
**audience_memberships** | [**Array<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional]
|
|
16
|
+
**last_activity** | **DateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#operation/createCouponReservation) for a customer doesn't impact this field. |
|
|
17
|
+
**sandbox** | **Boolean** | Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). | [optional]
|
|
18
|
+
**connected_applications_ids** | **Array<Integer>** | A list of the IDs of the Applications that are connected to this customer profile. | [optional]
|
|
19
|
+
**connected_audiences** | **Array<Integer>** | A list of the IDs of the audiences that are connected to this customer profile. | [optional]
|
|
20
|
+
|
|
21
|
+
## Code Sample
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'TalonOne'
|
|
25
|
+
|
|
26
|
+
instance = TalonOne::AudienceCustomer.new(id: 6,
|
|
27
|
+
created: null,
|
|
28
|
+
integration_id: URNGV8294NV,
|
|
29
|
+
attributes: {"Language":"english","ShippingCountry":"DE"},
|
|
30
|
+
account_id: 31,
|
|
31
|
+
closed_sessions: 3,
|
|
32
|
+
total_sales: 299.99,
|
|
33
|
+
loyalty_memberships: null,
|
|
34
|
+
audience_memberships: null,
|
|
35
|
+
last_activity: 2020-02-08T14:15:20Z,
|
|
36
|
+
sandbox: false,
|
|
37
|
+
connected_applications_ids: [1, 2, 3],
|
|
38
|
+
connected_audiences: [1, 2, 3])
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::AudienceIntegrationID
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**integration_id** | **String** | The ID of this audience in the third-party integration. | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::AudienceIntegrationID.new(integration_id: 382370BKDB946)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/AudienceMembership.md
CHANGED
|
@@ -15,11 +15,11 @@ Name | Type | Description | Notes
|
|
|
15
15
|
```ruby
|
|
16
16
|
require 'TalonOne'
|
|
17
17
|
|
|
18
|
-
instance = TalonOne::AwardGiveawayEffectProps.new(pool_id:
|
|
19
|
-
pool_name:
|
|
20
|
-
recipient_integration_id:
|
|
21
|
-
giveaway_id:
|
|
22
|
-
code:
|
|
18
|
+
instance = TalonOne::AwardGiveawayEffectProps.new(pool_id: 2,
|
|
19
|
+
pool_name: My pool,
|
|
20
|
+
recipient_integration_id: URNGV8294NV,
|
|
21
|
+
giveaway_id: 5,
|
|
22
|
+
code: 57638t-67439hty)
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
|
data/docs/BaseLoyaltyProgram.md
CHANGED
|
@@ -7,10 +7,11 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**title** | **String** | The display title for the Loyalty Program. | [optional]
|
|
8
8
|
**description** | **String** | Description of our Loyalty Program. | [optional]
|
|
9
9
|
**subscribed_applications** | **Array<Integer>** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional]
|
|
10
|
-
**default_validity** | **String** |
|
|
11
|
-
**default_pending** | **String** |
|
|
12
|
-
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program | [optional]
|
|
10
|
+
**default_validity** | **String** | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | [optional]
|
|
11
|
+
**default_pending** | **String** | The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | [optional]
|
|
12
|
+
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional]
|
|
13
13
|
**users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
|
|
14
|
+
**sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional]
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
@@ -20,10 +21,11 @@ require 'TalonOne'
|
|
|
20
21
|
instance = TalonOne::BaseLoyaltyProgram.new(title: Point collection,
|
|
21
22
|
description: Customers collect 10 points per 1$ spent,
|
|
22
23
|
subscribed_applications: [132, 97],
|
|
23
|
-
default_validity:
|
|
24
|
+
default_validity: 2W_U,
|
|
24
25
|
default_pending: immediate,
|
|
25
26
|
allow_subledger: false,
|
|
26
|
-
users_per_card_limit: 111
|
|
27
|
+
users_per_card_limit: 111,
|
|
28
|
+
sandbox: true)
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::BaseNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**policy** | [**Object**](.md) | |
|
|
8
|
+
**webhook** | [**BaseNotificationWebhook**](BaseNotificationWebhook.md) | |
|
|
9
|
+
**id** | **Integer** | Unique ID for this entity. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::BaseNotification.new(policy: null,
|
|
17
|
+
webhook: null,
|
|
18
|
+
id: 6)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::BaseNotificationEntity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**policy** | [**Object**](.md) | |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::BaseNotificationEntity.new(policy: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# TalonOne::BaseNotificationWebhook
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
|
+
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
|
+
**url** | **String** | API URL for the given webhook-based notification. |
|
|
11
|
+
**headers** | **Array<String>** | List of API HTTP headers for the given webhook-based notification. |
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'TalonOne'
|
|
17
|
+
|
|
18
|
+
instance = TalonOne::BaseNotificationWebhook.new(id: 6,
|
|
19
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
20
|
+
modified: 2021-09-12T10:12:42Z,
|
|
21
|
+
url: www.my-company.com/my-endpoint-name,
|
|
22
|
+
headers: content-type: application/json)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::BaseNotifications
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**data** | [**Array<BaseNotification>**](BaseNotification.md) | List of notifications. | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::BaseNotifications.new(data: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/BaseSamlConnection.md
CHANGED
data/docs/Campaign.md
CHANGED
|
@@ -7,20 +7,20 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**id** | **Integer** | Unique ID for this entity. |
|
|
8
8
|
**created** | **DateTime** | The exact moment this entity was created. |
|
|
9
9
|
**application_id** | **Integer** | The ID of the application 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
|
**name** | **String** | A user-facing name for this campaign. |
|
|
12
12
|
**description** | **String** | A detailed description of the campaign. |
|
|
13
13
|
**start_time** | **DateTime** | Timestamp when the campaign will become active. | [optional]
|
|
14
14
|
**end_time** | **DateTime** | Timestamp the campaign will become inactive. | [optional]
|
|
15
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]
|
|
15
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
|
|
16
16
|
**state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to 'enabled']
|
|
17
|
-
**active_ruleset_id** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api
|
|
17
|
+
**active_ruleset_id** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
|
|
18
18
|
**tags** | **Array<String>** | A list of tags for the campaign. |
|
|
19
19
|
**features** | **Array<String>** | The features enabled in this campaign. |
|
|
20
20
|
**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
21
21
|
**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
22
|
-
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets
|
|
23
|
-
**campaign_groups** | **Array<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups
|
|
22
|
+
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. |
|
|
23
|
+
**campaign_groups** | **Array<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional]
|
|
24
24
|
**coupon_redemption_count** | **Integer** | Number of coupons redeemed in the campaign. | [optional]
|
|
25
25
|
**referral_redemption_count** | **Integer** | Number of referral codes redeemed in the campaign. | [optional]
|
|
26
26
|
**discount_count** | **Float** | Total amount of discounts redeemed in the campaign. | [optional]
|
|
@@ -35,6 +35,7 @@ Name | Type | Description | Notes
|
|
|
35
35
|
**redeemed_loyalty_points_count** | **Float** | Total number of loyalty points redeemed by rules in this campaign. | [optional]
|
|
36
36
|
**redeemed_loyalty_points_effect_count** | **Integer** | Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional]
|
|
37
37
|
**call_api_effect_count** | **Integer** | Total number of webhook triggered by rules in this campaign. | [optional]
|
|
38
|
+
**reservecoupon_effect_count** | **Integer** | Total number of reserve coupon effects triggered by rules in this campaign. | [optional]
|
|
38
39
|
**last_activity** | **DateTime** | Timestamp of the most recent event received by this campaign. | [optional]
|
|
39
40
|
**updated** | **DateTime** | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional]
|
|
40
41
|
**created_by** | **String** | Name of the user who created this campaign if available. | [optional]
|
|
@@ -46,38 +47,39 @@ Name | Type | Description | Notes
|
|
|
46
47
|
```ruby
|
|
47
48
|
require 'TalonOne'
|
|
48
49
|
|
|
49
|
-
instance = TalonOne::Campaign.new(id:
|
|
50
|
-
created:
|
|
50
|
+
instance = TalonOne::Campaign.new(id: 4,
|
|
51
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
51
52
|
application_id: 322,
|
|
52
|
-
user_id:
|
|
53
|
+
user_id: 388,
|
|
53
54
|
name: Summer promotions,
|
|
54
55
|
description: Campaign for all summer 2021 promotions,
|
|
55
56
|
start_time: 2021-07-20T22:00Z,
|
|
56
57
|
end_time: 2021-09-22T22:00Z,
|
|
57
58
|
attributes: null,
|
|
58
|
-
state:
|
|
59
|
-
active_ruleset_id:
|
|
59
|
+
state: enabled,
|
|
60
|
+
active_ruleset_id: 6,
|
|
60
61
|
tags: [summer],
|
|
61
62
|
features: [coupons, referrals],
|
|
62
63
|
coupon_settings: null,
|
|
63
64
|
referral_settings: null,
|
|
64
65
|
limits: null,
|
|
65
66
|
campaign_groups: [1, 3],
|
|
66
|
-
coupon_redemption_count:
|
|
67
|
-
referral_redemption_count:
|
|
68
|
-
discount_count:
|
|
69
|
-
discount_effect_count:
|
|
70
|
-
coupon_creation_count:
|
|
71
|
-
custom_effect_count:
|
|
72
|
-
referral_creation_count:
|
|
73
|
-
add_free_item_effect_count:
|
|
74
|
-
awarded_giveaways_count:
|
|
75
|
-
created_loyalty_points_count:
|
|
76
|
-
created_loyalty_points_effect_count:
|
|
77
|
-
redeemed_loyalty_points_count:
|
|
78
|
-
redeemed_loyalty_points_effect_count:
|
|
79
|
-
call_api_effect_count:
|
|
80
|
-
|
|
67
|
+
coupon_redemption_count: 163,
|
|
68
|
+
referral_redemption_count: 3,
|
|
69
|
+
discount_count: 288.0,
|
|
70
|
+
discount_effect_count: 343,
|
|
71
|
+
coupon_creation_count: 16,
|
|
72
|
+
custom_effect_count: 0,
|
|
73
|
+
referral_creation_count: 8,
|
|
74
|
+
add_free_item_effect_count: 0,
|
|
75
|
+
awarded_giveaways_count: 9,
|
|
76
|
+
created_loyalty_points_count: 9.0,
|
|
77
|
+
created_loyalty_points_effect_count: 2,
|
|
78
|
+
redeemed_loyalty_points_count: 8.0,
|
|
79
|
+
redeemed_loyalty_points_effect_count: 9,
|
|
80
|
+
call_api_effect_count: 0,
|
|
81
|
+
reservecoupon_effect_count: 9,
|
|
82
|
+
last_activity: 2022-11-10T23:00Z,
|
|
81
83
|
updated: null,
|
|
82
84
|
created_by: John Doe,
|
|
83
85
|
updated_by: Jane Doe,
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::CampaignActivationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**user_ids** | **Array<Integer>** | The list of IDs of the users who will receive the activation request. |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::CampaignActivationRequest.new(user_ids: [1, 2, 3])
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/CampaignAnalytics.md
CHANGED
|
@@ -35,9 +35,9 @@ Name | Type | Description | Notes
|
|
|
35
35
|
```ruby
|
|
36
36
|
require 'TalonOne'
|
|
37
37
|
|
|
38
|
-
instance = TalonOne::CampaignAnalytics.new(date:
|
|
39
|
-
campaign_revenue:
|
|
40
|
-
total_campaign_revenue:
|
|
38
|
+
instance = TalonOne::CampaignAnalytics.new(date: 2021-10-12T10:12:42Z,
|
|
39
|
+
campaign_revenue: 3539.76,
|
|
40
|
+
total_campaign_revenue: 5784.63,
|
|
41
41
|
campaign_refund: null,
|
|
42
42
|
total_campaign_refund: null,
|
|
43
43
|
campaign_discount_costs: null,
|
|
@@ -45,7 +45,7 @@ instance = TalonOne::CampaignAnalytics.new(date: null,
|
|
|
45
45
|
campaign_refunded_discounts: null,
|
|
46
46
|
total_campaign_refunded_discounts: null,
|
|
47
47
|
campaign_free_items: null,
|
|
48
|
-
total_campaign_free_items:
|
|
48
|
+
total_campaign_free_items: 86,
|
|
49
49
|
coupon_redemptions: null,
|
|
50
50
|
total_coupon_redemptions: null,
|
|
51
51
|
coupon_rolledback_redemptions: null,
|
|
@@ -56,10 +56,10 @@ instance = TalonOne::CampaignAnalytics.new(date: null,
|
|
|
56
56
|
total_coupons_created: null,
|
|
57
57
|
referrals_created: null,
|
|
58
58
|
total_referrals_created: null,
|
|
59
|
-
added_loyalty_points:
|
|
60
|
-
total_added_loyalty_points:
|
|
61
|
-
deducted_loyalty_points:
|
|
62
|
-
total_deducted_loyalty_points:
|
|
59
|
+
added_loyalty_points: 250.0,
|
|
60
|
+
total_added_loyalty_points: 340.0,
|
|
61
|
+
deducted_loyalty_points: 120.0,
|
|
62
|
+
total_deducted_loyalty_points: 220.0)
|
|
63
63
|
```
|
|
64
64
|
|
|
65
65
|
|
data/docs/CampaignCollection.md
CHANGED
|
@@ -4,10 +4,10 @@
|
|
|
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
|
-
**modified** | **DateTime** | The
|
|
10
|
+
**modified** | **DateTime** | The time this entity was last modified. |
|
|
11
11
|
**description** | **String** | A short description of the purpose of this collection. | [optional]
|
|
12
12
|
**name** | **String** | The name of this collection. |
|
|
13
13
|
**modified_by** | **Integer** | ID of the user who last updated this effect if available. | [optional]
|
|
@@ -4,10 +4,10 @@
|
|
|
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
|
-
**modified** | **DateTime** | The
|
|
10
|
+
**modified** | **DateTime** | The time this entity was last modified. |
|
|
11
11
|
**description** | **String** | A short description of the purpose of this collection. | [optional]
|
|
12
12
|
**name** | **String** | The name of this collection. |
|
|
13
13
|
**modified_by** | **Integer** | ID of the user who last updated this effect if available. | [optional]
|