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
|
@@ -46,7 +46,7 @@ describe 'IntegrationApi' do
|
|
|
46
46
|
|
|
47
47
|
# unit tests for create_coupon_reservation
|
|
48
48
|
# Create coupon reservation
|
|
49
|
-
# Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. If a coupon gets created for a specific user, it will automatically appear in their coupons. When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store. <div class=\"redoc-section\"> <p class=\"title\">Important</p> This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. To create a hard reservation, you can: - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint setting the `recipientsIntegrationId` property or, - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). </div> To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
|
|
49
|
+
# Create a coupon reservation for specified customer profiles on the specified coupon. You can also create a reservation via the Campaign Manager using the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. If a coupon gets created for a specific user, it will automatically appear in their coupons. When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. For example, you can use this endpoint and `List customer data` to create a _coupon wallet_ by reserving coupon codes for a customer, and then displaying their coupon wallet when they visit your store. If the **Coupon visibility** checkbox was selected when [creating a universal code](https://docs.talon.one/docs/product/campaigns/coupons/creating-coupons#generating-a-universal-code), the coupon code is implicitly reserved for all customers, and the code will be returned for all customer profiles in the [List customer data](https://docs.talon.one/integration-api#operation/getCustomerInventory) endpoint. <div class=\"redoc-section\"> <p class=\"title\">Important</p> This endpoint creates a **soft** reservation. _Any_ customer can use a reserved coupon code and proceed to checkout. To create a hard reservation, you can: - use the [Create coupons](https://docs.talon.one/management-api#operation/createCoupons) endpoint or, - use the [Create coupons for multiple recipients](https://docs.talon.one/management-api#operation/createCouponsForMultipleRecipients) endpoint setting the `recipientsIntegrationId` property or, - create a coupon code with the **Reservation mandatory** option then use the [Create coupon code reservation effect](https://docs.talon.one/docs/product/rules/effects/using-effects#reserving-a-coupon-code). This endpoint overrides the reservation limit set for the coupon code during coupon creation. </div> To delete a reservation, use the [Delete reservation](https://docs.talon.one/integration-api#tag/Coupons/operation/deleteCouponReservation) endpoint.
|
|
50
50
|
# @param coupon_value The code of the coupon.
|
|
51
51
|
# @param body body
|
|
52
52
|
# @param [Hash] opts the optional parameters
|
|
@@ -85,7 +85,7 @@ describe 'IntegrationApi' do
|
|
|
85
85
|
# unit tests for delete_audience_memberships_v2
|
|
86
86
|
# Delete audience memberships
|
|
87
87
|
# Remove all members from this audience.
|
|
88
|
-
# @param audience_id The ID of the audience.
|
|
88
|
+
# @param audience_id The ID of the audience.
|
|
89
89
|
# @param [Hash] opts the optional parameters
|
|
90
90
|
# @return [nil]
|
|
91
91
|
describe 'delete_audience_memberships_v2 test' do
|
|
@@ -97,7 +97,7 @@ describe 'IntegrationApi' do
|
|
|
97
97
|
# unit tests for delete_audience_v2
|
|
98
98
|
# Delete audience
|
|
99
99
|
# Delete an audience created by a third-party integration. **Warning:** This endpoint also removes any associations recorded between a customer profile and this audience. **Note:** Audiences can also be deleted via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/managing-audiences#deleting-an-audience).
|
|
100
|
-
# @param audience_id The ID of the audience.
|
|
100
|
+
# @param audience_id The ID of the audience.
|
|
101
101
|
# @param [Hash] opts the optional parameters
|
|
102
102
|
# @return [nil]
|
|
103
103
|
describe 'delete_audience_v2 test' do
|
|
@@ -122,7 +122,7 @@ describe 'IntegrationApi' do
|
|
|
122
122
|
# unit tests for delete_customer_data
|
|
123
123
|
# Delete customer's personal data
|
|
124
124
|
# Delete all attributes on the customer profile and on entities that reference this customer profile. **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours.
|
|
125
|
-
# @param integration_id The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration
|
|
125
|
+
# @param integration_id The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
|
126
126
|
# @param [Hash] opts the optional parameters
|
|
127
127
|
# @return [nil]
|
|
128
128
|
describe 'delete_customer_data test' do
|
|
@@ -134,13 +134,14 @@ describe 'IntegrationApi' do
|
|
|
134
134
|
# unit tests for get_customer_inventory
|
|
135
135
|
# List customer data
|
|
136
136
|
# Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
|
|
137
|
-
# @param integration_id The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration
|
|
137
|
+
# @param integration_id The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
|
138
138
|
# @param [Hash] opts the optional parameters
|
|
139
139
|
# @option opts [Boolean] :profile Set to `true` to include customer profile information in the response.
|
|
140
140
|
# @option opts [Boolean] :referrals Set to `true` to include referral information in the response.
|
|
141
141
|
# @option opts [Boolean] :coupons Set to `true` to include coupon information in the response.
|
|
142
142
|
# @option opts [Boolean] :loyalty Set to `true` to include loyalty information in the response.
|
|
143
143
|
# @option opts [Boolean] :giveaways Set to `true` to include giveaways information in the response.
|
|
144
|
+
# @option opts [Boolean] :achievements Set to `true` to include achievement information in the response.
|
|
144
145
|
# @return [CustomerInventory]
|
|
145
146
|
describe 'get_customer_inventory test' do
|
|
146
147
|
it 'should work' do
|
|
@@ -162,11 +163,12 @@ describe 'IntegrationApi' do
|
|
|
162
163
|
|
|
163
164
|
# unit tests for get_loyalty_balances
|
|
164
165
|
# Get customer's loyalty points
|
|
165
|
-
# Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date. If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance.
|
|
166
|
-
# @param loyalty_program_id Identifier of the
|
|
166
|
+
# Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID. **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID. Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance. For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data)
|
|
167
|
+
# @param loyalty_program_id Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
167
168
|
# @param integration_id The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
|
168
169
|
# @param [Hash] opts the optional parameters
|
|
169
|
-
# @option opts [DateTime] :end_date Used to return
|
|
170
|
+
# @option opts [DateTime] :end_date Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
171
|
+
# @option opts [Array<String>] :subledger_id Filter results by one or more subledger IDs. Must be exact match.
|
|
170
172
|
# @return [LoyaltyBalances]
|
|
171
173
|
describe 'get_loyalty_balances test' do
|
|
172
174
|
it 'should work' do
|
|
@@ -180,7 +182,8 @@ describe 'IntegrationApi' do
|
|
|
180
182
|
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
181
183
|
# @param loyalty_card_id Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
182
184
|
# @param [Hash] opts the optional parameters
|
|
183
|
-
# @option opts [DateTime] :end_date Used to return
|
|
185
|
+
# @option opts [DateTime] :end_date Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
186
|
+
# @option opts [Array<String>] :subledger_id Filter results by one or more subledger IDs. Must be exact match.
|
|
184
187
|
# @return [LoyaltyBalances]
|
|
185
188
|
describe 'get_loyalty_card_balances test' do
|
|
186
189
|
it 'should work' do
|
|
@@ -188,6 +191,23 @@ describe 'IntegrationApi' do
|
|
|
188
191
|
end
|
|
189
192
|
end
|
|
190
193
|
|
|
194
|
+
# unit tests for get_loyalty_card_points
|
|
195
|
+
# List card's unused loyalty points
|
|
196
|
+
# Get paginated results of loyalty points for a given loyalty card identifier in a card-based loyalty program. This endpoint returns only the balances of unused points on a loyalty card. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past.
|
|
197
|
+
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
198
|
+
# @param loyalty_card_id Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
199
|
+
# @param [Hash] opts the optional parameters
|
|
200
|
+
# @option opts [String] :status Filter points based on their status.
|
|
201
|
+
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
202
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
|
203
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
204
|
+
# @return [InlineResponse2003]
|
|
205
|
+
describe 'get_loyalty_card_points test' do
|
|
206
|
+
it 'should work' do
|
|
207
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
208
|
+
end
|
|
209
|
+
end
|
|
210
|
+
|
|
191
211
|
# unit tests for get_loyalty_card_transactions
|
|
192
212
|
# List card's transactions
|
|
193
213
|
# Retrieve loyalty transaction logs for the given loyalty card in the specified loyalty program with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
|
|
@@ -195,10 +215,11 @@ describe 'IntegrationApi' do
|
|
|
195
215
|
# @param loyalty_card_id Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
196
216
|
# @param [Hash] opts the optional parameters
|
|
197
217
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
198
|
-
# @option opts [
|
|
199
|
-
# @option opts [DateTime] :
|
|
200
|
-
# @option opts [
|
|
201
|
-
# @option opts [Integer] :
|
|
218
|
+
# @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
219
|
+
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
220
|
+
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
221
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
|
222
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
202
223
|
# @return [InlineResponse2001]
|
|
203
224
|
describe 'get_loyalty_card_transactions test' do
|
|
204
225
|
it 'should work' do
|
|
@@ -206,17 +227,35 @@ describe 'IntegrationApi' do
|
|
|
206
227
|
end
|
|
207
228
|
end
|
|
208
229
|
|
|
230
|
+
# unit tests for get_loyalty_program_profile_points
|
|
231
|
+
# List customer's unused loyalty points
|
|
232
|
+
# Get paginated results of loyalty points for a given Integration ID in the specified profile-based loyalty program. This endpoint returns only the balances of unused points linked to a customer profile. You can filter points by status: - `active`: Points ready to be redeemed. - `pending`: Points with a start date in the future. - `expired`: Points with an expiration date in the past.
|
|
233
|
+
# @param loyalty_program_id Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
234
|
+
# @param integration_id The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
|
235
|
+
# @param [Hash] opts the optional parameters
|
|
236
|
+
# @option opts [String] :status Filter points based on their status.
|
|
237
|
+
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
238
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
|
239
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
240
|
+
# @return [InlineResponse2004]
|
|
241
|
+
describe 'get_loyalty_program_profile_points test' do
|
|
242
|
+
it 'should work' do
|
|
243
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
244
|
+
end
|
|
245
|
+
end
|
|
246
|
+
|
|
209
247
|
# unit tests for get_loyalty_program_profile_transactions
|
|
210
248
|
# List customer's loyalty transactions
|
|
211
249
|
# Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program. You can filter transactions by date. If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned. **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint.
|
|
212
|
-
# @param loyalty_program_id Identifier of the
|
|
250
|
+
# @param loyalty_program_id Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
213
251
|
# @param integration_id The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
|
214
252
|
# @param [Hash] opts the optional parameters
|
|
215
253
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
216
|
-
# @option opts [
|
|
217
|
-
# @option opts [DateTime] :
|
|
218
|
-
# @option opts [
|
|
219
|
-
# @option opts [Integer] :
|
|
254
|
+
# @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
255
|
+
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
256
|
+
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
257
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
|
258
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
220
259
|
# @return [InlineResponse2002]
|
|
221
260
|
describe 'get_loyalty_program_profile_transactions test' do
|
|
222
261
|
it 'should work' do
|
|
@@ -238,7 +277,7 @@ describe 'IntegrationApi' do
|
|
|
238
277
|
|
|
239
278
|
# unit tests for link_loyalty_card_to_profile
|
|
240
279
|
# Link customer profile to card
|
|
241
|
-
# [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/
|
|
280
|
+
# [Loyalty cards](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) allow customers to collect and spend loyalty points within a [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). They are useful to gamify loyalty programs and can be used with or without customer profiles linked to them. Link a customer profile to a given loyalty card for the card to be set as **Registered**. This affects how it can be used. See the [docs](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards#linking-customer-profiles-to-a-loyalty-card). **Note:** You can link as many customer profiles to a given loyalty card as the [**card user limit**](https://docs.talon.one/docs/product/loyalty-programs/card-based/creating-cb-programs) allows.
|
|
242
281
|
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
243
282
|
# @param loyalty_card_id Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
|
244
283
|
# @param body body
|
|
@@ -252,7 +291,7 @@ describe 'IntegrationApi' do
|
|
|
252
291
|
|
|
253
292
|
# unit tests for reopen_customer_session
|
|
254
293
|
# Reopen customer session
|
|
255
|
-
# Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities
|
|
294
|
+
# Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Modified budgets and triggered effects when the session was closed are rolled back except for the list below. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets are left the way they were once the session was originally closed:</p> <ul> <li>Add free item effect</li> <li>Any <strong>non-pending</strong> loyalty points</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> <p>To see an example of roll back, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets tutorial</a>.</p> </details> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
|
|
256
295
|
# @param customer_session_id The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
|
|
257
296
|
# @param [Hash] opts the optional parameters
|
|
258
297
|
# @return [ReopenSessionResponse]
|
|
@@ -264,7 +303,7 @@ describe 'IntegrationApi' do
|
|
|
264
303
|
|
|
265
304
|
# unit tests for return_cart_items
|
|
266
305
|
# Return cart items
|
|
267
|
-
# Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`.
|
|
306
|
+
# Create a new return request for the specified cart items. This endpoint automatically changes the session state from `closed` to `partially_returned`. **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session).
|
|
268
307
|
# @param customer_session_id The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
|
|
269
308
|
# @param body body
|
|
270
309
|
# @param [Hash] opts the optional parameters
|
|
@@ -278,7 +317,7 @@ describe 'IntegrationApi' do
|
|
|
278
317
|
|
|
279
318
|
# unit tests for sync_catalog
|
|
280
319
|
# Sync cart item catalog
|
|
281
|
-
# Perform one or more of the following
|
|
320
|
+
# Perform one or more of the following actions for a given cart item catalog: - Adding an item to the catalog. - Adding several items to the catalog. - Editing the attributes of an item in the catalog. - Editing the attributes of several items in the catalog. - Removing an item from the catalog. - Removing several items from the catalog. You can add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. **Important**: Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). ### Filtering cart items Use [cart item attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) to filter items and select the ones you want to edit or delete when editing or deleting more than one item at a time. The `filters` array contains an object with the following properties: - `attr`: A [cart item attribute](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes) connected to the catalog. It is applied to all items in the catalog. - `op`: The filtering operator indicating the relationship between the value of each cart item in the catalog and the value of the `value` property for the attribute selected in `attr`. The value of `op` can be one of the following: - `EQ`: Equal to `value` - `LT`: Less than `value` - `LE`: Less than or equal to `value` - `GT`: Greater than `value` - `GE`: Greater than or equal to `value` - `IN`: One of the comma-separated values that `value` is set to. **Note:** `GE`, `LE`, `GT`, `LT` are for numeric values only. - `value`: The value of the attribute selected in `attr`. ### Payload examples Synchronization actions are sent as `PUT` requests. See the structure for each action: <details> <summary><strong>Adding an item to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Adding several items to the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241027\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" }, { \"payload\": { \"attributes\": { \"color\": \"Navy blue\", \"type\": \"shoes\" }, \"replaceIfExists\": true, \"sku\": \"SKU1241028\", \"price\": 100, \"product\": { \"name\": \"sneakers\" } }, \"type\": \"ADD\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of an item in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"age\": 11, \"origin\": \"germany\" }, \"createIfNotExists\": false, \"sku\": \"SKU1241028\", \"product\": { \"name\": \"sneakers\" } }, \"type\": \"PATCH\" } ] } ``` </div> </details> <details> <summary><strong>Editing the attributes of several items in the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"attributes\": { \"color\": \"red\" }, \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"PATCH_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing an item from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"sku\": \"SKU1241028\" }, \"type\": \"REMOVE\" } ] } ``` </div> </details> <details> <summary><strong>Removing several items from the catalog</strong></summary> <div> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"color\", \"op\": \"EQ\", \"value\": \"blue\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details> <details> <summary><strong>Removing shoes of sizes above 45 from the catalog</strong></summary> <div> <p> Let's imagine that we have a shoe store and we have decided to stop selling shoes larger than size 45. We can remove from the catalog all the shoes of sizes above 45 with a single action:</p> ```json { \"actions\": [ { \"payload\": { \"filters\": [ { \"attr\": \"size\", \"op\": \"GT\", \"value\": \"45\" } ] }, \"type\": \"REMOVE_MANY\" } ] } ``` </div> </details>
|
|
282
321
|
# @param catalog_id The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
|
|
283
322
|
# @param body body
|
|
284
323
|
# @param [Hash] opts the optional parameters
|
|
@@ -289,27 +328,14 @@ describe 'IntegrationApi' do
|
|
|
289
328
|
end
|
|
290
329
|
end
|
|
291
330
|
|
|
292
|
-
# unit tests for track_event
|
|
293
|
-
# Track event
|
|
294
|
-
# <div class=\"redoc-section\"> <p class=\"title\">Deprecation warning</p> <p>This endpoint is DEPRECATED and will be sunset on March 31st 2023. Use <a href=\"https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2\">Track Event V2</a> instead.</p> <p>See <a href=\"https://docs.talon.one/docs/dev/tutorials/migrating-to-v2\">Migrating to V2</a>.</p> </div> Triggers a custom event in a customer session. You can then check this event in your rules. Before using this endpoint, create your event as a custom attribute of type `event`. An event is always part of a session. If either the profile or the session does not exist, a new empty profile/session is created. If the specified session already exists, it must belong to the same `profileId` or an error will be returned.
|
|
295
|
-
# @param body body
|
|
296
|
-
# @param [Hash] opts the optional parameters
|
|
297
|
-
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
298
|
-
# @return [IntegrationState]
|
|
299
|
-
describe 'track_event test' do
|
|
300
|
-
it 'should work' do
|
|
301
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
302
|
-
end
|
|
303
|
-
end
|
|
304
|
-
|
|
305
331
|
# unit tests for track_event_v2
|
|
306
|
-
# Track event
|
|
307
|
-
# Triggers a custom event.
|
|
332
|
+
# Track event
|
|
333
|
+
# Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not say it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
|
|
308
334
|
# @param body body
|
|
309
335
|
# @param [Hash] opts the optional parameters
|
|
310
336
|
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
|
311
337
|
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
|
312
|
-
# @return [
|
|
338
|
+
# @return [TrackEventV2Response]
|
|
313
339
|
describe 'track_event_v2 test' do
|
|
314
340
|
it 'should work' do
|
|
315
341
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -319,7 +345,7 @@ describe 'IntegrationApi' do
|
|
|
319
345
|
# unit tests for update_audience_customers_attributes
|
|
320
346
|
# Update profile attributes for all customers in audience
|
|
321
347
|
# Update the specified profile attributes to the provided values for all customers in the specified audience.
|
|
322
|
-
# @param audience_id The ID of the audience.
|
|
348
|
+
# @param audience_id The ID of the audience.
|
|
323
349
|
# @param body body
|
|
324
350
|
# @param [Hash] opts the optional parameters
|
|
325
351
|
# @return [nil]
|
|
@@ -331,8 +357,8 @@ describe 'IntegrationApi' do
|
|
|
331
357
|
|
|
332
358
|
# unit tests for update_audience_v2
|
|
333
359
|
# Update audience name
|
|
334
|
-
# Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the
|
|
335
|
-
# @param audience_id The ID of the audience.
|
|
360
|
+
# Update the name of the given audience created by a third-party integration. Sending a request to this endpoint does **not** trigger the Rule Engine. To update the audience's members, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
|
|
361
|
+
# @param audience_id The ID of the audience.
|
|
336
362
|
# @param body body
|
|
337
363
|
# @param [Hash] opts the optional parameters
|
|
338
364
|
# @return [Audience]
|
|
@@ -344,7 +370,7 @@ describe 'IntegrationApi' do
|
|
|
344
370
|
|
|
345
371
|
# unit tests for update_customer_profile_audiences
|
|
346
372
|
# Update multiple customer profiles' audiences
|
|
347
|
-
#
|
|
373
|
+
# Add customer profiles to or remove them from an audience. The endpoint supports 1000 audience actions (`add` or `remove`) per request. **Note:** You can also do this using the [Update audience](https://docs.talon.one/docs/product/rules/effects/using-effects#updating-an-audience) effect.
|
|
348
374
|
# @param body body
|
|
349
375
|
# @param [Hash] opts the optional parameters
|
|
350
376
|
# @return [nil]
|
|
@@ -356,13 +382,13 @@ describe 'IntegrationApi' do
|
|
|
356
382
|
|
|
357
383
|
# unit tests for update_customer_profile_v2
|
|
358
384
|
# Update customer profile
|
|
359
|
-
# Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities
|
|
385
|
+
# Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
|
|
360
386
|
# @param integration_id The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
|
361
387
|
# @param body body
|
|
362
388
|
# @param [Hash] opts the optional parameters
|
|
363
389
|
# @option opts [Boolean] :run_rule_engine Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body.
|
|
364
390
|
# @option opts [Boolean] :dry (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run.
|
|
365
|
-
# @return [
|
|
391
|
+
# @return [CustomerProfileIntegrationResponseV2]
|
|
366
392
|
describe 'update_customer_profile_v2 test' do
|
|
367
393
|
it 'should work' do
|
|
368
394
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -371,7 +397,7 @@ describe 'IntegrationApi' do
|
|
|
371
397
|
|
|
372
398
|
# unit tests for update_customer_profiles_v2
|
|
373
399
|
# Update multiple customer profiles
|
|
374
|
-
# Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities
|
|
400
|
+
# Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
|
|
375
401
|
# @param body body
|
|
376
402
|
# @param [Hash] opts the optional parameters
|
|
377
403
|
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
|
@@ -384,11 +410,12 @@ describe 'IntegrationApi' do
|
|
|
384
410
|
|
|
385
411
|
# unit tests for update_customer_session_v2
|
|
386
412
|
# Update customer session
|
|
387
|
-
# Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities
|
|
413
|
+
# Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
|
|
388
414
|
# @param customer_session_id The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
|
|
389
415
|
# @param body body
|
|
390
416
|
# @param [Hash] opts the optional parameters
|
|
391
|
-
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`
|
|
417
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests).
|
|
418
|
+
# @option opts [DateTime] :now A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`.
|
|
392
419
|
# @return [IntegrationStateV2]
|
|
393
420
|
describe 'update_customer_session_v2 test' do
|
|
394
421
|
it 'should work' do
|