talon_one 3.0.1 → 4.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Makefile +9 -6
- data/README.md +150 -51
- data/docs/AccountAnalytics.md +3 -1
- data/docs/AccountDashboardStatistic.md +0 -2
- data/docs/AccountDashboardStatisticCampaigns.md +4 -2
- data/docs/Achievement.md +39 -0
- data/docs/AchievementAdditionalProperties.md +23 -0
- data/docs/AchievementProgress.md +35 -0
- data/docs/AddItemCatalogAction.md +3 -1
- data/docs/AddLoyaltyPoints.md +2 -2
- data/docs/AddLoyaltyPointsEffectProps.md +1 -1
- data/docs/AddToAudienceEffectProps.md +23 -0
- data/docs/AdditionalCampaignProperties.md +59 -0
- data/docs/Application.md +3 -5
- data/docs/ApplicationAPIKey.md +6 -2
- data/docs/ApplicationAnalyticsDataPoint.md +31 -0
- data/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md +19 -0
- data/docs/ApplicationAnalyticsDataPointAvgSessionValue.md +19 -0
- data/docs/ApplicationAnalyticsDataPointSessionsCount.md +19 -0
- data/docs/ApplicationAnalyticsDataPointTotalRevenue.md +19 -0
- data/docs/ApplicationCampaignAnalytics.md +45 -0
- data/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md +21 -0
- data/docs/ApplicationCampaignAnalyticsAvgSessionValue.md +21 -0
- data/docs/ApplicationCampaignAnalyticsCouponsCount.md +19 -0
- data/docs/ApplicationCampaignAnalyticsSessionsCount.md +21 -0
- data/docs/ApplicationCampaignAnalyticsTotalDiscounts.md +19 -0
- data/docs/ApplicationCampaignAnalyticsTotalRevenue.md +21 -0
- data/docs/ApplicationCustomer.md +2 -2
- data/docs/ApplicationEvent.md +4 -0
- data/docs/ApplicationNotification.md +1 -1
- data/docs/ApplicationSession.md +5 -3
- data/docs/ApplicationStoreEntity.md +17 -0
- data/docs/Audience.md +1 -1
- data/docs/AudienceAnalytics.md +1 -1
- data/docs/AudienceCustomer.md +2 -2
- data/docs/BaseCampaign.md +45 -0
- data/docs/BaseLoyaltyProgram.md +9 -1
- data/docs/BaseNotification.md +5 -1
- data/docs/BaseNotificationEntity.md +3 -1
- data/docs/BaseNotificationWebhook.md +3 -1
- data/docs/BulkOperationOnCampaigns.md +19 -0
- data/docs/Campaign.md +25 -17
- data/docs/CampaignBudget.md +21 -0
- data/docs/CampaignCopy.md +3 -1
- data/docs/CampaignCreatedNotification.md +2 -2
- data/docs/CampaignEvaluationGroup.md +31 -0
- data/docs/CampaignEvaluationPosition.md +21 -0
- data/docs/CampaignEvaluationTreeChangedNotification.md +21 -0
- data/docs/CampaignGroup.md +6 -6
- data/docs/CampaignNotificationPolicy.md +17 -0
- data/docs/CampaignSet.md +3 -5
- data/docs/CampaignSetBranchNode.md +13 -3
- data/docs/CampaignTemplate.md +2 -0
- data/docs/CardExpiringPointsNotificationPolicy.md +21 -0
- data/docs/CardExpiringPointsNotificationTrigger.md +19 -0
- data/docs/CardLedgerPointsEntryIntegrationAPI.md +35 -0
- data/docs/CartItem.md +4 -2
- data/docs/CatalogItem.md +3 -1
- data/docs/ChangeLoyaltyTierLevelEffectProps.md +27 -0
- data/docs/Coupon.md +4 -2
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponsNotificationPolicy.md +3 -1
- data/docs/CreateAchievement.md +27 -0
- data/docs/CreateApplicationAPIKey.md +7 -3
- data/docs/CreateTemplateCampaign.md +6 -2
- data/docs/CustomEffectProps.md +1 -1
- data/docs/CustomerInventory.md +3 -1
- data/docs/CustomerProfile.md +2 -2
- data/docs/CustomerProfileAudienceRequestItem.md +1 -1
- data/docs/CustomerProfileIntegrationResponseV2.md +33 -0
- data/docs/CustomerSession.md +1 -1
- data/docs/CustomerSessionV2.md +8 -6
- data/docs/DeactivateUserRequest.md +17 -0
- data/docs/DeleteUserRequest.md +17 -0
- data/docs/Effect.md +2 -0
- data/docs/EffectEntity.md +3 -1
- data/docs/EmailEntity.md +1 -1
- data/docs/Environment.md +2 -0
- data/docs/Event.md +2 -0
- data/docs/EventV2.md +4 -2
- data/docs/ExpiringCouponsNotificationPolicy.md +21 -0
- data/docs/ExpiringCouponsNotificationTrigger.md +19 -0
- data/docs/ExpiringPointsNotificationPolicy.md +4 -2
- data/docs/FuncArgDef.md +1 -1
- data/docs/GetIntegrationCouponRequest.md +19 -0
- data/docs/IdentifiableEntity.md +17 -0
- data/docs/IncreaseAchievementProgressEffectProps.md +29 -0
- data/docs/InlineResponse20010.md +1 -1
- data/docs/InlineResponse20011.md +1 -1
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +3 -3
- data/docs/InlineResponse20014.md +2 -2
- data/docs/InlineResponse20015.md +3 -5
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +1 -1
- data/docs/InlineResponse20018.md +1 -1
- data/docs/InlineResponse20019.md +2 -2
- data/docs/InlineResponse20020.md +1 -1
- data/docs/InlineResponse20021.md +2 -4
- data/docs/InlineResponse20022.md +3 -3
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +3 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +2 -2
- data/docs/InlineResponse20027.md +2 -2
- data/docs/InlineResponse20028.md +3 -3
- data/docs/InlineResponse20029.md +3 -5
- data/docs/InlineResponse2003.md +3 -3
- data/docs/InlineResponse20030.md +1 -1
- data/docs/InlineResponse20031.md +3 -3
- data/docs/InlineResponse20032.md +3 -3
- data/docs/InlineResponse20033.md +5 -3
- data/docs/InlineResponse20034.md +1 -1
- data/docs/InlineResponse20035.md +5 -3
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +1 -1
- data/docs/InlineResponse20038.md +2 -4
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse2004.md +3 -3
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +19 -0
- data/docs/InlineResponse20042.md +21 -0
- data/docs/InlineResponse20043.md +19 -0
- data/docs/InlineResponse20044.md +19 -0
- data/docs/InlineResponse20045.md +21 -0
- data/docs/InlineResponse20046.md +19 -0
- data/docs/InlineResponse20047.md +19 -0
- data/docs/InlineResponse2005.md +1 -1
- data/docs/InlineResponse2006.md +1 -1
- data/docs/InlineResponse2007.md +1 -1
- data/docs/InlineResponse2008.md +2 -2
- data/docs/InlineResponse2009.md +1 -1
- data/docs/IntegrationApi.md +204 -117
- data/docs/IntegrationCoupon.md +3 -1
- data/docs/IntegrationEvent.md +2 -0
- data/docs/IntegrationEventV2Request.md +4 -2
- data/docs/IntegrationRequest.md +1 -1
- data/docs/IntegrationStoreEntity.md +17 -0
- data/docs/InventoryCoupon.md +4 -2
- data/docs/LedgerPointsEntryIntegrationAPI.md +33 -0
- data/docs/LoginParams.md +1 -1
- data/docs/LoyaltyLedgerTransactions.md +1 -1
- data/docs/LoyaltyProgram.md +15 -1
- data/docs/LoyaltyProgramLedgers.md +2 -0
- data/docs/LoyaltyProgramSubledgers.md +19 -0
- data/docs/LoyaltyProgramTransaction.md +4 -2
- data/docs/ManagementApi.md +3313 -1620
- data/docs/MessageLogEntries.md +19 -0
- data/docs/MessageLogEntry.md +39 -0
- data/docs/MessageLogRequest.md +19 -0
- data/docs/MessageLogResponse.md +21 -0
- data/docs/NewAccountSignUp.md +1 -1
- data/docs/NewApplication.md +6 -10
- data/docs/NewApplicationAPIKey.md +6 -2
- data/docs/NewAudience.md +1 -1
- data/docs/NewBaseNotification.md +2 -0
- data/docs/NewCampaign.md +8 -2
- data/docs/NewCampaignEvaluationGroup.md +27 -0
- data/docs/NewCampaignGroup.md +6 -6
- data/docs/NewCampaignTemplate.md +3 -1
- data/docs/NewCoupons.md +4 -2
- data/docs/NewCustomerSession.md +1 -1
- data/docs/NewCustomerSessionV2.md +5 -3
- data/docs/NewEvent.md +2 -0
- data/docs/NewInternalAudience.md +1 -1
- data/docs/NewInvitation.md +8 -6
- data/docs/NewInviteEmail.md +4 -4
- data/docs/NewLoyaltyProgram.md +8 -0
- data/docs/NewNotificationTest.md +29 -0
- data/docs/NewNotificationWebhook.md +3 -1
- data/docs/NewPicklist.md +1 -1
- data/docs/NewRoleV2.md +23 -0
- data/docs/NewStore.md +23 -0
- data/docs/NewUser.md +1 -1
- data/docs/NotificationActivation.md +17 -0
- data/docs/NotificationListItem.md +23 -0
- data/docs/NotificationTest.md +27 -0
- data/docs/OneTimeCode.md +23 -0
- data/docs/OutgoingIntegrationCleverTapPolicy.md +21 -0
- data/docs/OutgoingIntegrationConfiguration.md +1 -1
- data/docs/OutgoingIntegrationIterablePolicy.md +19 -0
- data/docs/OutgoingIntegrationMoEngagePolicy.md +23 -0
- data/docs/OutgoingIntegrationTemplate.md +33 -0
- data/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md +35 -0
- data/docs/OutgoingIntegrationTemplates.md +17 -0
- data/docs/OutgoingIntegrationType.md +1 -1
- data/docs/PatchItemCatalogAction.md +2 -0
- data/docs/PendingPointsNotificationPolicy.md +19 -0
- data/docs/Picklist.md +1 -1
- data/docs/Product.md +17 -0
- data/docs/RemoveFromAudienceEffectProps.md +23 -0
- data/docs/ReturnedCartItem.md +1 -1
- data/docs/Role.md +1 -1
- data/docs/RoleAssign.md +2 -2
- data/docs/RoleV2.md +12 -6
- data/docs/RoleV2ApplicationDetails.md +6 -4
- data/docs/RoleV2Base.md +23 -0
- data/docs/RoleV2PermissionSet.md +3 -3
- data/docs/RoleV2Permissions.md +3 -3
- data/docs/RoleV2RolesGroup.md +21 -0
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +1 -1
- data/docs/RollbackDiscountEffectProps.md +1 -1
- data/docs/SSOConfig.md +17 -0
- data/docs/SamlConnectionInternal.md +19 -0
- data/docs/SamlLoginEndpoint.md +4 -2
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +1 -1
- data/docs/SetDiscountPerItemEffectProps.md +6 -2
- data/docs/Store.md +33 -0
- data/docs/TemplateArgDef.md +1 -1
- data/docs/Tier.md +5 -1
- data/docs/TierDowngradeNotificationPolicy.md +19 -0
- data/docs/TierUpgradeNotificationPolicy.md +19 -0
- data/docs/TierWillDowngradeNotificationPolicy.md +21 -0
- data/docs/TierWillDowngradeNotificationTrigger.md +19 -0
- data/docs/TimePoint.md +27 -0
- data/docs/TrackEventV2Response.md +33 -0
- data/docs/TwoFAConfig.md +19 -0
- data/docs/UpdateAchievement.md +27 -0
- data/docs/UpdateApplication.md +4 -6
- data/docs/UpdateApplicationAPIKey.md +17 -0
- data/docs/UpdateCampaign.md +9 -3
- data/docs/UpdateCampaignEvaluationGroup.md +27 -0
- data/docs/UpdateCampaignGroup.md +6 -6
- data/docs/UpdateCampaignTemplate.md +3 -1
- data/docs/UpdateCoupon.md +4 -2
- data/docs/UpdateCouponBatch.md +2 -2
- data/docs/UpdateLoyaltyProgram.md +8 -0
- data/docs/UpdatePicklist.md +1 -1
- data/docs/UpdateStore.md +21 -0
- data/docs/UpdateUser.md +8 -6
- data/docs/User.md +19 -13
- data/docs/WebhookWithOutgoingIntegrationDetails.md +45 -0
- data/lib/talon_one/api/integration_api.rb +283 -136
- data/lib/talon_one/api/management_api.rb +2787 -890
- data/lib/talon_one/api_client.rb +2 -1
- data/lib/talon_one/api_error.rb +8 -1
- data/lib/talon_one/models/account_additional_cost.rb +3 -3
- data/lib/talon_one/models/account_analytics.rb +19 -4
- data/lib/talon_one/models/account_dashboard_statistic.rb +1 -13
- data/lib/talon_one/models/account_dashboard_statistic_campaigns.rb +20 -5
- data/lib/talon_one/models/achievement.rb +406 -0
- data/lib/talon_one/models/achievement_additional_properties.rb +252 -0
- data/lib/talon_one/models/achievement_progress.rb +410 -0
- data/lib/talon_one/models/add_item_catalog_action.rb +12 -3
- data/lib/talon_one/models/add_loyalty_points.rb +2 -2
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +1 -1
- data/lib/talon_one/models/add_to_audience_effect_props.rb +238 -0
- data/lib/talon_one/models/additional_campaign_properties.rb +463 -0
- data/lib/talon_one/models/application.rb +12 -50
- data/lib/talon_one/models/application_analytics_data_point.rb +273 -0
- data/lib/talon_one/models/application_analytics_data_point_avg_items_per_session.rb +216 -0
- data/lib/talon_one/models/application_analytics_data_point_avg_session_value.rb +216 -0
- data/lib/talon_one/models/application_analytics_data_point_sessions_count.rb +216 -0
- data/lib/talon_one/models/application_analytics_data_point_total_revenue.rb +216 -0
- data/lib/talon_one/models/application_api_key.rb +37 -5
- data/lib/talon_one/models/application_campaign_analytics.rb +379 -0
- data/lib/talon_one/models/application_campaign_analytics_avg_items_per_session.rb +225 -0
- data/lib/talon_one/models/application_campaign_analytics_avg_session_value.rb +225 -0
- data/lib/talon_one/models/application_campaign_analytics_coupons_count.rb +216 -0
- data/lib/talon_one/models/application_campaign_analytics_sessions_count.rb +225 -0
- data/lib/talon_one/models/application_campaign_analytics_total_discounts.rb +216 -0
- data/lib/talon_one/models/application_campaign_analytics_total_revenue.rb +225 -0
- data/lib/talon_one/models/application_customer.rb +2 -2
- data/lib/talon_one/models/application_event.rb +45 -1
- data/lib/talon_one/models/application_notification.rb +1 -1
- data/lib/talon_one/models/application_session.rb +51 -17
- data/lib/talon_one/models/application_store_entity.rb +207 -0
- data/lib/talon_one/models/attribute.rb +2 -2
- data/lib/talon_one/models/audience_analytics.rb +2 -2
- data/lib/talon_one/models/audience_customer.rb +2 -2
- data/lib/talon_one/models/base_campaign.rb +449 -0
- data/lib/talon_one/models/base_loyalty_program.rb +102 -4
- data/lib/talon_one/models/base_notification.rb +65 -4
- data/lib/talon_one/models/base_notification_entity.rb +16 -4
- data/lib/talon_one/models/base_notification_webhook.rb +16 -4
- data/lib/talon_one/models/bulk_operation_on_campaigns.rb +263 -0
- data/lib/talon_one/models/campaign.rb +105 -20
- data/lib/talon_one/models/campaign_budget.rb +280 -0
- data/lib/talon_one/models/campaign_copy.rb +14 -4
- data/lib/talon_one/models/campaign_created_notification.rb +10 -10
- data/lib/talon_one/models/campaign_evaluation_group.rb +378 -0
- data/lib/talon_one/models/campaign_evaluation_position.rb +243 -0
- data/lib/talon_one/models/campaign_evaluation_tree_changed_notification.rb +236 -0
- data/lib/talon_one/models/campaign_group.rb +4 -4
- data/lib/talon_one/models/campaign_notification_policy.rb +231 -0
- data/lib/talon_one/models/campaign_set.rb +16 -31
- data/lib/talon_one/models/campaign_set_branch_node.rb +100 -6
- data/lib/talon_one/models/campaign_template.rb +30 -1
- data/lib/talon_one/models/card_expiring_points_notification_policy.rb +259 -0
- data/lib/talon_one/models/card_expiring_points_notification_trigger.rb +280 -0
- data/lib/talon_one/models/card_ledger_points_entry_integration_api.rb +410 -0
- data/lib/talon_one/models/cart_item.rb +12 -3
- data/lib/talon_one/models/catalog_item.rb +13 -4
- data/lib/talon_one/models/change_loyalty_tier_level_effect_props.rb +278 -0
- data/lib/talon_one/models/coupon.rb +15 -5
- data/lib/talon_one/models/coupon_creation_job.rb +1 -1
- data/lib/talon_one/models/coupons_notification_policy.rb +16 -4
- data/lib/talon_one/models/create_achievement.rb +320 -0
- data/lib/talon_one/models/create_application_api_key.rb +40 -8
- data/lib/talon_one/models/create_template_campaign.rb +27 -5
- data/lib/talon_one/models/custom_effect_props.rb +1 -1
- data/lib/talon_one/models/customer_inventory.rb +15 -4
- data/lib/talon_one/models/customer_profile.rb +2 -2
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +1 -1
- data/lib/talon_one/models/customer_profile_integration_response_v2.rb +307 -0
- data/lib/talon_one/models/customer_session.rb +1 -1
- data/lib/talon_one/models/customer_session_v2.rb +41 -7
- data/lib/talon_one/models/deactivate_user_request.rb +213 -0
- data/lib/talon_one/models/delete_user_request.rb +213 -0
- data/lib/talon_one/models/effect.rb +11 -1
- data/lib/talon_one/models/effect_entity.rb +14 -4
- data/lib/talon_one/models/email_entity.rb +1 -1
- data/lib/talon_one/models/environment.rb +13 -1
- data/lib/talon_one/models/event.rb +35 -1
- data/lib/talon_one/models/event_v2.rb +37 -3
- data/lib/talon_one/models/expiring_coupons_notification_policy.rb +259 -0
- data/lib/talon_one/models/expiring_coupons_notification_trigger.rb +280 -0
- data/lib/talon_one/models/expiring_points_notification_policy.rb +16 -4
- data/lib/talon_one/models/func_arg_def.rb +0 -5
- data/lib/talon_one/models/get_integration_coupon_request.rb +257 -0
- data/lib/talon_one/models/identifiable_entity.rb +212 -0
- data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +298 -0
- data/lib/talon_one/models/inline_response20010.rb +1 -1
- data/lib/talon_one/models/inline_response20011.rb +1 -1
- data/lib/talon_one/models/inline_response20012.rb +1 -1
- data/lib/talon_one/models/inline_response20013.rb +11 -11
- data/lib/talon_one/models/inline_response20014.rb +1 -3
- data/lib/talon_one/models/inline_response20015.rb +7 -11
- data/lib/talon_one/models/inline_response20016.rb +3 -1
- data/lib/talon_one/models/inline_response20017.rb +1 -1
- data/lib/talon_one/models/inline_response20018.rb +1 -1
- data/lib/talon_one/models/inline_response20019.rb +10 -10
- data/lib/talon_one/models/inline_response20020.rb +1 -1
- data/lib/talon_one/models/inline_response20021.rb +7 -11
- data/lib/talon_one/models/inline_response20022.rb +10 -10
- data/lib/talon_one/models/inline_response20023.rb +1 -1
- data/lib/talon_one/models/inline_response20024.rb +10 -6
- data/lib/talon_one/models/inline_response20025.rb +1 -1
- data/lib/talon_one/models/inline_response20026.rb +6 -1
- data/lib/talon_one/models/inline_response20027.rb +1 -6
- data/lib/talon_one/models/inline_response20028.rb +11 -11
- data/lib/talon_one/models/inline_response20029.rb +7 -11
- data/lib/talon_one/models/inline_response2003.rb +11 -11
- data/lib/talon_one/models/inline_response20030.rb +1 -1
- data/lib/talon_one/models/inline_response20031.rb +8 -13
- data/lib/talon_one/models/inline_response20032.rb +8 -13
- data/lib/talon_one/models/inline_response20033.rb +11 -7
- data/lib/talon_one/models/inline_response20034.rb +1 -1
- data/lib/talon_one/models/inline_response20035.rb +11 -7
- data/lib/talon_one/models/inline_response20036.rb +1 -1
- data/lib/talon_one/models/inline_response20037.rb +1 -1
- data/lib/talon_one/models/inline_response20038.rb +7 -11
- data/lib/talon_one/models/inline_response20039.rb +1 -1
- data/lib/talon_one/models/inline_response2004.rb +11 -11
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +227 -0
- data/lib/talon_one/models/inline_response20042.rb +231 -0
- data/lib/talon_one/models/inline_response20043.rb +227 -0
- data/lib/talon_one/models/inline_response20044.rb +227 -0
- data/lib/talon_one/models/inline_response20045.rb +231 -0
- data/lib/talon_one/models/inline_response20046.rb +222 -0
- data/lib/talon_one/models/inline_response20047.rb +227 -0
- data/lib/talon_one/models/inline_response2005.rb +1 -1
- data/lib/talon_one/models/inline_response2006.rb +1 -1
- data/lib/talon_one/models/inline_response2007.rb +1 -1
- data/lib/talon_one/models/inline_response2008.rb +10 -10
- data/lib/talon_one/models/inline_response2009.rb +1 -1
- data/lib/talon_one/models/integration_coupon.rb +12 -2
- data/lib/talon_one/models/integration_event.rb +35 -1
- data/lib/talon_one/models/integration_event_v2_request.rb +37 -3
- data/lib/talon_one/models/integration_request.rb +1 -1
- data/lib/talon_one/models/integration_store_entity.rb +231 -0
- data/lib/talon_one/models/inventory_coupon.rb +13 -3
- data/lib/talon_one/models/ledger_points_entry_integration_api.rb +400 -0
- data/lib/talon_one/models/login_params.rb +1 -1
- data/lib/talon_one/models/loyalty.rb +1 -1
- data/lib/talon_one/models/loyalty_ledger_transactions.rb +1 -1
- data/lib/talon_one/models/loyalty_program.rb +136 -4
- data/lib/talon_one/models/loyalty_program_ledgers.rb +12 -2
- data/lib/talon_one/models/loyalty_program_subledgers.rb +230 -0
- data/lib/talon_one/models/loyalty_program_transaction.rb +13 -3
- data/lib/talon_one/models/message_log_entries.rb +241 -0
- data/lib/talon_one/models/message_log_entry.rb +395 -0
- data/lib/talon_one/models/message_log_request.rb +249 -0
- data/lib/talon_one/models/message_log_response.rb +264 -0
- data/lib/talon_one/models/new_account_sign_up.rb +1 -1
- data/lib/talon_one/models/new_additional_cost.rb +3 -3
- data/lib/talon_one/models/new_application.rb +2 -51
- data/lib/talon_one/models/new_application_api_key.rb +37 -5
- data/lib/talon_one/models/new_attribute.rb +2 -2
- data/lib/talon_one/models/new_base_notification.rb +13 -1
- data/lib/talon_one/models/new_campaign.rb +52 -5
- data/lib/talon_one/models/new_campaign_evaluation_group.rb +347 -0
- data/lib/talon_one/models/new_campaign_group.rb +4 -4
- data/lib/talon_one/models/new_campaign_template.rb +33 -4
- data/lib/talon_one/models/new_coupons.rb +15 -5
- data/lib/talon_one/models/new_customer_session.rb +1 -1
- data/lib/talon_one/models/new_customer_session_v2.rb +38 -4
- data/lib/talon_one/models/new_event.rb +35 -1
- data/lib/talon_one/models/new_invitation.rb +24 -18
- data/lib/talon_one/models/new_invite_email.rb +2 -38
- data/lib/talon_one/models/new_loyalty_program.rb +99 -1
- data/lib/talon_one/models/new_notification_test.rb +327 -0
- data/lib/talon_one/models/new_notification_webhook.rb +16 -4
- data/lib/talon_one/models/new_picklist.rb +1 -1
- data/lib/talon_one/models/new_role_v2.rb +249 -0
- data/lib/talon_one/models/new_store.rb +309 -0
- data/lib/talon_one/models/new_user.rb +1 -1
- data/lib/talon_one/models/notification_activation.rb +212 -0
- data/lib/talon_one/models/notification_list_item.rb +257 -0
- data/lib/talon_one/models/notification_test.rb +227 -0
- data/lib/talon_one/models/one_time_code.rb +252 -0
- data/lib/talon_one/models/outgoing_integration_clever_tap_policy.rb +242 -0
- data/lib/talon_one/models/outgoing_integration_configuration.rb +1 -0
- data/lib/talon_one/models/outgoing_integration_iterable_policy.rb +227 -0
- data/lib/talon_one/models/outgoing_integration_mo_engage_policy.rb +257 -0
- data/lib/talon_one/models/outgoing_integration_template.rb +409 -0
- data/lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb +425 -0
- data/lib/talon_one/models/outgoing_integration_templates.rb +209 -0
- data/lib/talon_one/models/patch_item_catalog_action.rb +11 -2
- data/lib/talon_one/models/pending_points_notification_policy.rb +243 -0
- data/lib/talon_one/models/picklist.rb +1 -1
- data/lib/talon_one/models/product.rb +232 -0
- data/lib/talon_one/models/remove_from_audience_effect_props.rb +238 -0
- data/lib/talon_one/models/returned_cart_item.rb +1 -1
- data/lib/talon_one/models/role.rb +1 -1
- data/lib/talon_one/models/role_assign.rb +2 -2
- data/lib/talon_one/models/role_v2.rb +63 -12
- data/lib/talon_one/models/role_v2_application_details.rb +17 -7
- data/lib/talon_one/models/role_v2_base.rb +238 -0
- data/lib/talon_one/models/role_v2_permission_set.rb +12 -11
- data/lib/talon_one/models/role_v2_permissions.rb +2 -2
- data/lib/talon_one/models/role_v2_roles_group.rb +233 -0
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +1 -1
- data/lib/talon_one/models/rollback_discount_effect_props.rb +1 -1
- data/lib/talon_one/models/saml_connection_internal.rb +265 -0
- data/lib/talon_one/models/saml_login_endpoint.rb +17 -2
- data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +1 -1
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +25 -5
- data/lib/talon_one/models/sso_config.rb +212 -0
- data/lib/talon_one/models/store.rb +381 -0
- data/lib/talon_one/models/talang_attribute.rb +2 -2
- data/lib/talon_one/models/template_arg_def.rb +0 -5
- data/lib/talon_one/models/tier.rb +58 -4
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +243 -0
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +243 -0
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +259 -0
- data/lib/talon_one/models/tier_will_downgrade_notification_trigger.rb +261 -0
- data/lib/talon_one/models/time_point.rb +345 -0
- data/lib/talon_one/models/track_event_v2_response.rb +307 -0
- data/lib/talon_one/models/two_fa_config.rb +222 -0
- data/lib/talon_one/models/update_achievement.rb +291 -0
- data/lib/talon_one/models/update_application.rb +15 -53
- data/lib/talon_one/models/update_application_api_key.rb +212 -0
- data/lib/talon_one/models/update_campaign.rb +52 -6
- data/lib/talon_one/models/update_campaign_evaluation_group.rb +348 -0
- data/lib/talon_one/models/update_campaign_group.rb +4 -4
- data/lib/talon_one/models/update_campaign_template.rb +28 -4
- data/lib/talon_one/models/update_coupon.rb +15 -5
- data/lib/talon_one/models/update_coupon_batch.rb +2 -2
- data/lib/talon_one/models/update_loyalty_program.rb +99 -1
- data/lib/talon_one/models/update_picklist.rb +1 -1
- data/lib/talon_one/models/update_store.rb +265 -0
- data/lib/talon_one/models/update_user.rb +25 -14
- data/lib/talon_one/models/user.rb +73 -42
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +449 -0
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +86 -16
- data/spec/api/integration_api_spec.rb +74 -47
- data/spec/api/management_api_spec.rb +669 -299
- data/spec/models/account_analytics_spec.rb +6 -0
- data/spec/models/account_dashboard_statistic_campaigns_spec.rb +6 -0
- data/spec/models/account_dashboard_statistic_spec.rb +0 -6
- data/spec/models/achievement_additional_properties_spec.rb +59 -0
- data/spec/models/achievement_progress_spec.rb +99 -0
- data/spec/models/achievement_spec.rb +107 -0
- data/spec/models/add_item_catalog_action_spec.rb +6 -0
- data/spec/models/add_to_audience_effect_props_spec.rb +59 -0
- data/spec/models/additional_campaign_properties_spec.rb +171 -0
- data/spec/models/application_analytics_data_point_avg_items_per_session_spec.rb +47 -0
- data/spec/models/application_analytics_data_point_avg_session_value_spec.rb +47 -0
- data/spec/models/application_analytics_data_point_sessions_count_spec.rb +47 -0
- data/spec/models/application_analytics_data_point_spec.rb +83 -0
- data/spec/models/application_analytics_data_point_total_revenue_spec.rb +47 -0
- data/spec/models/application_api_key_spec.rb +17 -1
- data/spec/models/application_campaign_analytics_avg_items_per_session_spec.rb +53 -0
- data/spec/models/application_campaign_analytics_avg_session_value_spec.rb +53 -0
- data/spec/models/application_campaign_analytics_coupons_count_spec.rb +47 -0
- data/spec/models/application_campaign_analytics_sessions_count_spec.rb +53 -0
- data/spec/models/application_campaign_analytics_spec.rb +129 -0
- data/spec/models/application_campaign_analytics_total_discounts_spec.rb +47 -0
- data/spec/models/application_campaign_analytics_total_revenue_spec.rb +53 -0
- data/spec/models/application_event_spec.rb +12 -0
- data/spec/models/application_session_spec.rb +9 -3
- data/spec/models/application_spec.rb +6 -20
- data/spec/models/application_store_entity_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +1 -1
- data/spec/models/base_campaign_spec.rb +137 -0
- data/spec/models/base_loyalty_program_spec.rb +36 -0
- data/spec/models/base_notification_entity_spec.rb +6 -0
- data/spec/models/base_notification_spec.rb +16 -0
- data/spec/models/base_notification_webhook_spec.rb +6 -0
- data/spec/models/bulk_operation_on_campaigns_spec.rb +51 -0
- data/spec/models/campaign_budget_spec.rb +53 -0
- data/spec/models/campaign_copy_spec.rb +6 -0
- data/spec/models/campaign_created_notification_spec.rb +1 -1
- data/spec/models/campaign_evaluation_group_spec.rb +91 -0
- data/spec/models/campaign_evaluation_position_spec.rb +53 -0
- data/spec/models/campaign_evaluation_tree_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_notification_policy_spec.rb +41 -0
- data/spec/models/campaign_set_branch_node_spec.rb +38 -0
- data/spec/models/campaign_set_spec.rb +2 -8
- data/spec/models/campaign_spec.rb +33 -1
- data/spec/models/campaign_template_spec.rb +11 -1
- data/spec/models/card_expiring_points_notification_policy_spec.rb +53 -0
- data/spec/models/card_expiring_points_notification_trigger_spec.rb +51 -0
- data/spec/models/card_ledger_points_entry_integration_api_spec.rb +95 -0
- data/spec/models/cart_item_spec.rb +6 -0
- data/spec/models/catalog_item_spec.rb +6 -0
- data/spec/models/change_loyalty_tier_level_effect_props_spec.rb +71 -0
- data/spec/models/coupon_spec.rb +6 -0
- data/spec/models/coupons_notification_policy_spec.rb +6 -0
- data/spec/models/create_achievement_spec.rb +71 -0
- data/spec/models/create_application_api_key_spec.rb +17 -1
- data/spec/models/create_template_campaign_spec.rb +12 -0
- data/spec/models/customer_inventory_spec.rb +6 -0
- data/spec/models/customer_profile_integration_response_v2_spec.rb +89 -0
- data/spec/models/customer_session_v2_spec.rb +6 -0
- data/spec/models/deactivate_user_request_spec.rb +41 -0
- data/spec/models/delete_user_request_spec.rb +41 -0
- data/spec/models/effect_entity_spec.rb +6 -0
- data/spec/models/effect_spec.rb +6 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/event_spec.rb +6 -0
- data/spec/models/event_v2_spec.rb +6 -0
- data/spec/models/expiring_coupons_notification_policy_spec.rb +53 -0
- data/spec/models/expiring_coupons_notification_trigger_spec.rb +51 -0
- data/spec/models/expiring_points_notification_policy_spec.rb +6 -0
- data/spec/models/get_integration_coupon_request_spec.rb +47 -0
- data/spec/models/identifiable_entity_spec.rb +41 -0
- data/spec/models/increase_achievement_progress_effect_props_spec.rb +77 -0
- data/spec/models/inline_response20013_spec.rb +1 -1
- data/spec/models/inline_response20015_spec.rb +0 -6
- data/spec/models/inline_response20019_spec.rb +1 -1
- data/spec/models/inline_response20021_spec.rb +0 -6
- data/spec/models/inline_response20022_spec.rb +2 -2
- data/spec/models/inline_response20024_spec.rb +6 -0
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +0 -6
- data/spec/models/inline_response20031_spec.rb +1 -1
- data/spec/models/inline_response20032_spec.rb +1 -1
- data/spec/models/inline_response20033_spec.rb +6 -0
- data/spec/models/inline_response20035_spec.rb +6 -0
- data/spec/models/inline_response20038_spec.rb +0 -6
- data/spec/models/inline_response2003_spec.rb +1 -1
- data/spec/models/inline_response20041_spec.rb +47 -0
- data/spec/models/inline_response20042_spec.rb +53 -0
- data/spec/models/inline_response20043_spec.rb +47 -0
- data/spec/models/inline_response20044_spec.rb +47 -0
- data/spec/models/inline_response20045_spec.rb +53 -0
- data/spec/models/inline_response20046_spec.rb +47 -0
- data/spec/models/inline_response20047_spec.rb +47 -0
- data/spec/models/inline_response2004_spec.rb +1 -1
- data/spec/models/inline_response2008_spec.rb +1 -1
- data/spec/models/integration_coupon_spec.rb +6 -0
- data/spec/models/integration_event_spec.rb +6 -0
- data/spec/models/integration_event_v2_request_spec.rb +6 -0
- data/spec/models/integration_store_entity_spec.rb +41 -0
- data/spec/models/inventory_coupon_spec.rb +6 -0
- data/spec/models/ledger_points_entry_integration_api_spec.rb +89 -0
- data/spec/models/loyalty_program_ledgers_spec.rb +6 -0
- data/spec/models/loyalty_program_spec.rb +54 -0
- data/spec/models/loyalty_program_subledgers_spec.rb +47 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/message_log_entries_spec.rb +47 -0
- data/spec/models/message_log_entry_spec.rb +111 -0
- data/spec/models/message_log_request_spec.rb +47 -0
- data/spec/models/message_log_response_spec.rb +53 -0
- data/spec/models/new_application_api_key_spec.rb +17 -1
- data/spec/models/new_application_spec.rb +0 -20
- data/spec/models/new_attribute_spec.rb +1 -1
- data/spec/models/new_base_notification_spec.rb +6 -0
- data/spec/models/new_campaign_evaluation_group_spec.rb +79 -0
- data/spec/models/new_campaign_spec.rb +23 -1
- data/spec/models/new_campaign_template_spec.rb +11 -1
- data/spec/models/new_coupons_spec.rb +6 -0
- data/spec/models/new_customer_session_v2_spec.rb +6 -0
- data/spec/models/new_event_spec.rb +6 -0
- data/spec/models/new_invitation_spec.rb +7 -1
- data/spec/models/new_loyalty_program_spec.rb +36 -0
- data/spec/models/new_notification_test_spec.rb +79 -0
- data/spec/models/new_notification_webhook_spec.rb +6 -0
- data/spec/models/new_role_v2_spec.rb +59 -0
- data/spec/models/new_store_spec.rb +59 -0
- data/spec/models/notification_activation_spec.rb +41 -0
- data/spec/models/notification_list_item_spec.rb +59 -0
- data/spec/models/notification_test_spec.rb +47 -0
- data/spec/models/one_time_code_spec.rb +59 -0
- data/spec/models/outgoing_integration_clever_tap_policy_spec.rb +53 -0
- data/spec/models/outgoing_integration_iterable_policy_spec.rb +47 -0
- data/spec/models/outgoing_integration_mo_engage_policy_spec.rb +59 -0
- data/spec/models/outgoing_integration_template_spec.rb +87 -0
- data/spec/models/outgoing_integration_template_with_configuration_details_spec.rb +93 -0
- data/spec/models/outgoing_integration_templates_spec.rb +41 -0
- data/spec/models/patch_item_catalog_action_spec.rb +6 -0
- data/spec/models/pending_points_notification_policy_spec.rb +47 -0
- data/spec/models/product_spec.rb +41 -0
- data/spec/models/remove_from_audience_effect_props_spec.rb +59 -0
- data/spec/models/role_v2_application_details_spec.rb +6 -0
- data/spec/models/role_v2_base_spec.rb +59 -0
- data/spec/models/role_v2_permission_set_spec.rb +1 -1
- data/spec/models/role_v2_roles_group_spec.rb +53 -0
- data/spec/models/role_v2_spec.rb +21 -3
- data/spec/models/saml_connection_internal_spec.rb +47 -0
- data/spec/models/saml_login_endpoint_spec.rb +6 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +12 -0
- data/spec/models/sso_config_spec.rb +41 -0
- data/spec/models/store_spec.rb +89 -0
- data/spec/models/talang_attribute_spec.rb +1 -1
- data/spec/models/tier_downgrade_notification_policy_spec.rb +47 -0
- data/spec/models/tier_spec.rb +16 -0
- data/spec/models/tier_upgrade_notification_policy_spec.rb +47 -0
- data/spec/models/tier_will_downgrade_notification_policy_spec.rb +53 -0
- data/spec/models/tier_will_downgrade_notification_trigger_spec.rb +51 -0
- data/spec/models/time_point_spec.rb +71 -0
- data/spec/models/track_event_v2_response_spec.rb +89 -0
- data/spec/models/two_fa_config_spec.rb +47 -0
- data/spec/models/update_achievement_spec.rb +71 -0
- data/spec/models/update_application_api_key_spec.rb +41 -0
- data/spec/models/update_application_spec.rb +6 -20
- data/spec/models/update_campaign_evaluation_group_spec.rb +79 -0
- data/spec/models/update_campaign_spec.rb +23 -1
- data/spec/models/update_campaign_template_spec.rb +11 -1
- data/spec/models/update_coupon_spec.rb +6 -0
- data/spec/models/update_loyalty_program_spec.rb +36 -0
- data/spec/models/update_store_spec.rb +53 -0
- data/spec/models/update_user_spec.rb +12 -6
- data/spec/models/user_spec.rb +23 -5
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +123 -0
- data/talon_one.gemspec +1 -1
- metadata +713 -369
data/docs/ApplicationCustomer.md
CHANGED
|
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
|
|
|
13
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
14
|
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
|
|
15
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
|
|
17
|
-
**sandbox** | **Boolean** |
|
|
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** | An indicator of 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
18
|
**advocate_integration_id** | **String** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional]
|
|
19
19
|
|
|
20
20
|
## Code Sample
|
data/docs/ApplicationEvent.md
CHANGED
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
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
|
+
**store_id** | **Integer** | The ID of the store. | [optional]
|
|
12
|
+
**store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
|
|
11
13
|
**session_id** | **Integer** | The globally unique Talon.One ID of the session that contains this event. | [optional]
|
|
12
14
|
**type** | **String** | A string representing the event. Must not be a reserved event name. |
|
|
13
15
|
**attributes** | [**Object**](.md) | Additional JSON serialized data associated with the event. |
|
|
@@ -23,6 +25,8 @@ instance = TalonOne::ApplicationEvent.new(id: 6,
|
|
|
23
25
|
created: 2020-06-10T09:05:27.993483Z,
|
|
24
26
|
application_id: 322,
|
|
25
27
|
profile_id: 138,
|
|
28
|
+
store_id: null,
|
|
29
|
+
store_integration_id: STORE-001,
|
|
26
30
|
session_id: null,
|
|
27
31
|
type: null,
|
|
28
32
|
attributes: null,
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**event** | **String** | Event type. It can be one of the following: ['
|
|
7
|
+
**event** | **String** | Event type. It can be one of the following: ['campaign_evaluation_tree_changed'] |
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
data/docs/ApplicationSession.md
CHANGED
|
@@ -6,13 +6,14 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**id** | **Integer** | Internal ID of this entity. |
|
|
8
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
|
+
**store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional]
|
|
9
11
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
10
12
|
**profile_id** | **Integer** | The globally unique Talon.One ID of the customer that created this entity. | [optional]
|
|
11
|
-
**integration_id** | **String** | The integration ID set by your integration layer. |
|
|
12
13
|
**profileintegrationid** | **String** | Integration ID of the customer for the session. | [optional]
|
|
13
14
|
**coupon** | **String** | Any coupon code entered. |
|
|
14
15
|
**referral** | **String** | Any referral code entered. |
|
|
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
|
|
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. `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-sessions). |
|
|
16
17
|
**cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. |
|
|
17
18
|
**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
19
|
**total_discounts** | **Float** | The total sum of the discounts applied to this session. |
|
|
@@ -26,9 +27,10 @@ require 'TalonOne'
|
|
|
26
27
|
|
|
27
28
|
instance = TalonOne::ApplicationSession.new(id: 6,
|
|
28
29
|
created: null,
|
|
30
|
+
integration_id: URNGV8294NV,
|
|
31
|
+
store_integration_id: STORE-001,
|
|
29
32
|
application_id: 322,
|
|
30
33
|
profile_id: 138,
|
|
31
|
-
integration_id: URNGV8294NV,
|
|
32
34
|
profileintegrationid: 382370BKDB946,
|
|
33
35
|
coupon: BKDB946,
|
|
34
36
|
referral: BKDB946,
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::ApplicationStoreEntity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**store_id** | **Integer** | The ID of the store. | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::ApplicationStoreEntity.new(store_id: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/Audience.md
CHANGED
|
@@ -25,7 +25,7 @@ instance = TalonOne::Audience.new(account_id: 3886,
|
|
|
25
25
|
created: 2020-06-10T09:05:27.993483Z,
|
|
26
26
|
name: Travel audience,
|
|
27
27
|
sandbox: true,
|
|
28
|
-
description: Travel audience 18-
|
|
28
|
+
description: Travel audience 18-27,
|
|
29
29
|
integration: mparticle,
|
|
30
30
|
integration_id: 382370BKDB946,
|
|
31
31
|
created_in3rd_party: false,
|
data/docs/AudienceAnalytics.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**audience_id** | **Integer** | The ID of the audience. | [optional]
|
|
8
|
-
**members_count** | **Integer** | The count of
|
|
8
|
+
**members_count** | **Integer** | The member count of the audience. | [optional]
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
data/docs/AudienceCustomer.md
CHANGED
|
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
|
|
|
13
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
14
|
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer. | [optional]
|
|
15
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
|
|
17
|
-
**sandbox** | **Boolean** |
|
|
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** | An indicator of 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
18
|
**connected_applications_ids** | **Array<Integer>** | A list of the IDs of the Applications that are connected to this customer profile. | [optional]
|
|
19
19
|
**connected_audiences** | **Array<Integer>** | A list of the IDs of the audiences that are connected to this customer profile. | [optional]
|
|
20
20
|
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# TalonOne::BaseCampaign
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | A user-facing name for this campaign. |
|
|
8
|
+
**description** | **String** | A detailed description of the campaign. | [optional]
|
|
9
|
+
**start_time** | **DateTime** | Timestamp when the campaign will become active. | [optional]
|
|
10
|
+
**end_time** | **DateTime** | Timestamp when the campaign will become inactive. | [optional]
|
|
11
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
|
|
12
|
+
**state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to 'enabled']
|
|
13
|
+
**active_ruleset_id** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
|
|
14
|
+
**tags** | **Array<String>** | A list of tags for the campaign. |
|
|
15
|
+
**features** | **Array<String>** | The features enabled in this campaign. |
|
|
16
|
+
**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
17
|
+
**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
18
|
+
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. |
|
|
19
|
+
**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]
|
|
20
|
+
**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced']
|
|
21
|
+
**linked_store_ids** | **Array<Integer>** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional]
|
|
22
|
+
|
|
23
|
+
## Code Sample
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'TalonOne'
|
|
27
|
+
|
|
28
|
+
instance = TalonOne::BaseCampaign.new(name: Summer promotions,
|
|
29
|
+
description: Campaign for all summer 2021 promotions,
|
|
30
|
+
start_time: 2021-07-20T22:00Z,
|
|
31
|
+
end_time: 2021-09-22T22:00Z,
|
|
32
|
+
attributes: null,
|
|
33
|
+
state: enabled,
|
|
34
|
+
active_ruleset_id: 6,
|
|
35
|
+
tags: [summer],
|
|
36
|
+
features: [coupons, referrals],
|
|
37
|
+
coupon_settings: null,
|
|
38
|
+
referral_settings: null,
|
|
39
|
+
limits: null,
|
|
40
|
+
campaign_groups: [1, 3],
|
|
41
|
+
type: advanced,
|
|
42
|
+
linked_store_ids: [1, 2, 3])
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
|
data/docs/BaseLoyaltyProgram.md
CHANGED
|
@@ -12,6 +12,10 @@ Name | Type | Description | Notes
|
|
|
12
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
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]
|
|
15
|
+
**tiers_expiration_policy** | **String** | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. | [optional]
|
|
16
|
+
**tiers_expire_in** | **String** | The amount of time after which the tier expires. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
|
|
17
|
+
**tiers_downgrade_policy** | **String** | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional]
|
|
18
|
+
**program_join_policy** | **String** | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
|
|
15
19
|
|
|
16
20
|
## Code Sample
|
|
17
21
|
|
|
@@ -25,7 +29,11 @@ instance = TalonOne::BaseLoyaltyProgram.new(title: Point collection,
|
|
|
25
29
|
default_pending: immediate,
|
|
26
30
|
allow_subledger: false,
|
|
27
31
|
users_per_card_limit: 111,
|
|
28
|
-
sandbox: true
|
|
32
|
+
sandbox: true,
|
|
33
|
+
tiers_expiration_policy: null,
|
|
34
|
+
tiers_expire_in: 27W_U,
|
|
35
|
+
tiers_downgrade_policy: null,
|
|
36
|
+
program_join_policy: null)
|
|
29
37
|
```
|
|
30
38
|
|
|
31
39
|
|
data/docs/BaseNotification.md
CHANGED
|
@@ -5,8 +5,10 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**policy** | [**Object**](.md) | |
|
|
8
|
+
**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true]
|
|
8
9
|
**webhook** | [**BaseNotificationWebhook**](BaseNotificationWebhook.md) | |
|
|
9
10
|
**id** | **Integer** | Unique ID for this entity. |
|
|
11
|
+
**type** | **String** | The notification type. |
|
|
10
12
|
|
|
11
13
|
## Code Sample
|
|
12
14
|
|
|
@@ -14,8 +16,10 @@ Name | Type | Description | Notes
|
|
|
14
16
|
require 'TalonOne'
|
|
15
17
|
|
|
16
18
|
instance = TalonOne::BaseNotification.new(policy: null,
|
|
19
|
+
enabled: null,
|
|
17
20
|
webhook: null,
|
|
18
|
-
id: 6
|
|
21
|
+
id: 6,
|
|
22
|
+
type: loyalty_added_deducted_points)
|
|
19
23
|
```
|
|
20
24
|
|
|
21
25
|
|
|
@@ -5,13 +5,15 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**policy** | [**Object**](.md) | |
|
|
8
|
+
**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true]
|
|
8
9
|
|
|
9
10
|
## Code Sample
|
|
10
11
|
|
|
11
12
|
```ruby
|
|
12
13
|
require 'TalonOne'
|
|
13
14
|
|
|
14
|
-
instance = TalonOne::BaseNotificationEntity.new(policy: null
|
|
15
|
+
instance = TalonOne::BaseNotificationEntity.new(policy: null,
|
|
16
|
+
enabled: null)
|
|
15
17
|
```
|
|
16
18
|
|
|
17
19
|
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
10
|
**url** | **String** | API URL for the given webhook-based notification. |
|
|
11
11
|
**headers** | **Array<String>** | List of API HTTP headers for the given webhook-based notification. |
|
|
12
|
+
**enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true]
|
|
12
13
|
|
|
13
14
|
## Code Sample
|
|
14
15
|
|
|
@@ -19,7 +20,8 @@ instance = TalonOne::BaseNotificationWebhook.new(id: 6,
|
|
|
19
20
|
created: 2020-06-10T09:05:27.993483Z,
|
|
20
21
|
modified: 2021-09-12T10:12:42Z,
|
|
21
22
|
url: www.my-company.com/my-endpoint-name,
|
|
22
|
-
headers:
|
|
23
|
+
headers: null,
|
|
24
|
+
enabled: true)
|
|
23
25
|
```
|
|
24
26
|
|
|
25
27
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::BulkOperationOnCampaigns
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**operation** | **String** | The operation to perform on the specified campaign IDs. |
|
|
8
|
+
**campaign_ids** | **Array<Integer>** | The list of campaign IDs on which the operation will be performed. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::BulkOperationOnCampaigns.new(operation: null,
|
|
16
|
+
campaign_ids: [1, 2, 3])
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/Campaign.md
CHANGED
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
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
|
-
**end_time** | **DateTime** | Timestamp the campaign will become inactive. | [optional]
|
|
14
|
+
**end_time** | **DateTime** | Timestamp when the campaign will become inactive. | [optional]
|
|
15
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
17
|
**active_ruleset_id** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
|
|
@@ -21,26 +21,30 @@ Name | Type | Description | Notes
|
|
|
21
21
|
**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
22
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
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
|
-
**
|
|
25
|
-
**
|
|
26
|
-
**
|
|
27
|
-
**
|
|
28
|
-
**
|
|
29
|
-
**
|
|
30
|
-
**
|
|
31
|
-
**
|
|
32
|
-
**
|
|
33
|
-
**
|
|
34
|
-
**
|
|
35
|
-
**
|
|
36
|
-
**
|
|
37
|
-
**
|
|
38
|
-
**
|
|
24
|
+
**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [default to 'advanced']
|
|
25
|
+
**linked_store_ids** | **Array<Integer>** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional]
|
|
26
|
+
**budgets** | [**Array<CampaignBudget>**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. |
|
|
27
|
+
**coupon_redemption_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional]
|
|
28
|
+
**referral_redemption_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional]
|
|
29
|
+
**discount_count** | **Float** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional]
|
|
30
|
+
**discount_effect_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional]
|
|
31
|
+
**coupon_creation_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional]
|
|
32
|
+
**custom_effect_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. | [optional]
|
|
33
|
+
**referral_creation_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional]
|
|
34
|
+
**add_free_item_effect_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign. | [optional]
|
|
35
|
+
**awarded_giveaways_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional]
|
|
36
|
+
**created_loyalty_points_count** | **Float** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. | [optional]
|
|
37
|
+
**created_loyalty_points_effect_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign. | [optional]
|
|
38
|
+
**redeemed_loyalty_points_count** | **Float** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. | [optional]
|
|
39
|
+
**redeemed_loyalty_points_effect_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign. | [optional]
|
|
40
|
+
**call_api_effect_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional]
|
|
41
|
+
**reservecoupon_effect_count** | **Integer** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. | [optional]
|
|
39
42
|
**last_activity** | **DateTime** | Timestamp of the most recent event received by this campaign. | [optional]
|
|
40
43
|
**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]
|
|
41
44
|
**created_by** | **String** | Name of the user who created this campaign if available. | [optional]
|
|
42
45
|
**updated_by** | **String** | Name of the user who last updated this campaign if available. | [optional]
|
|
43
46
|
**template_id** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
|
|
47
|
+
**frontend_state** | **String** | A campaign state described exactly as in the Campaign Manager. |
|
|
44
48
|
|
|
45
49
|
## Code Sample
|
|
46
50
|
|
|
@@ -64,6 +68,9 @@ instance = TalonOne::Campaign.new(id: 4,
|
|
|
64
68
|
referral_settings: null,
|
|
65
69
|
limits: null,
|
|
66
70
|
campaign_groups: [1, 3],
|
|
71
|
+
type: advanced,
|
|
72
|
+
linked_store_ids: [1, 2, 3],
|
|
73
|
+
budgets: null,
|
|
67
74
|
coupon_redemption_count: 163,
|
|
68
75
|
referral_redemption_count: 3,
|
|
69
76
|
discount_count: 288.0,
|
|
@@ -83,7 +90,8 @@ instance = TalonOne::Campaign.new(id: 4,
|
|
|
83
90
|
updated: null,
|
|
84
91
|
created_by: John Doe,
|
|
85
92
|
updated_by: Jane Doe,
|
|
86
|
-
template_id: 3
|
|
93
|
+
template_id: 3,
|
|
94
|
+
frontend_state: running)
|
|
87
95
|
```
|
|
88
96
|
|
|
89
97
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::CampaignBudget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**action** | **String** | The limitable action to which this limit applies. For example: - `setDiscount` - `setDiscountEffect` - `redeemCoupon` - `createCoupon` |
|
|
8
|
+
**limit** | **Float** | The value to set for the limit. |
|
|
9
|
+
**counter** | **Float** | The number of occurrences of the limited action in the context of the campaign. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::CampaignBudget.new(action: createCoupon,
|
|
17
|
+
limit: 1000.0,
|
|
18
|
+
counter: 42.0)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/CampaignCopy.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**start_time** | **DateTime** | Timestamp when the campaign will become active. | [optional]
|
|
11
11
|
**end_time** | **DateTime** | Timestamp when the campaign will become inactive. | [optional]
|
|
12
12
|
**tags** | **Array<String>** | A list of tags for the campaign. | [optional]
|
|
13
|
+
**evaluation_group_id** | **Integer** | The ID of the campaign evaluation group the campaign belongs to. | [optional]
|
|
13
14
|
|
|
14
15
|
## Code Sample
|
|
15
16
|
|
|
@@ -21,7 +22,8 @@ instance = TalonOne::CampaignCopy.new(name: Copy of Summer promotions,
|
|
|
21
22
|
description: Campaign for all summer 2021 promotions,
|
|
22
23
|
start_time: 2021-06-01T09:00:27.993483Z,
|
|
23
24
|
end_time: 2021-09-10T01:00:00.993483Z,
|
|
24
|
-
tags: [Summer, Shoes]
|
|
25
|
+
tags: [Summer, Shoes],
|
|
26
|
+
evaluation_group_id: 2)
|
|
25
27
|
```
|
|
26
28
|
|
|
27
29
|
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**campaign** | [**Campaign**](Campaign.md) | |
|
|
8
8
|
**ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
|
|
9
|
-
**
|
|
9
|
+
**evaluation_position** | [**CampaignEvaluationPosition**](CampaignEvaluationPosition.md) | |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -15,7 +15,7 @@ require 'TalonOne'
|
|
|
15
15
|
|
|
16
16
|
instance = TalonOne::CampaignCreatedNotification.new(campaign: null,
|
|
17
17
|
ruleset: null,
|
|
18
|
-
|
|
18
|
+
evaluation_position: null)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# TalonOne::CampaignEvaluationGroup
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
8
|
+
**name** | **String** | The name of the campaign evaluation group. |
|
|
9
|
+
**parent_id** | **Integer** | The ID of the parent group that contains the campaign evaluation group. |
|
|
10
|
+
**description** | **String** | A description of the campaign evaluation group. | [optional]
|
|
11
|
+
**evaluation_mode** | **String** | The mode by which campaigns in the campaign evaluation group are evaluated. |
|
|
12
|
+
**evaluation_scope** | **String** | The evaluation scope of the campaign evaluation group. |
|
|
13
|
+
**locked** | **Boolean** | An indicator of whether the campaign evaluation group is locked for modification. |
|
|
14
|
+
**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |
|
|
15
|
+
|
|
16
|
+
## Code Sample
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'TalonOne'
|
|
20
|
+
|
|
21
|
+
instance = TalonOne::CampaignEvaluationGroup.new(application_id: 322,
|
|
22
|
+
name: Summer campaigns,
|
|
23
|
+
parent_id: 2,
|
|
24
|
+
description: This campaign evaluation group contains all campaigns that are running in the summer.,
|
|
25
|
+
evaluation_mode: null,
|
|
26
|
+
evaluation_scope: null,
|
|
27
|
+
locked: false,
|
|
28
|
+
id: 6)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::CampaignEvaluationPosition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**group_id** | **Integer** | The ID of the campaign evaluation group the campaign belongs to. |
|
|
8
|
+
**group_name** | **String** | The name of the campaign evaluation group the campaign belongs to. |
|
|
9
|
+
**position** | **Integer** | The position of the campaign node in its parent group. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::CampaignEvaluationPosition.new(group_id: 2,
|
|
17
|
+
group_name: Summer campaigns,
|
|
18
|
+
position: 2)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::CampaignEvaluationTreeChangedNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**application_id** | **Integer** | The ID of the Application whose campaign evaluation tree changed. |
|
|
8
|
+
**old_evaluation_tree** | [**CampaignSet**](CampaignSet.md) | | [optional]
|
|
9
|
+
**evaluation_tree** | [**CampaignSet**](CampaignSet.md) | |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::CampaignEvaluationTreeChangedNotification.new(application_id: 78,
|
|
17
|
+
old_evaluation_tree: null,
|
|
18
|
+
evaluation_tree: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/CampaignGroup.md
CHANGED
|
@@ -8,10 +8,10 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
10
|
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
11
|
-
**name** | **String** | The name of
|
|
12
|
-
**description** | **String** | A longer description of the campaign group. | [optional]
|
|
13
|
-
**subscribed_applications_ids** | **Array<Integer>** | A list of
|
|
14
|
-
**campaign_ids** | **Array<Integer>** | A list of
|
|
11
|
+
**name** | **String** | The name of the campaign access group. |
|
|
12
|
+
**description** | **String** | A longer description of the campaign access group. | [optional]
|
|
13
|
+
**subscribed_applications_ids** | **Array<Integer>** | A list of IDs of the Applications that this campaign access group is enabled for. | [optional]
|
|
14
|
+
**campaign_ids** | **Array<Integer>** | A list of IDs of the campaigns that are part of the campaign access group. | [optional]
|
|
15
15
|
|
|
16
16
|
## Code Sample
|
|
17
17
|
|
|
@@ -22,8 +22,8 @@ instance = TalonOne::CampaignGroup.new(id: 6,
|
|
|
22
22
|
created: 2020-06-10T09:05:27.993483Z,
|
|
23
23
|
modified: 2021-09-12T10:12:42Z,
|
|
24
24
|
account_id: 3886,
|
|
25
|
-
name:
|
|
26
|
-
description:
|
|
25
|
+
name: Europe access group,
|
|
26
|
+
description: A group that gives access to all the campaigns for the Europe market.,
|
|
27
27
|
subscribed_applications_ids: [1, 2, 3],
|
|
28
28
|
campaign_ids: [4, 6, 8])
|
|
29
29
|
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::CampaignNotificationPolicy
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | Notification name. |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::CampaignNotificationPolicy.new(name: Christmas Sale)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/CampaignSet.md
CHANGED
|
@@ -4,9 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
-
**created** | **DateTime** | The time this entity was created. |
|
|
9
7
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
8
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
10
9
|
**version** | **Integer** | Version of the campaign set. |
|
|
11
10
|
**set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) | |
|
|
12
11
|
**updated_by** | **String** | Name of the user who last updated this campaign set, if available. | [optional]
|
|
@@ -16,9 +15,8 @@ Name | Type | Description | Notes
|
|
|
16
15
|
```ruby
|
|
17
16
|
require 'TalonOne'
|
|
18
17
|
|
|
19
|
-
instance = TalonOne::CampaignSet.new(
|
|
20
|
-
|
|
21
|
-
application_id: 322,
|
|
18
|
+
instance = TalonOne::CampaignSet.new(application_id: 322,
|
|
19
|
+
id: 6,
|
|
22
20
|
version: 3,
|
|
23
21
|
set: null,
|
|
24
22
|
updated_by: Jane Doe)
|
|
@@ -5,9 +5,14 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**type** | **String** | Indicates the node type. |
|
|
8
|
-
**name** | **String** | Name of the set |
|
|
9
|
-
**operator** | **String** |
|
|
8
|
+
**name** | **String** | Name of the set. |
|
|
9
|
+
**operator** | **String** | An indicator of how the set operates on its elements. |
|
|
10
10
|
**elements** | [**Array<CampaignSetNode>**](CampaignSetNode.md) | Child elements of this set. |
|
|
11
|
+
**group_id** | **Integer** | The ID of the campaign set. |
|
|
12
|
+
**locked** | **Boolean** | An indicator of whether the campaign set is locked for modification. |
|
|
13
|
+
**description** | **String** | A description of the campaign set. | [optional]
|
|
14
|
+
**evaluation_mode** | **String** | The mode by which campaigns in the campaign evaluation group are evaluated. |
|
|
15
|
+
**evaluation_scope** | **String** | The evaluation scope of the campaign evaluation group. |
|
|
11
16
|
|
|
12
17
|
## Code Sample
|
|
13
18
|
|
|
@@ -17,7 +22,12 @@ require 'TalonOne'
|
|
|
17
22
|
instance = TalonOne::CampaignSetBranchNode.new(type: SET,
|
|
18
23
|
name: name,
|
|
19
24
|
operator: ALL,
|
|
20
|
-
elements: null
|
|
25
|
+
elements: null,
|
|
26
|
+
group_id: null,
|
|
27
|
+
locked: null,
|
|
28
|
+
description: null,
|
|
29
|
+
evaluation_mode: null,
|
|
30
|
+
evaluation_scope: null)
|
|
21
31
|
```
|
|
22
32
|
|
|
23
33
|
|
data/docs/CampaignTemplate.md
CHANGED
|
@@ -24,6 +24,7 @@ Name | Type | Description | Notes
|
|
|
24
24
|
**applications_ids** | **Array<Integer>** | A list of IDs of the Applications that are subscribed to this campaign template. |
|
|
25
25
|
**campaign_collections** | [**Array<CampaignTemplateCollection>**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional]
|
|
26
26
|
**default_campaign_group_id** | **Integer** | The default campaign group ID. | [optional]
|
|
27
|
+
**campaign_type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [default to 'advanced']
|
|
27
28
|
**updated** | **DateTime** | Timestamp of the most recent update to the campaign template or any of its elements. | [optional]
|
|
28
29
|
**updated_by** | **String** | Name of the user who last updated this campaign template, if available. | [optional]
|
|
29
30
|
**valid_application_ids** | **Array<Integer>** | The IDs of the Applications that are related to this entity. |
|
|
@@ -53,6 +54,7 @@ instance = TalonOne::CampaignTemplate.new(id: 6,
|
|
|
53
54
|
applications_ids: null,
|
|
54
55
|
campaign_collections: null,
|
|
55
56
|
default_campaign_group_id: 42,
|
|
57
|
+
campaign_type: advanced,
|
|
56
58
|
updated: 2022-08-24T14:15:22Z,
|
|
57
59
|
updated_by: Jane Doe,
|
|
58
60
|
valid_application_ids: [1, 2, 3])
|