talon_one 2.4.0 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Makefile +43 -0
- data/README.md +325 -179
- data/docs/AcceptCouponEffectProps.md +1 -1
- data/docs/AcceptReferralEffectProps.md +1 -1
- data/docs/AccessLogEntry.md +15 -10
- data/docs/Account.md +9 -9
- data/docs/AccountAdditionalCost.md +13 -11
- data/docs/AccountAnalytics.md +37 -35
- data/docs/AccountDashboardStatistic.md +27 -0
- data/docs/AccountDashboardStatisticApiCalls.md +19 -0
- data/docs/AccountDashboardStatisticCampaigns.md +19 -0
- data/docs/AccountDashboardStatisticDiscount.md +21 -0
- data/docs/AccountDashboardStatisticLoyaltyPoints.md +19 -0
- data/docs/AccountDashboardStatisticReferrals.md +19 -0
- data/docs/AccountDashboardStatisticRevenue.md +21 -0
- data/docs/AccountEntity.md +1 -1
- data/docs/AccountLimits.md +12 -12
- data/docs/AddFreeItemEffectProps.md +3 -3
- data/docs/AddItemCatalogAction.md +23 -0
- data/docs/AddLoyaltyPoints.md +31 -0
- data/docs/AddLoyaltyPointsEffectProps.md +22 -10
- data/docs/AddedDeductedPointsNotificationPolicy.md +19 -0
- data/docs/AdditionalCost.md +1 -1
- data/docs/Application.md +33 -29
- data/docs/ApplicationAPIKey.md +16 -16
- data/docs/ApplicationApiHealth.md +3 -3
- data/docs/ApplicationCampaignStats.md +6 -6
- data/docs/ApplicationCustomer.md +16 -12
- data/docs/ApplicationCustomerEntity.md +1 -1
- data/docs/ApplicationEntity.md +1 -1
- data/docs/ApplicationEvent.md +7 -7
- data/docs/ApplicationNotification.md +17 -0
- data/docs/ApplicationReferee.md +5 -5
- data/docs/ApplicationSession.md +17 -15
- data/docs/ApplicationSessionEntity.md +1 -1
- data/docs/AsyncCouponCreationResponse.md +17 -0
- data/docs/Attribute.md +24 -14
- data/docs/Audience.md +19 -11
- data/docs/AudienceAnalytics.md +19 -0
- data/docs/AudienceCustomer.md +41 -0
- data/docs/AudienceIntegrationID.md +17 -0
- data/docs/AudienceMembership.md +2 -2
- data/docs/AwardGiveawayEffectProps.md +5 -5
- data/docs/BaseLoyaltyProgram.md +31 -0
- data/docs/BaseNotification.md +21 -0
- data/docs/BaseNotificationEntity.md +17 -0
- data/docs/BaseNotificationWebhook.md +25 -0
- data/docs/BaseNotifications.md +17 -0
- data/docs/BaseSamlConnection.md +1 -1
- data/docs/Binding.md +6 -4
- data/docs/BulkApplicationNotification.md +19 -0
- data/docs/BulkCampaignNotification.md +19 -0
- data/docs/Campaign.md +47 -37
- data/docs/CampaignActivationRequest.md +17 -0
- data/docs/CampaignAnalytics.md +8 -8
- data/docs/CampaignCollection.md +37 -0
- data/docs/CampaignCollectionWithoutPayload.md +35 -0
- data/docs/CampaignCopy.md +10 -10
- data/docs/CampaignCreatedNotification.md +21 -0
- data/docs/CampaignDeletedNotification.md +19 -0
- data/docs/CampaignEditedNotification.md +21 -0
- data/docs/CampaignEntity.md +1 -1
- data/docs/CampaignGroup.md +12 -12
- data/docs/CampaignNotification.md +17 -0
- data/docs/CampaignPrioritiesChangedNotification.md +21 -0
- data/docs/CampaignPrioritiesV2.md +21 -0
- data/docs/CampaignRulesetChangedNotification.md +21 -0
- data/docs/CampaignSearch.md +1 -1
- data/docs/CampaignSet.md +10 -8
- data/docs/CampaignSetBranchNode.md +6 -6
- data/docs/CampaignSetIDs.md +17 -0
- data/docs/CampaignSetLeafNode.md +1 -1
- data/docs/CampaignSetNode.md +1 -1
- data/docs/CampaignSetV2.md +25 -0
- data/docs/CampaignStateChangedNotification.md +23 -0
- data/docs/CampaignTemplate.md +61 -0
- data/docs/CampaignTemplateCollection.md +19 -0
- data/docs/CampaignTemplateParams.md +23 -0
- data/docs/CardLedgerTransactionLogEntry.md +41 -0
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +41 -0
- data/docs/CartItem.md +26 -18
- data/docs/Catalog.md +33 -0
- data/docs/CatalogAction.md +19 -0
- data/docs/CatalogActionFilter.md +21 -0
- data/docs/CatalogItem.md +29 -0
- data/docs/CatalogSyncRequest.md +19 -0
- data/docs/CatalogsStrikethroughNotificationPolicy.md +17 -0
- data/docs/Change.md +12 -10
- data/docs/ChangeProfilePassword.md +2 -2
- data/docs/CodeGeneratorSettings.md +4 -4
- data/docs/Collection.md +39 -0
- data/docs/CollectionItem.md +17 -0
- data/docs/CollectionWithoutPayload.md +37 -0
- data/docs/Coupon.md +33 -25
- data/docs/CouponConstraints.md +9 -7
- data/docs/CouponCreatedEffectProps.md +2 -2
- data/docs/CouponCreationJob.md +59 -0
- data/docs/CouponLimitConfigs.md +17 -0
- data/docs/CouponRejectionReason.md +3 -3
- data/docs/CouponReservations.md +2 -2
- data/docs/CouponSearch.md +1 -1
- data/docs/CouponValue.md +2 -2
- data/docs/CouponsNotificationPolicy.md +19 -0
- data/docs/CreateApplicationAPIKey.md +6 -6
- data/docs/CreateManagementKey.md +23 -0
- data/docs/CreateTemplateCampaign.md +31 -0
- data/docs/CreateTemplateCampaignResponse.md +21 -0
- data/docs/CustomEffect.md +14 -12
- data/docs/CustomEffectProps.md +12 -2
- data/docs/CustomerActivityReport.md +4 -4
- data/docs/CustomerAnalytics.md +7 -7
- data/docs/CustomerInventory.md +2 -2
- data/docs/CustomerProfile.md +17 -13
- data/docs/CustomerProfileAudienceRequestItem.md +6 -6
- data/docs/CustomerProfileIntegrationRequestV2.md +6 -4
- data/docs/CustomerProfileSearchQuery.md +1 -1
- data/docs/CustomerProfileUpdateV2Response.md +17 -0
- data/docs/CustomerSession.md +16 -14
- data/docs/CustomerSessionV2.md +34 -26
- data/docs/DeductLoyaltyPoints.md +23 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +10 -6
- data/docs/Effect.md +15 -13
- data/docs/EffectEntity.md +14 -12
- data/docs/EmailEntity.md +1 -1
- data/docs/Endpoint.md +17 -0
- data/docs/Entity.md +4 -4
- data/docs/EntityWithTalangVisibleID.md +2 -2
- data/docs/Environment.md +9 -7
- data/docs/ErrorResponseWithStatus.md +21 -0
- data/docs/ErrorSource.md +1 -1
- data/docs/EvaluableCampaignIds.md +17 -0
- data/docs/Event.md +11 -11
- data/docs/EventType.md +10 -24
- data/docs/EventV2.md +23 -0
- data/docs/ExpiringPointsNotificationPolicy.md +19 -0
- data/docs/ExpiringPointsNotificationTrigger.md +19 -0
- data/docs/Export.md +8 -8
- data/docs/FeatureFlag.md +7 -7
- data/docs/FeedNotification.md +6 -6
- data/docs/FrontendState.md +16 -0
- data/docs/Giveaway.md +13 -9
- data/docs/GiveawaysPool.md +11 -9
- data/docs/Import.md +11 -11
- data/docs/ImportEntity.md +1 -1
- data/docs/InlineResponse200.md +1 -1
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse20010.md +2 -2
- data/docs/InlineResponse20011.md +3 -5
- data/docs/InlineResponse20012.md +2 -2
- data/docs/InlineResponse20013.md +3 -3
- data/docs/InlineResponse20014.md +4 -2
- data/docs/InlineResponse20015.md +2 -2
- data/docs/InlineResponse20016.md +5 -3
- data/docs/InlineResponse20017.md +1 -1
- data/docs/InlineResponse20018.md +2 -2
- data/docs/InlineResponse20019.md +3 -5
- data/docs/InlineResponse2002.md +2 -2
- data/docs/InlineResponse20020.md +5 -3
- data/docs/InlineResponse20021.md +5 -3
- data/docs/InlineResponse20022.md +5 -3
- data/docs/InlineResponse20023.md +3 -3
- data/docs/InlineResponse20024.md +3 -3
- data/docs/InlineResponse20025.md +3 -3
- data/docs/InlineResponse20026.md +3 -3
- data/docs/InlineResponse20027.md +3 -5
- data/docs/InlineResponse20028.md +5 -3
- data/docs/InlineResponse20029.md +5 -3
- data/docs/InlineResponse2003.md +2 -2
- data/docs/InlineResponse20030.md +19 -0
- data/docs/InlineResponse20031.md +19 -0
- data/docs/InlineResponse20032.md +19 -0
- data/docs/InlineResponse20033.md +19 -0
- data/docs/InlineResponse20034.md +19 -0
- data/docs/InlineResponse20035.md +19 -0
- data/docs/InlineResponse20036.md +19 -0
- data/docs/InlineResponse20037.md +21 -0
- data/docs/InlineResponse20038.md +19 -0
- data/docs/InlineResponse20039.md +19 -0
- data/docs/InlineResponse2004.md +2 -2
- data/docs/InlineResponse2005.md +3 -3
- data/docs/InlineResponse2006.md +3 -3
- data/docs/InlineResponse2007.md +3 -3
- data/docs/InlineResponse2008.md +3 -3
- data/docs/InlineResponse2009.md +2 -2
- data/docs/InlineResponse201.md +1 -1
- data/docs/IntegrationApi.md +932 -220
- data/docs/IntegrationCoupon.md +59 -0
- data/docs/IntegrationCustomerSessionResponse.md +19 -0
- data/docs/IntegrationEntity.md +4 -4
- data/docs/IntegrationEvent.md +4 -4
- data/docs/IntegrationEventV2Request.md +25 -0
- data/docs/IntegrationProfileEntity.md +2 -2
- data/docs/IntegrationRequest.md +2 -2
- data/docs/IntegrationStateV2.md +8 -4
- data/docs/InventoryCoupon.md +36 -28
- data/docs/InventoryReferral.md +43 -0
- data/docs/ItemAttribute.md +21 -0
- data/docs/LedgerEntry.md +17 -17
- data/docs/LedgerInfo.md +31 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +39 -0
- data/docs/LimitConfig.md +8 -6
- data/docs/LimitCounter.md +45 -0
- data/docs/LoginParams.md +2 -2
- data/docs/Loyalty.md +4 -2
- data/docs/LoyaltyBalance.md +23 -0
- data/docs/LoyaltyBalances.md +19 -0
- data/docs/LoyaltyCard.md +39 -0
- data/docs/LoyaltyCardProfileRegistration.md +19 -0
- data/docs/LoyaltyCardRegistration.md +17 -0
- data/docs/LoyaltyDashboardData.md +33 -0
- data/docs/LoyaltyDashboardPointsBreakdown.md +19 -0
- data/docs/LoyaltyLedger.md +2 -2
- data/docs/LoyaltyLedgerEntry.md +19 -15
- data/docs/LoyaltyLedgerTransactions.md +19 -0
- data/docs/LoyaltyMembership.md +1 -1
- data/docs/LoyaltyProgram.md +26 -16
- data/docs/LoyaltyProgramBalance.md +12 -10
- data/docs/LoyaltyProgramEntity.md +1 -1
- data/docs/LoyaltyProgramLedgers.md +8 -8
- data/docs/LoyaltyProgramTransaction.md +49 -0
- data/docs/LoyaltyStatistics.md +18 -8
- data/docs/LoyaltySubLedger.md +13 -11
- data/docs/LoyaltyTier.md +8 -8
- data/docs/ManagementApi.md +4100 -1835
- data/docs/ManagementKey.md +31 -0
- data/docs/ModelReturn.md +37 -0
- data/docs/MultipleAttribute.md +17 -0
- data/docs/MultipleAudiences.md +19 -0
- data/docs/MultipleAudiencesItem.md +25 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +4 -4
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +1 -1
- data/docs/MultipleNewAttribute.md +17 -0
- data/docs/MultipleNewAudiences.md +17 -0
- data/docs/MutableEntity.md +2 -2
- data/docs/NewAccountSignUp.md +2 -2
- data/docs/NewAdditionalCost.md +8 -6
- data/docs/NewApplication.md +26 -22
- data/docs/NewApplicationAPIKey.md +18 -18
- data/docs/NewAttribute.md +17 -9
- data/docs/NewAudience.md +14 -6
- data/docs/NewBaseNotification.md +19 -0
- data/docs/NewCampaign.md +17 -17
- data/docs/NewCampaignCollection.md +19 -0
- data/docs/NewCampaignGroup.md +5 -5
- data/docs/NewCampaignSet.md +3 -3
- data/docs/NewCampaignSetV2.md +21 -0
- data/docs/NewCampaignTemplate.md +43 -0
- data/docs/NewCatalog.md +21 -0
- data/docs/NewCollection.md +21 -0
- data/docs/NewCouponCreationJob.md +31 -0
- data/docs/NewCoupons.md +24 -18
- data/docs/NewCouponsForMultipleRecipients.md +17 -15
- data/docs/NewCustomEffect.md +6 -4
- data/docs/NewCustomerProfile.md +2 -2
- data/docs/NewCustomerSession.md +8 -8
- data/docs/NewCustomerSessionV2.md +19 -15
- data/docs/NewEvent.md +5 -5
- data/docs/NewEventType.md +6 -20
- data/docs/NewGiveawaysPool.md +6 -4
- data/docs/NewInternalAudience.md +21 -0
- data/docs/NewInvitation.md +5 -5
- data/docs/NewLoyaltyProgram.md +21 -11
- data/docs/NewLoyaltyTier.md +3 -3
- data/docs/NewManagementKey.md +33 -0
- data/docs/NewMultipleAudiencesItem.md +19 -0
- data/docs/NewNotificationWebhook.md +19 -0
- data/docs/NewPassword.md +2 -2
- data/docs/NewPicklist.md +19 -0
- data/docs/NewReferral.md +10 -10
- data/docs/NewReferralsForMultipleAdvocates.md +13 -13
- data/docs/NewReturn.md +17 -0
- data/docs/NewRole.md +8 -8
- data/docs/NewRuleset.md +7 -5
- data/docs/NewSamlConnection.md +1 -1
- data/docs/NewUser.md +3 -3
- data/docs/NewWebhook.md +16 -14
- data/docs/Notification.md +3 -3
- data/docs/NotificationWebhook.md +27 -0
- data/docs/OutgoingIntegrationBrazePolicy.md +19 -0
- data/docs/OutgoingIntegrationConfiguration.md +21 -0
- data/docs/OutgoingIntegrationType.md +25 -0
- data/docs/OutgoingIntegrationTypes.md +17 -0
- data/docs/OutgoingIntegrationWebhookTemplate.md +27 -0
- data/docs/OutgoingIntegrationWebhookTemplates.md +17 -0
- data/docs/PatchItemCatalogAction.md +23 -0
- data/docs/PatchManyItemsCatalogAction.md +21 -0
- data/docs/Picklist.md +31 -0
- data/docs/PriorityPosition.md +19 -0
- data/docs/ProfileAudiencesChanges.md +2 -2
- data/docs/RedeemReferralEffectProps.md +2 -2
- data/docs/Referral.md +19 -19
- data/docs/ReferralConstraints.md +5 -5
- data/docs/ReferralCreatedEffectProps.md +1 -1
- data/docs/ReferralRejectionReason.md +1 -1
- data/docs/RejectCouponEffectProps.md +5 -5
- data/docs/RejectReferralEffectProps.md +5 -5
- data/docs/RemoveItemCatalogAction.md +17 -0
- data/docs/RemoveManyItemsCatalogAction.md +17 -0
- data/docs/ReserveCouponEffectProps.md +21 -0
- data/docs/ReturnIntegrationRequest.md +19 -0
- data/docs/ReturnedCartItem.md +19 -0
- data/docs/Role.md +17 -17
- data/docs/RoleAssign.md +4 -4
- data/docs/RoleMembership.md +2 -2
- data/docs/RoleV2.md +25 -0
- data/docs/RoleV2ApplicationDetails.md +21 -0
- data/docs/RoleV2PermissionSet.md +19 -0
- data/docs/RoleV2Permissions.md +19 -0
- data/docs/RoleV2PermissionsRoles.md +21 -0
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +12 -6
- data/docs/RollbackCouponEffectProps.md +1 -1
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +11 -9
- data/docs/RollbackDiscountEffectProps.md +13 -3
- data/docs/RollbackReferralEffectProps.md +1 -1
- data/docs/Rule.md +8 -4
- data/docs/RuleFailureReason.md +13 -13
- data/docs/Ruleset.md +17 -13
- data/docs/SamlConnection.md +5 -5
- data/docs/Session.md +5 -5
- data/docs/SetDiscountEffectProps.md +6 -4
- data/docs/SetDiscountPerAdditionalCostEffectProps.md +25 -0
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +29 -0
- data/docs/SetDiscountPerItemEffectProps.md +17 -5
- data/docs/ShowBundleMetadataEffectProps.md +3 -3
- data/docs/ShowNotificationEffectProps.md +3 -3
- data/docs/StrikethroughChangedItem.md +29 -0
- data/docs/StrikethroughEffect.md +27 -0
- data/docs/StrikethroughLabelingNotification.md +25 -0
- data/docs/StrikethroughSetDiscountPerItemEffectProps.md +19 -0
- data/docs/StrikethroughTrigger.md +25 -0
- data/docs/TalangAttribute.md +33 -0
- data/docs/TalangAttributeVisibility.md +19 -0
- data/docs/TemplateArgDef.md +5 -1
- data/docs/TemplateDef.md +5 -5
- data/docs/TemplateLimitConfig.md +23 -0
- data/docs/Tier.md +19 -0
- data/docs/TransferLoyaltyCard.md +17 -0
- data/docs/TriggerWebhookEffectProps.md +2 -2
- data/docs/UpdateAccount.md +2 -2
- data/docs/UpdateApplication.md +25 -21
- data/docs/UpdateAttributeEffectProps.md +2 -2
- data/docs/UpdateAudience.md +2 -2
- data/docs/UpdateCampaign.md +15 -15
- data/docs/UpdateCampaignCollection.md +17 -0
- data/docs/UpdateCampaignGroup.md +5 -5
- data/docs/UpdateCampaignTemplate.md +47 -0
- data/docs/UpdateCatalog.md +21 -0
- data/docs/UpdateCollection.md +19 -0
- data/docs/UpdateCoupon.md +17 -11
- data/docs/UpdateCouponBatch.md +11 -9
- data/docs/UpdateCustomEffect.md +6 -4
- data/docs/UpdateLoyaltyCard.md +17 -0
- data/docs/UpdateLoyaltyProgram.md +15 -9
- data/docs/UpdatePicklist.md +19 -0
- data/docs/UpdateReferral.md +7 -7
- data/docs/UpdateReferralBatch.md +25 -0
- data/docs/UpdateRole.md +8 -8
- data/docs/UpdateUser.md +7 -7
- data/docs/UpdateUserLatestFeedTimestamp.md +1 -1
- data/docs/User.md +17 -17
- data/docs/UserEntity.md +2 -2
- data/docs/UserFeedNotifications.md +2 -2
- data/docs/Webhook.md +22 -20
- data/docs/WebhookActivationLogEntry.md +9 -9
- data/docs/WebhookLogEntry.md +18 -15
- data/docs/WillAwardGiveawayEffectProps.md +3 -3
- data/lib/talon_one/api/integration_api.rb +1168 -231
- data/lib/talon_one/api/management_api.rb +5076 -2861
- data/lib/talon_one/api_client.rb +2 -2
- data/lib/talon_one/api_error.rb +2 -2
- data/lib/talon_one/configuration.rb +8 -8
- data/lib/talon_one/models/accept_coupon_effect_props.rb +3 -3
- data/lib/talon_one/models/accept_referral_effect_props.rb +3 -3
- data/lib/talon_one/models/access_log_entry.rb +6 -6
- data/lib/talon_one/models/account.rb +8 -8
- data/lib/talon_one/models/account_additional_cost.rb +98 -10
- data/lib/talon_one/models/account_analytics.rb +39 -24
- data/lib/talon_one/models/account_dashboard_statistic.rb +271 -0
- data/lib/talon_one/models/account_dashboard_statistic_api_calls.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_campaigns.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_discount.rb +242 -0
- data/lib/talon_one/models/account_dashboard_statistic_loyalty_points.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_referrals.rb +227 -0
- data/lib/talon_one/models/account_dashboard_statistic_revenue.rb +242 -0
- data/lib/talon_one/models/account_entity.rb +2 -2
- data/lib/talon_one/models/account_limits.rb +14 -14
- data/lib/talon_one/models/add_free_item_effect_props.rb +4 -4
- data/lib/talon_one/models/add_item_catalog_action.rb +245 -0
- data/lib/talon_one/models/add_loyalty_points.rb +311 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +109 -15
- data/lib/talon_one/models/added_deducted_points_notification_policy.rb +269 -0
- data/lib/talon_one/models/additional_cost.rb +2 -2
- data/lib/talon_one/models/api_error.rb +2 -2
- data/lib/talon_one/models/application.rb +53 -17
- data/lib/talon_one/models/application_api_health.rb +5 -5
- data/lib/talon_one/models/application_api_key.rb +12 -12
- data/lib/talon_one/models/application_campaign_stats.rb +9 -9
- data/lib/talon_one/models/application_customer.rb +68 -14
- data/lib/talon_one/models/application_customer_entity.rb +2 -2
- data/lib/talon_one/models/application_entity.rb +2 -2
- data/lib/talon_one/models/application_event.rb +5 -5
- data/lib/talon_one/models/application_notification.rb +212 -0
- data/lib/talon_one/models/application_referee.rb +44 -6
- data/lib/talon_one/models/application_session.rb +60 -11
- data/lib/talon_one/models/application_session_entity.rb +2 -2
- data/lib/talon_one/models/async_coupon_creation_response.rb +212 -0
- data/lib/talon_one/models/attribute.rb +108 -9
- data/lib/talon_one/models/attributes_mandatory.rb +2 -2
- data/lib/talon_one/models/attributes_settings.rb +2 -2
- data/lib/talon_one/models/audience.rb +57 -56
- data/lib/talon_one/models/audience_analytics.rb +218 -0
- data/lib/talon_one/models/audience_customer.rb +395 -0
- data/lib/talon_one/models/audience_integration_id.rb +231 -0
- data/lib/talon_one/models/audience_membership.rb +2 -2
- data/lib/talon_one/models/award_giveaway_effect_props.rb +21 -2
- data/lib/talon_one/models/base_loyalty_program.rb +294 -0
- data/lib/talon_one/models/base_notification.rb +260 -0
- data/lib/talon_one/models/base_notification_entity.rb +211 -0
- data/lib/talon_one/models/base_notification_webhook.rb +275 -0
- data/lib/talon_one/models/base_notifications.rb +209 -0
- data/lib/talon_one/models/base_saml_connection.rb +2 -2
- data/lib/talon_one/models/binding.rb +17 -7
- data/lib/talon_one/models/bulk_application_notification.rb +227 -0
- data/lib/talon_one/models/bulk_campaign_notification.rb +227 -0
- data/lib/talon_one/models/campaign.rb +66 -16
- data/lib/talon_one/models/campaign_activation_request.rb +214 -0
- data/lib/talon_one/models/campaign_analytics.rb +2 -2
- data/lib/talon_one/models/campaign_collection.rb +370 -0
- data/lib/talon_one/models/campaign_collection_without_payload.rb +358 -0
- data/lib/talon_one/models/campaign_copy.rb +6 -6
- data/lib/talon_one/models/campaign_created_notification.rb +235 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +227 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +235 -0
- data/lib/talon_one/models/campaign_entity.rb +2 -2
- data/lib/talon_one/models/campaign_group.rb +7 -7
- data/lib/talon_one/models/campaign_group_entity.rb +2 -2
- data/lib/talon_one/models/campaign_notification.rb +212 -0
- data/lib/talon_one/models/campaign_priorities_changed_notification.rb +236 -0
- data/lib/talon_one/models/campaign_priorities_v2.rb +230 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +230 -0
- data/lib/talon_one/models/campaign_search.rb +3 -3
- data/lib/talon_one/models/campaign_set.rb +19 -9
- data/lib/talon_one/models/campaign_set_branch_node.rb +5 -5
- data/lib/talon_one/models/campaign_set_i_ds.rb +208 -0
- data/lib/talon_one/models/campaign_set_leaf_node.rb +3 -3
- data/lib/talon_one/models/campaign_set_node.rb +2 -2
- data/lib/talon_one/models/campaign_set_v2.rb +291 -0
- data/lib/talon_one/models/campaign_state_changed_notification.rb +251 -0
- data/lib/talon_one/models/campaign_template.rb +543 -0
- data/lib/talon_one/models/campaign_template_collection.rb +252 -0
- data/lib/talon_one/models/campaign_template_params.rb +305 -0
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +508 -0
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +508 -0
- data/lib/talon_one/models/cart_item.rb +59 -41
- data/lib/talon_one/models/catalog.rb +330 -0
- data/lib/talon_one/models/catalog_action.rb +261 -0
- data/lib/talon_one/models/catalog_action_filter.rb +277 -0
- data/lib/talon_one/models/catalog_item.rb +313 -0
- data/lib/talon_one/models/catalog_sync_request.rb +238 -0
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +231 -0
- data/lib/talon_one/models/change.rb +20 -10
- data/lib/talon_one/models/change_profile_password.rb +2 -2
- data/lib/talon_one/models/code_generator_settings.rb +4 -4
- data/lib/talon_one/models/collection.rb +382 -0
- data/lib/talon_one/models/collection_item.rb +212 -0
- data/lib/talon_one/models/collection_without_payload.rb +370 -0
- data/lib/talon_one/models/coupon.rb +100 -15
- data/lib/talon_one/models/coupon_constraints.rb +40 -6
- data/lib/talon_one/models/coupon_created_effect_props.rb +4 -4
- data/lib/talon_one/models/coupon_creation_job.rb +603 -0
- data/lib/talon_one/models/coupon_limit_configs.rb +209 -0
- data/lib/talon_one/models/coupon_rejection_reason.rb +4 -4
- data/lib/talon_one/models/coupon_reservations.rb +3 -3
- data/lib/talon_one/models/coupon_search.rb +3 -3
- data/lib/talon_one/models/coupon_value.rb +3 -3
- data/lib/talon_one/models/coupons_notification_policy.rb +269 -0
- data/lib/talon_one/models/create_application_api_key.rb +7 -7
- data/lib/talon_one/models/create_management_key.rb +256 -0
- data/lib/talon_one/models/create_template_campaign.rb +314 -0
- data/lib/talon_one/models/create_template_campaign_response.rb +236 -0
- data/lib/talon_one/models/custom_effect.rb +76 -19
- data/lib/talon_one/models/custom_effect_props.rb +67 -12
- data/lib/talon_one/models/customer_activity_report.rb +24 -5
- data/lib/talon_one/models/customer_analytics.rb +10 -10
- data/lib/talon_one/models/customer_inventory.rb +4 -3
- data/lib/talon_one/models/customer_profile.rb +66 -22
- data/lib/talon_one/models/customer_profile_audience_request.rb +2 -2
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +24 -2
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +17 -5
- data/lib/talon_one/models/customer_profile_search_query.rb +3 -3
- data/lib/talon_one/models/customer_profile_update_v2_response.rb +212 -0
- data/lib/talon_one/models/customer_session.rb +47 -13
- data/lib/talon_one/models/customer_session_v2.rb +103 -30
- data/lib/talon_one/models/{loyalty_points.rb → deduct_loyalty_points.rb} +28 -38
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +51 -11
- data/lib/talon_one/models/effect.rb +20 -9
- data/lib/talon_one/models/effect_entity.rb +23 -13
- data/lib/talon_one/models/email_entity.rb +2 -2
- data/lib/talon_one/models/endpoint.rb +212 -0
- data/lib/talon_one/models/entity.rb +4 -4
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +2 -2
- data/lib/talon_one/models/environment.rb +24 -11
- data/lib/talon_one/models/error_effect_props.rb +2 -2
- data/lib/talon_one/models/error_response.rb +2 -2
- data/lib/talon_one/models/error_response_with_status.rb +228 -0
- data/lib/talon_one/models/error_source.rb +3 -3
- data/lib/talon_one/models/evaluable_campaign_ids.rb +209 -0
- data/lib/talon_one/models/event.rb +6 -6
- data/lib/talon_one/models/event_type.rb +11 -154
- data/lib/talon_one/models/event_v2.rb +264 -0
- data/lib/talon_one/models/expiring_points_notification_policy.rb +247 -0
- data/lib/talon_one/models/expiring_points_notification_trigger.rb +280 -0
- data/lib/talon_one/models/export.rb +8 -8
- data/lib/talon_one/models/feature_flag.rb +6 -6
- data/lib/talon_one/models/features_feed.rb +2 -2
- data/lib/talon_one/models/feed_notification.rb +9 -9
- data/lib/talon_one/models/frontend_state.rb +39 -0
- data/lib/talon_one/models/func_arg_def.rb +4 -4
- data/lib/talon_one/models/function_def.rb +2 -2
- data/lib/talon_one/models/giveaway.rb +29 -9
- data/lib/talon_one/models/giveaways_pool.rb +22 -7
- data/lib/talon_one/models/import.rb +7 -7
- data/lib/talon_one/models/import_entity.rb +2 -2
- data/lib/talon_one/models/inline_response200.rb +2 -2
- data/lib/talon_one/models/inline_response2001.rb +13 -13
- data/lib/talon_one/models/inline_response20010.rb +3 -3
- data/lib/talon_one/models/inline_response20011.rb +9 -13
- data/lib/talon_one/models/inline_response20012.rb +3 -3
- data/lib/talon_one/models/inline_response20013.rb +15 -13
- data/lib/talon_one/models/inline_response20014.rb +13 -9
- data/lib/talon_one/models/inline_response20015.rb +8 -3
- data/lib/talon_one/models/inline_response20016.rb +13 -9
- data/lib/talon_one/models/inline_response20017.rb +3 -3
- data/lib/talon_one/models/inline_response20018.rb +3 -3
- data/lib/talon_one/models/inline_response20019.rb +9 -13
- data/lib/talon_one/models/inline_response2002.rb +3 -3
- data/lib/talon_one/models/inline_response20020.rb +13 -9
- data/lib/talon_one/models/inline_response20021.rb +13 -9
- data/lib/talon_one/models/inline_response20022.rb +13 -9
- data/lib/talon_one/models/inline_response20023.rb +13 -13
- data/lib/talon_one/models/inline_response20024.rb +13 -13
- data/lib/talon_one/models/inline_response20025.rb +10 -15
- data/lib/talon_one/models/inline_response20026.rb +13 -13
- data/lib/talon_one/models/inline_response20027.rb +9 -13
- data/lib/talon_one/models/inline_response20028.rb +13 -9
- data/lib/talon_one/models/inline_response20029.rb +13 -9
- data/lib/talon_one/models/inline_response2003.rb +3 -3
- data/lib/talon_one/models/inline_response20030.rb +227 -0
- data/lib/talon_one/models/inline_response20031.rb +227 -0
- data/lib/talon_one/models/inline_response20032.rb +227 -0
- data/lib/talon_one/models/inline_response20033.rb +227 -0
- data/lib/talon_one/models/inline_response20034.rb +227 -0
- data/lib/talon_one/models/inline_response20035.rb +227 -0
- data/lib/talon_one/models/inline_response20036.rb +227 -0
- data/lib/talon_one/models/inline_response20037.rb +231 -0
- data/lib/talon_one/models/inline_response20038.rb +227 -0
- data/lib/talon_one/models/inline_response20039.rb +227 -0
- data/lib/talon_one/models/inline_response2004.rb +3 -3
- data/lib/talon_one/models/inline_response2005.rb +13 -13
- data/lib/talon_one/models/inline_response2006.rb +13 -13
- data/lib/talon_one/models/inline_response2007.rb +13 -13
- data/lib/talon_one/models/inline_response2008.rb +13 -13
- data/lib/talon_one/models/inline_response2009.rb +3 -3
- data/lib/talon_one/models/inline_response201.rb +2 -2
- data/lib/talon_one/models/integration_coupon.rb +569 -0
- data/lib/talon_one/models/integration_customer_session_response.rb +217 -0
- data/lib/talon_one/models/integration_entity.rb +23 -4
- data/lib/talon_one/models/integration_event.rb +3 -3
- data/lib/talon_one/models/integration_event_v2_request.rb +298 -0
- data/lib/talon_one/models/integration_profile_entity.rb +3 -3
- data/lib/talon_one/models/integration_request.rb +3 -3
- data/lib/talon_one/models/integration_state.rb +2 -2
- data/lib/talon_one/models/integration_state_v2.rb +30 -9
- data/lib/talon_one/models/inventory_coupon.rb +98 -13
- data/lib/talon_one/models/inventory_referral.rb +446 -0
- data/lib/talon_one/models/item_attribute.rb +243 -0
- data/lib/talon_one/models/ledger_entry.rb +11 -11
- data/lib/talon_one/models/ledger_info.rb +302 -0
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +474 -0
- data/lib/talon_one/models/library_attribute.rb +2 -2
- data/lib/talon_one/models/limit_config.rb +28 -6
- data/lib/talon_one/models/limit_counter.rb +398 -0
- data/lib/talon_one/models/login_params.rb +2 -2
- data/lib/talon_one/models/loyalty.rb +16 -4
- data/lib/talon_one/models/loyalty_balance.rb +238 -0
- data/lib/talon_one/models/{new_feature_flags.rb → loyalty_balances.rb} +22 -30
- data/lib/talon_one/models/loyalty_card.rb +419 -0
- data/lib/talon_one/models/loyalty_card_profile_registration.rb +246 -0
- data/lib/talon_one/models/loyalty_card_registration.rb +212 -0
- data/lib/talon_one/models/loyalty_dashboard_data.rb +331 -0
- data/lib/talon_one/models/loyalty_dashboard_points_breakdown.rb +225 -0
- data/lib/talon_one/models/loyalty_ledger.rb +4 -4
- data/lib/talon_one/models/loyalty_ledger_entry.rb +27 -13
- data/lib/talon_one/models/loyalty_ledger_transactions.rb +220 -0
- data/lib/talon_one/models/loyalty_membership.rb +2 -2
- data/lib/talon_one/models/loyalty_program.rb +143 -37
- data/lib/talon_one/models/loyalty_program_balance.rb +21 -11
- data/lib/talon_one/models/loyalty_program_entity.rb +2 -2
- data/lib/talon_one/models/loyalty_program_ledgers.rb +8 -8
- data/lib/talon_one/models/loyalty_program_transaction.rb +553 -0
- data/lib/talon_one/models/loyalty_statistics.rb +83 -10
- data/lib/talon_one/models/loyalty_sub_ledger.rb +26 -17
- data/lib/talon_one/models/loyalty_tier.rb +10 -10
- data/lib/talon_one/models/management_key.rb +317 -0
- data/lib/talon_one/models/manager_config.rb +2 -2
- data/lib/talon_one/models/meta.rb +2 -2
- data/lib/talon_one/models/model_return.rb +384 -0
- data/lib/talon_one/models/multi_application_entity.rb +2 -2
- data/lib/talon_one/models/multiple_attribute.rb +208 -0
- data/lib/talon_one/models/{feature_flags.rb → multiple_audiences.rb} +19 -34
- data/lib/talon_one/models/multiple_audiences_item.rb +354 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +2 -2
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +23 -4
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +3 -3
- data/lib/talon_one/models/multiple_new_attribute.rb +208 -0
- data/lib/talon_one/models/multiple_new_audiences.rb +213 -0
- data/lib/talon_one/models/mutable_entity.rb +3 -3
- data/lib/talon_one/models/new_account.rb +2 -2
- data/lib/talon_one/models/new_account_sign_up.rb +2 -2
- data/lib/talon_one/models/new_additional_cost.rb +96 -8
- data/lib/talon_one/models/new_application.rb +50 -14
- data/lib/talon_one/models/new_application_api_key.rb +13 -13
- data/lib/talon_one/models/new_attribute.rb +97 -7
- data/lib/talon_one/models/new_audience.rb +56 -54
- data/lib/talon_one/models/new_base_notification.rb +226 -0
- data/lib/talon_one/models/new_campaign.rb +10 -10
- data/lib/talon_one/models/new_campaign_collection.rb +253 -0
- data/lib/talon_one/models/new_campaign_group.rb +4 -4
- data/lib/talon_one/models/new_campaign_set.rb +3 -3
- data/lib/talon_one/models/new_campaign_set_v2.rb +261 -0
- data/lib/talon_one/models/new_campaign_template.rb +418 -0
- data/lib/talon_one/models/new_catalog.rb +240 -0
- data/lib/talon_one/models/new_collection.rb +265 -0
- data/lib/talon_one/models/new_coupon_creation_job.rb +396 -0
- data/lib/talon_one/models/new_coupons.rb +87 -14
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +44 -10
- data/lib/talon_one/models/new_custom_effect.rb +74 -16
- data/lib/talon_one/models/new_customer_profile.rb +3 -3
- data/lib/talon_one/models/new_customer_session.rb +7 -7
- data/lib/talon_one/models/new_customer_session_v2.rb +38 -14
- data/lib/talon_one/models/new_event.rb +3 -3
- data/lib/talon_one/models/new_event_type.rb +9 -152
- data/lib/talon_one/models/new_giveaways_pool.rb +22 -7
- data/lib/talon_one/models/{update_loyalty_tier.rb → new_internal_audience.rb} +34 -39
- data/lib/talon_one/models/new_invitation.rb +5 -5
- data/lib/talon_one/models/new_invite_email.rb +2 -2
- data/lib/talon_one/models/new_loyalty_program.rb +128 -25
- data/lib/talon_one/models/new_loyalty_tier.rb +9 -9
- data/lib/talon_one/models/new_management_key.rb +332 -0
- data/lib/talon_one/models/new_multiple_audiences_item.rb +266 -0
- data/lib/talon_one/models/new_notification_webhook.rb +229 -0
- data/lib/talon_one/models/new_password.rb +2 -2
- data/lib/talon_one/models/new_password_email.rb +2 -2
- data/lib/talon_one/models/new_picklist.rb +263 -0
- data/lib/talon_one/models/new_referral.rb +24 -5
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +7 -7
- data/lib/talon_one/models/new_return.rb +214 -0
- data/lib/talon_one/models/new_role.rb +17 -17
- data/lib/talon_one/models/new_ruleset.rb +17 -5
- data/lib/talon_one/models/new_saml_connection.rb +2 -2
- data/lib/talon_one/models/new_template_def.rb +2 -2
- data/lib/talon_one/models/new_user.rb +2 -2
- data/lib/talon_one/models/new_webhook.rb +30 -9
- data/lib/talon_one/models/notification.rb +5 -5
- data/lib/talon_one/models/notification_webhook.rb +290 -0
- data/lib/talon_one/models/outgoing_integration_braze_policy.rb +227 -0
- data/lib/talon_one/models/outgoing_integration_configuration.rb +241 -0
- data/lib/talon_one/models/outgoing_integration_type.rb +357 -0
- data/lib/talon_one/models/outgoing_integration_types.rb +209 -0
- data/lib/talon_one/models/outgoing_integration_webhook_template.rb +328 -0
- data/lib/talon_one/models/outgoing_integration_webhook_templates.rb +209 -0
- data/lib/talon_one/models/patch_item_catalog_action.rb +245 -0
- data/lib/talon_one/models/patch_many_items_catalog_action.rb +230 -0
- data/lib/talon_one/models/picklist.rb +339 -0
- data/lib/talon_one/models/priority_position.rb +264 -0
- data/lib/talon_one/models/profile_audiences_changes.rb +2 -2
- data/lib/talon_one/models/redeem_referral_effect_props.rb +5 -5
- data/lib/talon_one/models/referral.rb +27 -8
- data/lib/talon_one/models/referral_constraints.rb +4 -4
- data/lib/talon_one/models/referral_created_effect_props.rb +3 -3
- data/lib/talon_one/models/referral_rejection_reason.rb +4 -4
- data/lib/talon_one/models/reject_coupon_effect_props.rb +7 -7
- data/lib/talon_one/models/reject_referral_effect_props.rb +7 -7
- data/lib/talon_one/models/remove_item_catalog_action.rb +213 -0
- data/lib/talon_one/models/remove_many_items_catalog_action.rb +210 -0
- data/lib/talon_one/models/reserve_coupon_effect_props.rb +243 -0
- data/lib/talon_one/models/return_integration_request.rb +246 -0
- data/lib/talon_one/models/returned_cart_item.rb +222 -0
- data/lib/talon_one/models/role.rb +10 -10
- data/lib/talon_one/models/role_assign.rb +4 -4
- data/lib/talon_one/models/role_membership.rb +4 -4
- data/lib/talon_one/models/role_v2.rb +248 -0
- data/lib/talon_one/models/role_v2_application_details.rb +227 -0
- data/lib/talon_one/models/role_v2_permission_set.rb +228 -0
- data/lib/talon_one/models/role_v2_permissions.rb +218 -0
- data/lib/talon_one/models/role_v2_permissions_roles.rb +230 -0
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +74 -10
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +3 -3
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +57 -13
- data/lib/talon_one/models/rollback_discount_effect_props.rb +59 -9
- data/lib/talon_one/models/rollback_referral_effect_props.rb +3 -3
- data/lib/talon_one/models/rule.rb +23 -3
- data/lib/talon_one/models/rule_failure_reason.rb +15 -15
- data/lib/talon_one/models/ruleset.rb +40 -23
- data/lib/talon_one/models/saml_connection.rb +4 -4
- data/lib/talon_one/models/saml_connection_metadata.rb +2 -2
- data/lib/talon_one/models/saml_login_endpoint.rb +2 -2
- data/lib/talon_one/models/session.rb +4 -4
- data/lib/talon_one/models/set_discount_effect_props.rb +19 -9
- data/lib/talon_one/models/set_discount_per_additional_cost_effect_props.rb +268 -0
- data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +293 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +71 -11
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +6 -6
- data/lib/talon_one/models/show_notification_effect_props.rb +5 -5
- data/lib/talon_one/models/slot_def.rb +2 -2
- data/lib/talon_one/models/strikethrough_changed_item.rb +318 -0
- data/lib/talon_one/models/strikethrough_effect.rb +287 -0
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +273 -0
- data/lib/talon_one/models/strikethrough_set_discount_per_item_effect_props.rb +228 -0
- data/lib/talon_one/models/strikethrough_trigger.rb +273 -0
- data/lib/talon_one/models/talang_attribute.rb +363 -0
- data/lib/talon_one/models/{application_customer_search.rb → talang_attribute_visibility.rb} +22 -30
- data/lib/talon_one/models/template_arg_def.rb +28 -8
- data/lib/talon_one/models/template_def.rb +4 -4
- data/lib/talon_one/models/template_limit_config.rb +308 -0
- data/lib/talon_one/models/tier.rb +227 -0
- data/lib/talon_one/models/transfer_loyalty_card.rb +231 -0
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +4 -4
- data/lib/talon_one/models/update_account.rb +4 -4
- data/lib/talon_one/models/update_application.rb +52 -16
- data/lib/talon_one/models/update_attribute_effect_props.rb +4 -4
- data/lib/talon_one/models/update_audience.rb +3 -3
- data/lib/talon_one/models/update_campaign.rb +7 -7
- data/lib/talon_one/models/update_campaign_collection.rb +207 -0
- data/lib/talon_one/models/update_campaign_group.rb +4 -4
- data/lib/talon_one/models/update_campaign_template.rb +445 -0
- data/lib/talon_one/models/update_catalog.rb +229 -0
- data/lib/talon_one/models/update_collection.rb +219 -0
- data/lib/talon_one/models/update_coupon.rb +84 -11
- data/lib/talon_one/models/update_coupon_batch.rb +39 -10
- data/lib/talon_one/models/update_custom_effect.rb +73 -16
- data/lib/talon_one/models/update_loyalty_card.rb +212 -0
- data/lib/talon_one/models/update_loyalty_program.rb +57 -10
- data/lib/talon_one/models/update_picklist.rb +264 -0
- data/lib/talon_one/models/update_referral.rb +20 -5
- data/lib/talon_one/models/update_referral_batch.rb +276 -0
- data/lib/talon_one/models/update_role.rb +14 -14
- data/lib/talon_one/models/update_user.rb +5 -5
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +4 -4
- data/lib/talon_one/models/user.rb +7 -7
- data/lib/talon_one/models/user_entity.rb +3 -3
- data/lib/talon_one/models/user_feed_notifications.rb +5 -5
- data/lib/talon_one/models/webhook.rb +33 -12
- data/lib/talon_one/models/webhook_activation_log_entry.rb +7 -7
- data/lib/talon_one/models/webhook_log_entry.rb +8 -8
- data/lib/talon_one/models/will_award_giveaway_effect_props.rb +21 -2
- data/lib/talon_one/version.rb +3 -3
- data/lib/talon_one.rb +153 -7
- data/spec/api/integration_api_spec.rb +249 -72
- data/spec/api/management_api_spec.rb +951 -580
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +5 -5
- data/spec/models/accept_coupon_effect_props_spec.rb +2 -2
- data/spec/models/accept_referral_effect_props_spec.rb +2 -2
- data/spec/models/access_log_entry_spec.rb +2 -2
- data/spec/models/account_additional_cost_spec.rb +12 -2
- data/spec/models/account_analytics_spec.rb +8 -2
- data/spec/models/account_dashboard_statistic_api_calls_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_campaigns_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_discount_spec.rb +53 -0
- data/spec/models/account_dashboard_statistic_loyalty_points_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_referrals_spec.rb +47 -0
- data/spec/models/account_dashboard_statistic_revenue_spec.rb +53 -0
- data/spec/models/account_dashboard_statistic_spec.rb +71 -0
- data/spec/models/account_entity_spec.rb +2 -2
- data/spec/models/account_limits_spec.rb +2 -2
- data/spec/models/account_spec.rb +2 -2
- data/spec/models/add_free_item_effect_props_spec.rb +2 -2
- data/spec/models/add_item_catalog_action_spec.rb +59 -0
- data/spec/models/add_loyalty_points_effect_props_spec.rb +38 -2
- data/spec/models/add_loyalty_points_spec.rb +83 -0
- data/spec/models/added_deducted_points_notification_policy_spec.rb +51 -0
- data/spec/models/additional_cost_spec.rb +2 -2
- data/spec/models/api_error_spec.rb +2 -2
- data/spec/models/application_api_health_spec.rb +2 -2
- data/spec/models/application_api_key_spec.rb +3 -3
- data/spec/models/application_campaign_stats_spec.rb +2 -2
- data/spec/models/application_customer_entity_spec.rb +2 -2
- data/spec/models/application_customer_spec.rb +14 -2
- data/spec/models/application_entity_spec.rb +2 -2
- data/spec/models/application_event_spec.rb +2 -2
- data/spec/models/application_notification_spec.rb +41 -0
- data/spec/models/application_referee_spec.rb +2 -2
- data/spec/models/application_session_entity_spec.rb +2 -2
- data/spec/models/application_session_spec.rb +9 -3
- data/spec/models/application_spec.rb +18 -2
- data/spec/models/async_coupon_creation_response_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +36 -2
- data/spec/models/attributes_mandatory_spec.rb +2 -2
- data/spec/models/attributes_settings_spec.rb +2 -2
- data/spec/models/audience_analytics_spec.rb +47 -0
- data/spec/models/audience_customer_spec.rb +113 -0
- data/spec/models/audience_integration_id_spec.rb +41 -0
- data/spec/models/audience_membership_spec.rb +2 -2
- data/spec/models/audience_spec.rb +26 -6
- data/spec/models/award_giveaway_effect_props_spec.rb +2 -2
- data/spec/models/base_loyalty_program_spec.rb +83 -0
- data/spec/models/base_notification_entity_spec.rb +41 -0
- data/spec/models/base_notification_spec.rb +53 -0
- data/spec/models/base_notification_webhook_spec.rb +65 -0
- data/spec/models/base_notifications_spec.rb +41 -0
- data/spec/models/base_saml_connection_spec.rb +2 -2
- data/spec/models/binding_spec.rb +8 -2
- data/spec/models/bulk_application_notification_spec.rb +47 -0
- data/spec/models/bulk_campaign_notification_spec.rb +47 -0
- data/spec/models/campaign_activation_request_spec.rb +41 -0
- data/spec/models/campaign_analytics_spec.rb +2 -2
- data/spec/models/campaign_collection_spec.rb +101 -0
- data/spec/models/campaign_collection_without_payload_spec.rb +95 -0
- data/spec/models/campaign_copy_spec.rb +2 -2
- data/spec/models/campaign_created_notification_spec.rb +53 -0
- data/spec/models/campaign_deleted_notification_spec.rb +47 -0
- data/spec/models/campaign_edited_notification_spec.rb +53 -0
- data/spec/models/campaign_entity_spec.rb +2 -2
- data/spec/models/campaign_group_entity_spec.rb +2 -2
- data/spec/models/campaign_group_spec.rb +2 -2
- data/spec/models/campaign_notification_spec.rb +41 -0
- data/spec/models/campaign_priorities_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_priorities_v2_spec.rb +53 -0
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_search_spec.rb +2 -2
- data/spec/models/campaign_set_branch_node_spec.rb +2 -2
- data/spec/models/campaign_set_i_ds_spec.rb +41 -0
- data/spec/models/campaign_set_leaf_node_spec.rb +2 -2
- data/spec/models/campaign_set_node_spec.rb +2 -2
- data/spec/models/campaign_set_spec.rb +8 -2
- data/spec/models/campaign_set_v2_spec.rb +65 -0
- data/spec/models/campaign_spec.rb +33 -3
- data/spec/models/campaign_state_changed_notification_spec.rb +59 -0
- data/spec/models/campaign_template_collection_spec.rb +47 -0
- data/spec/models/campaign_template_params_spec.rb +63 -0
- data/spec/models/campaign_template_spec.rb +181 -0
- data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +117 -0
- data/spec/models/card_ledger_transaction_log_entry_spec.rb +117 -0
- data/spec/models/cart_item_spec.rb +26 -2
- data/spec/models/catalog_action_filter_spec.rb +57 -0
- data/spec/models/catalog_action_spec.rb +51 -0
- data/spec/models/catalog_item_spec.rb +77 -0
- data/spec/models/catalog_spec.rb +89 -0
- data/spec/models/catalog_sync_request_spec.rb +47 -0
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +41 -0
- data/spec/models/change_profile_password_spec.rb +2 -2
- data/spec/models/change_spec.rb +8 -2
- data/spec/models/code_generator_settings_spec.rb +2 -2
- data/spec/models/collection_item_spec.rb +41 -0
- data/spec/models/collection_spec.rb +107 -0
- data/spec/models/collection_without_payload_spec.rb +101 -0
- data/spec/models/coupon_constraints_spec.rb +8 -2
- data/spec/models/coupon_created_effect_props_spec.rb +2 -2
- data/spec/models/coupon_creation_job_spec.rb +167 -0
- data/spec/models/coupon_limit_configs_spec.rb +41 -0
- data/spec/models/coupon_rejection_reason_spec.rb +3 -3
- data/spec/models/coupon_reservations_spec.rb +2 -2
- data/spec/models/coupon_search_spec.rb +2 -2
- data/spec/models/coupon_spec.rb +26 -2
- data/spec/models/coupon_value_spec.rb +2 -2
- data/spec/models/coupons_notification_policy_spec.rb +51 -0
- data/spec/models/create_application_api_key_spec.rb +3 -3
- data/spec/models/create_management_key_spec.rb +59 -0
- data/spec/models/create_template_campaign_response_spec.rb +53 -0
- data/spec/models/create_template_campaign_spec.rb +83 -0
- data/spec/models/custom_effect_props_spec.rb +33 -3
- data/spec/models/custom_effect_spec.rb +14 -8
- data/spec/models/customer_activity_report_spec.rb +2 -2
- data/spec/models/customer_analytics_spec.rb +2 -2
- data/spec/models/customer_inventory_spec.rb +2 -2
- data/spec/models/customer_profile_audience_request_item_spec.rb +2 -2
- data/spec/models/customer_profile_audience_request_spec.rb +2 -2
- data/spec/models/customer_profile_integration_request_v2_spec.rb +8 -2
- data/spec/models/customer_profile_search_query_spec.rb +2 -2
- data/spec/models/customer_profile_spec.rb +15 -3
- data/spec/models/customer_profile_update_v2_response_spec.rb +41 -0
- data/spec/models/customer_session_spec.rb +9 -3
- data/spec/models/customer_session_v2_spec.rb +28 -4
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +14 -2
- data/spec/models/deduct_loyalty_points_spec.rb +59 -0
- data/spec/models/effect_entity_spec.rb +8 -2
- data/spec/models/effect_spec.rb +8 -2
- data/spec/models/email_entity_spec.rb +2 -2
- data/spec/models/endpoint_spec.rb +41 -0
- data/spec/models/entity_spec.rb +2 -2
- data/spec/models/entity_with_talang_visible_id_spec.rb +2 -2
- data/spec/models/environment_spec.rb +9 -3
- data/spec/models/error_effect_props_spec.rb +2 -2
- data/spec/models/error_response_spec.rb +2 -2
- data/spec/models/error_response_with_status_spec.rb +53 -0
- data/spec/models/error_source_spec.rb +2 -2
- data/spec/models/evaluable_campaign_ids_spec.rb +41 -0
- data/spec/models/event_spec.rb +2 -2
- data/spec/models/event_type_spec.rb +2 -52
- data/spec/models/event_v2_spec.rb +59 -0
- data/spec/models/expiring_points_notification_policy_spec.rb +47 -0
- data/spec/models/expiring_points_notification_trigger_spec.rb +51 -0
- data/spec/models/export_spec.rb +3 -3
- data/spec/models/feature_flag_spec.rb +2 -2
- data/spec/models/features_feed_spec.rb +2 -2
- data/spec/models/feed_notification_spec.rb +2 -2
- data/spec/models/frontend_state_spec.rb +35 -0
- data/spec/models/func_arg_def_spec.rb +3 -3
- data/spec/models/function_def_spec.rb +2 -2
- data/spec/models/giveaway_spec.rb +14 -2
- data/spec/models/giveaways_pool_spec.rb +8 -2
- data/spec/models/import_entity_spec.rb +2 -2
- data/spec/models/import_spec.rb +2 -2
- data/spec/models/inline_response20010_spec.rb +2 -2
- data/spec/models/inline_response20011_spec.rb +2 -8
- data/spec/models/inline_response20012_spec.rb +2 -2
- data/spec/models/inline_response20013_spec.rb +3 -3
- data/spec/models/inline_response20014_spec.rb +8 -2
- data/spec/models/inline_response20015_spec.rb +2 -2
- data/spec/models/inline_response20016_spec.rb +8 -2
- data/spec/models/inline_response20017_spec.rb +2 -2
- data/spec/models/inline_response20018_spec.rb +2 -2
- data/spec/models/inline_response20019_spec.rb +2 -8
- data/spec/models/inline_response2001_spec.rb +3 -3
- data/spec/models/inline_response20020_spec.rb +8 -2
- data/spec/models/inline_response20021_spec.rb +8 -2
- data/spec/models/inline_response20022_spec.rb +8 -2
- data/spec/models/inline_response20023_spec.rb +3 -3
- data/spec/models/inline_response20024_spec.rb +3 -3
- data/spec/models/inline_response20025_spec.rb +3 -3
- data/spec/models/inline_response20026_spec.rb +3 -3
- data/spec/models/inline_response20027_spec.rb +2 -8
- data/spec/models/inline_response20028_spec.rb +8 -2
- data/spec/models/inline_response20029_spec.rb +8 -2
- data/spec/models/inline_response2002_spec.rb +2 -2
- data/spec/models/inline_response20030_spec.rb +47 -0
- data/spec/models/inline_response20031_spec.rb +47 -0
- data/spec/models/inline_response20032_spec.rb +47 -0
- data/spec/models/inline_response20033_spec.rb +47 -0
- data/spec/models/inline_response20034_spec.rb +47 -0
- data/spec/models/inline_response20035_spec.rb +47 -0
- data/spec/models/inline_response20036_spec.rb +47 -0
- data/spec/models/inline_response20037_spec.rb +53 -0
- data/spec/models/inline_response20038_spec.rb +47 -0
- data/spec/models/inline_response20039_spec.rb +47 -0
- data/spec/models/inline_response2003_spec.rb +2 -2
- data/spec/models/inline_response2004_spec.rb +2 -2
- data/spec/models/inline_response2005_spec.rb +3 -3
- data/spec/models/inline_response2006_spec.rb +3 -3
- data/spec/models/inline_response2007_spec.rb +3 -3
- data/spec/models/inline_response2008_spec.rb +3 -3
- data/spec/models/inline_response2009_spec.rb +2 -2
- data/spec/models/inline_response200_spec.rb +2 -2
- data/spec/models/inline_response201_spec.rb +2 -2
- data/spec/models/integration_coupon_spec.rb +167 -0
- data/spec/models/integration_customer_session_response_spec.rb +47 -0
- data/spec/models/integration_entity_spec.rb +2 -2
- data/spec/models/integration_event_spec.rb +2 -2
- data/spec/models/integration_event_v2_request_spec.rb +69 -0
- data/spec/models/integration_profile_entity_spec.rb +2 -2
- data/spec/models/integration_request_spec.rb +3 -3
- data/spec/models/integration_state_spec.rb +2 -2
- data/spec/models/integration_state_v2_spec.rb +14 -2
- data/spec/models/inventory_coupon_spec.rb +26 -2
- data/spec/models/inventory_referral_spec.rb +119 -0
- data/spec/models/item_attribute_spec.rb +53 -0
- data/spec/models/ledger_entry_spec.rb +2 -2
- data/spec/models/ledger_info_spec.rb +83 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +111 -0
- data/spec/models/library_attribute_spec.rb +2 -2
- data/spec/models/limit_config_spec.rb +12 -2
- data/spec/models/limit_counter_spec.rb +125 -0
- data/spec/models/login_params_spec.rb +2 -2
- data/spec/models/loyalty_balance_spec.rb +59 -0
- data/spec/models/loyalty_balances_spec.rb +47 -0
- data/spec/models/loyalty_card_profile_registration_spec.rb +47 -0
- data/spec/models/loyalty_card_registration_spec.rb +41 -0
- data/spec/models/loyalty_card_spec.rb +107 -0
- data/spec/models/loyalty_dashboard_data_spec.rb +89 -0
- data/spec/models/loyalty_dashboard_points_breakdown_spec.rb +47 -0
- data/spec/models/loyalty_ledger_entry_spec.rb +14 -2
- data/spec/models/loyalty_ledger_spec.rb +2 -2
- data/spec/models/loyalty_ledger_transactions_spec.rb +47 -0
- data/spec/models/loyalty_membership_spec.rb +2 -2
- data/spec/models/loyalty_program_balance_spec.rb +8 -2
- data/spec/models/loyalty_program_entity_spec.rb +2 -2
- data/spec/models/loyalty_program_ledgers_spec.rb +2 -2
- data/spec/models/loyalty_program_spec.rb +39 -9
- data/spec/models/loyalty_program_transaction_spec.rb +141 -0
- data/spec/models/loyalty_spec.rb +8 -2
- data/spec/models/loyalty_statistics_spec.rb +32 -2
- data/spec/models/loyalty_sub_ledger_spec.rb +8 -2
- data/spec/models/loyalty_tier_spec.rb +2 -2
- data/spec/models/management_key_spec.rb +83 -0
- data/spec/models/manager_config_spec.rb +2 -2
- data/spec/models/meta_spec.rb +2 -2
- data/spec/models/model_return_spec.rb +101 -0
- data/spec/models/multi_application_entity_spec.rb +2 -2
- data/spec/models/multiple_attribute_spec.rb +41 -0
- data/spec/models/multiple_audiences_item_spec.rb +69 -0
- data/spec/models/multiple_audiences_spec.rb +47 -0
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +2 -2
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +2 -2
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +2 -2
- data/spec/models/multiple_new_attribute_spec.rb +41 -0
- data/spec/models/multiple_new_audiences_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +2 -2
- data/spec/models/new_account_sign_up_spec.rb +2 -2
- data/spec/models/new_account_spec.rb +2 -2
- data/spec/models/new_additional_cost_spec.rb +12 -2
- data/spec/models/new_application_api_key_spec.rb +3 -3
- data/spec/models/new_application_spec.rb +18 -2
- data/spec/models/new_attribute_spec.rb +30 -2
- data/spec/models/new_audience_spec.rb +26 -6
- data/spec/models/new_base_notification_spec.rb +47 -0
- data/spec/models/new_campaign_collection_spec.rb +47 -0
- data/spec/models/new_campaign_group_spec.rb +2 -2
- data/spec/models/new_campaign_set_spec.rb +2 -2
- data/spec/models/new_campaign_set_v2_spec.rb +53 -0
- data/spec/models/new_campaign_spec.rb +3 -3
- data/spec/models/new_campaign_template_spec.rb +127 -0
- data/spec/models/new_catalog_spec.rb +53 -0
- data/spec/models/new_collection_spec.rb +53 -0
- data/spec/models/new_coupon_creation_job_spec.rb +83 -0
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +8 -2
- data/spec/models/new_coupons_spec.rb +20 -2
- data/spec/models/new_custom_effect_spec.rb +14 -8
- data/spec/models/new_customer_profile_spec.rb +2 -2
- data/spec/models/new_customer_session_spec.rb +3 -3
- data/spec/models/new_customer_session_v2_spec.rb +15 -3
- data/spec/models/new_event_spec.rb +2 -2
- data/spec/models/new_event_type_spec.rb +2 -52
- data/spec/models/new_giveaways_pool_spec.rb +8 -2
- data/spec/models/new_internal_audience_spec.rb +53 -0
- data/spec/models/new_invitation_spec.rb +2 -2
- data/spec/models/new_invite_email_spec.rb +2 -2
- data/spec/models/new_loyalty_program_spec.rb +38 -8
- data/spec/models/new_loyalty_tier_spec.rb +2 -2
- data/spec/models/new_management_key_spec.rb +89 -0
- data/spec/models/new_multiple_audiences_item_spec.rb +47 -0
- data/spec/models/new_notification_webhook_spec.rb +47 -0
- data/spec/models/new_password_email_spec.rb +2 -2
- data/spec/models/new_password_spec.rb +2 -2
- data/spec/models/new_picklist_spec.rb +51 -0
- data/spec/models/new_referral_spec.rb +2 -2
- data/spec/models/new_referrals_for_multiple_advocates_spec.rb +2 -2
- data/spec/models/new_return_spec.rb +41 -0
- data/spec/models/new_role_spec.rb +3 -3
- data/spec/models/new_ruleset_spec.rb +8 -2
- data/spec/models/new_saml_connection_spec.rb +2 -2
- data/spec/models/new_template_def_spec.rb +2 -2
- data/spec/models/new_user_spec.rb +2 -2
- data/spec/models/new_webhook_spec.rb +2 -2
- data/spec/models/notification_spec.rb +2 -2
- data/spec/models/notification_webhook_spec.rb +71 -0
- data/spec/models/outgoing_integration_braze_policy_spec.rb +47 -0
- data/spec/models/outgoing_integration_configuration_spec.rb +53 -0
- data/spec/models/outgoing_integration_type_spec.rb +65 -0
- data/spec/models/outgoing_integration_types_spec.rb +41 -0
- data/spec/models/outgoing_integration_webhook_template_spec.rb +65 -0
- data/spec/models/outgoing_integration_webhook_templates_spec.rb +41 -0
- data/spec/models/patch_item_catalog_action_spec.rb +59 -0
- data/spec/models/patch_many_items_catalog_action_spec.rb +53 -0
- data/spec/models/picklist_spec.rb +87 -0
- data/spec/models/priority_position_spec.rb +51 -0
- data/spec/models/profile_audiences_changes_spec.rb +2 -2
- data/spec/models/redeem_referral_effect_props_spec.rb +2 -2
- data/spec/models/referral_constraints_spec.rb +2 -2
- data/spec/models/referral_created_effect_props_spec.rb +2 -2
- data/spec/models/referral_rejection_reason_spec.rb +3 -3
- data/spec/models/referral_spec.rb +2 -2
- data/spec/models/reject_coupon_effect_props_spec.rb +2 -2
- data/spec/models/reject_referral_effect_props_spec.rb +2 -2
- data/spec/models/remove_item_catalog_action_spec.rb +41 -0
- data/spec/models/remove_many_items_catalog_action_spec.rb +41 -0
- data/spec/models/reserve_coupon_effect_props_spec.rb +53 -0
- data/spec/models/return_integration_request_spec.rb +51 -0
- data/spec/models/returned_cart_item_spec.rb +47 -0
- data/spec/models/role_assign_spec.rb +2 -2
- data/spec/models/role_membership_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/role_v2_application_details_spec.rb +53 -0
- data/spec/models/role_v2_permission_set_spec.rb +47 -0
- data/spec/models/role_v2_permissions_roles_spec.rb +53 -0
- data/spec/models/role_v2_permissions_spec.rb +47 -0
- data/spec/models/role_v2_spec.rb +65 -0
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +20 -2
- data/spec/models/rollback_coupon_effect_props_spec.rb +2 -2
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +8 -2
- data/spec/models/rollback_discount_effect_props_spec.rb +32 -2
- data/spec/models/rollback_referral_effect_props_spec.rb +2 -2
- data/spec/models/rule_failure_reason_spec.rb +2 -2
- data/spec/models/rule_spec.rb +14 -2
- data/spec/models/ruleset_spec.rb +17 -5
- data/spec/models/saml_connection_metadata_spec.rb +2 -2
- data/spec/models/saml_connection_spec.rb +2 -2
- data/spec/models/saml_login_endpoint_spec.rb +2 -2
- data/spec/models/session_spec.rb +2 -2
- data/spec/models/set_discount_effect_props_spec.rb +8 -2
- data/spec/models/set_discount_per_additional_cost_effect_props_spec.rb +65 -0
- data/spec/models/set_discount_per_additional_cost_per_item_effect_props_spec.rb +77 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +38 -2
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +2 -2
- data/spec/models/show_notification_effect_props_spec.rb +2 -2
- data/spec/models/slot_def_spec.rb +2 -2
- data/spec/models/strikethrough_changed_item_spec.rb +77 -0
- data/spec/models/strikethrough_effect_spec.rb +71 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +65 -0
- data/spec/models/strikethrough_set_discount_per_item_effect_props_spec.rb +47 -0
- data/spec/models/strikethrough_trigger_spec.rb +65 -0
- data/spec/models/talang_attribute_spec.rb +97 -0
- data/spec/models/talang_attribute_visibility_spec.rb +47 -0
- data/spec/models/template_arg_def_spec.rb +15 -3
- data/spec/models/template_def_spec.rb +2 -2
- data/spec/models/template_limit_config_spec.rb +67 -0
- data/spec/models/tier_spec.rb +47 -0
- data/spec/models/transfer_loyalty_card_spec.rb +41 -0
- data/spec/models/trigger_webhook_effect_props_spec.rb +2 -2
- data/spec/models/update_account_spec.rb +2 -2
- data/spec/models/update_application_spec.rb +18 -2
- data/spec/models/update_attribute_effect_props_spec.rb +2 -2
- data/spec/models/update_audience_spec.rb +2 -2
- data/spec/models/update_campaign_collection_spec.rb +41 -0
- data/spec/models/update_campaign_group_spec.rb +2 -2
- data/spec/models/update_campaign_spec.rb +3 -3
- data/spec/models/update_campaign_template_spec.rb +139 -0
- data/spec/models/update_catalog_spec.rb +53 -0
- data/spec/models/update_collection_spec.rb +47 -0
- data/spec/models/update_coupon_batch_spec.rb +8 -2
- data/spec/models/update_coupon_spec.rb +20 -2
- data/spec/models/update_custom_effect_spec.rb +14 -8
- data/spec/models/update_loyalty_card_spec.rb +41 -0
- data/spec/models/update_loyalty_program_spec.rb +20 -2
- data/spec/models/update_picklist_spec.rb +51 -0
- data/spec/models/update_referral_batch_spec.rb +65 -0
- data/spec/models/update_referral_spec.rb +2 -2
- data/spec/models/update_role_spec.rb +3 -3
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +2 -2
- data/spec/models/update_user_spec.rb +2 -2
- data/spec/models/user_entity_spec.rb +2 -2
- data/spec/models/user_feed_notifications_spec.rb +2 -2
- data/spec/models/user_spec.rb +2 -2
- data/spec/models/webhook_activation_log_entry_spec.rb +2 -2
- data/spec/models/webhook_log_entry_spec.rb +2 -2
- data/spec/models/webhook_spec.rb +2 -2
- data/spec/models/will_award_giveaway_effect_props_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- data/talon_one.gemspec +2 -2
- metadata +828 -243
- data/docs/ApplicationCustomerSearch.md +0 -21
- data/docs/FeatureFlags.md +0 -23
- data/docs/LoyaltyPoints.md +0 -25
- data/docs/NewFeatureFlags.md +0 -21
- data/docs/UpdateLoyaltyTier.md +0 -19
- data/spec/models/application_customer_search_spec.rb +0 -53
- data/spec/models/feature_flags_spec.rb +0 -59
- data/spec/models/loyalty_points_spec.rb +0 -65
- data/spec/models/new_feature_flags_spec.rb +0 -53
- data/spec/models/update_loyalty_tier_spec.rb +0 -47
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# TalonOne::NewCampaignTemplate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | The campaign template name. |
|
|
8
|
+
**description** | **String** | Customer-facing text that explains the objective of the template. |
|
|
9
|
+
**instructions** | **String** | Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign. |
|
|
10
|
+
**campaign_attributes** | [**Object**](.md) | The campaign attributes that campaigns created from this template will have by default. | [optional]
|
|
11
|
+
**coupon_attributes** | [**Object**](.md) | The campaign attributes that coupons created from this template will have by default. | [optional]
|
|
12
|
+
**state** | **String** | Only Campaign Templates in 'available' state may be used to create Campaigns. |
|
|
13
|
+
**tags** | **Array<String>** | A list of tags for the campaign template. | [optional]
|
|
14
|
+
**features** | **Array<String>** | A list of features for the campaign template. | [optional]
|
|
15
|
+
**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
16
|
+
**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
17
|
+
**limits** | [**Array<TemplateLimitConfig>**](TemplateLimitConfig.md) | The set of limits that will operate for this campaign template. | [optional]
|
|
18
|
+
**template_params** | [**Array<CampaignTemplateParams>**](CampaignTemplateParams.md) | Fields which can be used to replace values in a rule. | [optional]
|
|
19
|
+
**campaign_collections** | [**Array<CampaignTemplateCollection>**](CampaignTemplateCollection.md) | The campaign collections from the blueprint campaign for the template. | [optional]
|
|
20
|
+
**default_campaign_group_id** | **Integer** | The default campaign group ID. | [optional]
|
|
21
|
+
|
|
22
|
+
## Code Sample
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'TalonOne'
|
|
26
|
+
|
|
27
|
+
instance = TalonOne::NewCampaignTemplate.new(name: null,
|
|
28
|
+
description: null,
|
|
29
|
+
instructions: null,
|
|
30
|
+
campaign_attributes: null,
|
|
31
|
+
coupon_attributes: null,
|
|
32
|
+
state: null,
|
|
33
|
+
tags: null,
|
|
34
|
+
features: null,
|
|
35
|
+
coupon_settings: null,
|
|
36
|
+
referral_settings: null,
|
|
37
|
+
limits: null,
|
|
38
|
+
template_params: null,
|
|
39
|
+
campaign_collections: null,
|
|
40
|
+
default_campaign_group_id: 42)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
|
data/docs/NewCatalog.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::NewCatalog
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | The cart item catalog name. |
|
|
8
|
+
**description** | **String** | A description of this cart item catalog. |
|
|
9
|
+
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this catalog. | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::NewCatalog.new(name: seafood,
|
|
17
|
+
description: seafood catalog,
|
|
18
|
+
subscribed_applications_ids: [1, 2, 3])
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::NewCollection
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**description** | **String** | A short description of the purpose of this collection. | [optional]
|
|
8
|
+
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the Applications where this collection is enabled. | [optional]
|
|
9
|
+
**name** | **String** | The name of this collection. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::NewCollection.new(description: My collection of SKUs,
|
|
17
|
+
subscribed_applications_ids: [1, 2, 3],
|
|
18
|
+
name: My collection)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# TalonOne::NewCouponCreationJob
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
|
|
8
|
+
**discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
|
|
9
|
+
**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
|
|
10
|
+
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
11
|
+
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
|
|
12
|
+
**number_of_coupons** | **Integer** | The number of new coupon codes to generate for the campaign. |
|
|
13
|
+
**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
14
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with coupons. |
|
|
15
|
+
|
|
16
|
+
## Code Sample
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'TalonOne'
|
|
20
|
+
|
|
21
|
+
instance = TalonOne::NewCouponCreationJob.new(usage_limit: 100,
|
|
22
|
+
discount_limit: 30.0,
|
|
23
|
+
reservation_limit: 45,
|
|
24
|
+
start_date: 2020-01-24T14:15:22Z,
|
|
25
|
+
expiry_date: 2023-08-24T14:15:22Z,
|
|
26
|
+
number_of_coupons: 200000,
|
|
27
|
+
coupon_settings: null,
|
|
28
|
+
attributes: null)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
|
data/docs/NewCoupons.md
CHANGED
|
@@ -4,32 +4,38 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**usage_limit** | **Integer** | The number of times
|
|
8
|
-
**discount_limit** | **Float** | The
|
|
7
|
+
**usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
|
|
8
|
+
**discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
|
|
9
|
+
**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
|
|
9
10
|
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
10
|
-
**expiry_date** | **DateTime** |
|
|
11
|
+
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
|
|
12
|
+
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional]
|
|
11
13
|
**number_of_coupons** | **Integer** | The number of new coupon codes to generate for the campaign. Must be at least 1. |
|
|
12
|
-
**unique_prefix** | **String** |
|
|
13
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
14
|
-
**recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile | [optional]
|
|
15
|
-
**valid_characters** | **Array<String>** |
|
|
16
|
-
**coupon_pattern** | **String** | The pattern
|
|
14
|
+
**unique_prefix** | **String** | **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously](https://docs.talon.one/management-api#operation/createCouponsAsync) endpoint. | [optional]
|
|
15
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
16
|
+
**recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional]
|
|
17
|
+
**valid_characters** | **Array<String>** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional]
|
|
18
|
+
**coupon_pattern** | **String** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional]
|
|
19
|
+
**is_reservation_mandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to true]
|
|
17
20
|
|
|
18
21
|
## Code Sample
|
|
19
22
|
|
|
20
23
|
```ruby
|
|
21
24
|
require 'TalonOne'
|
|
22
25
|
|
|
23
|
-
instance = TalonOne::NewCoupons.new(usage_limit:
|
|
24
|
-
discount_limit:
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
26
|
+
instance = TalonOne::NewCoupons.new(usage_limit: 100,
|
|
27
|
+
discount_limit: 30.0,
|
|
28
|
+
reservation_limit: 45,
|
|
29
|
+
start_date: 2020-01-24T14:15:22Z,
|
|
30
|
+
expiry_date: 2023-08-24T14:15:22Z,
|
|
31
|
+
limits: null,
|
|
32
|
+
number_of_coupons: 1,
|
|
33
|
+
unique_prefix: ,
|
|
34
|
+
attributes: {"venueId":12},
|
|
35
|
+
recipient_integration_id: URNGV8294NV,
|
|
36
|
+
valid_characters: [A, B, G, Y],
|
|
37
|
+
coupon_pattern: SUMMER-#####,
|
|
38
|
+
is_reservation_mandatory: false)
|
|
33
39
|
```
|
|
34
40
|
|
|
35
41
|
|
|
@@ -4,28 +4,30 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**usage_limit** | **Integer** | The number of times
|
|
8
|
-
**discount_limit** | **Float** | The
|
|
7
|
+
**usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. |
|
|
8
|
+
**discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
|
|
9
|
+
**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
|
|
9
10
|
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
10
|
-
**expiry_date** | **DateTime** |
|
|
11
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
12
|
-
**recipients_integration_ids** | **Array<String>** | The integration IDs for recipients |
|
|
13
|
-
**valid_characters** | **Array<String>** |
|
|
14
|
-
**coupon_pattern** | **String** | The pattern
|
|
11
|
+
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
|
|
12
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
13
|
+
**recipients_integration_ids** | **Array<String>** | The integration IDs for recipients. |
|
|
14
|
+
**valid_characters** | **Array<String>** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional]
|
|
15
|
+
**coupon_pattern** | **String** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | [optional]
|
|
15
16
|
|
|
16
17
|
## Code Sample
|
|
17
18
|
|
|
18
19
|
```ruby
|
|
19
20
|
require 'TalonOne'
|
|
20
21
|
|
|
21
|
-
instance = TalonOne::NewCouponsForMultipleRecipients.new(usage_limit:
|
|
22
|
-
discount_limit:
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
22
|
+
instance = TalonOne::NewCouponsForMultipleRecipients.new(usage_limit: 100,
|
|
23
|
+
discount_limit: 30.0,
|
|
24
|
+
reservation_limit: 45,
|
|
25
|
+
start_date: 2020-01-24T14:15:22Z,
|
|
26
|
+
expiry_date: 2023-08-24T14:15:22Z,
|
|
27
|
+
attributes: {"venueId":12},
|
|
28
|
+
recipients_integration_ids: [URNGV8294NV, BZGGC2454PA],
|
|
29
|
+
valid_characters: [A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z],
|
|
30
|
+
coupon_pattern: SUMMER-#####)
|
|
29
31
|
```
|
|
30
32
|
|
|
31
33
|
|
data/docs/NewCustomEffect.md
CHANGED
|
@@ -4,25 +4,27 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. |
|
|
8
|
+
**is_per_item** | **Boolean** | Indicates if this effect is per item or not. | [optional]
|
|
7
9
|
**name** | **String** | The name of this effect. |
|
|
8
10
|
**title** | **String** | The title of this effect. |
|
|
9
11
|
**payload** | **String** | The JSON payload of this effect. |
|
|
10
12
|
**description** | **String** | The description of this effect. | [optional]
|
|
11
13
|
**enabled** | **Boolean** | Determines if this effect is active. |
|
|
12
|
-
**
|
|
13
|
-
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions | [optional]
|
|
14
|
+
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions. | [optional]
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
17
18
|
```ruby
|
|
18
19
|
require 'TalonOne'
|
|
19
20
|
|
|
20
|
-
instance = TalonOne::NewCustomEffect.new(
|
|
21
|
+
instance = TalonOne::NewCustomEffect.new(application_ids: null,
|
|
22
|
+
is_per_item: null,
|
|
23
|
+
name: null,
|
|
21
24
|
title: null,
|
|
22
25
|
payload: null,
|
|
23
26
|
description: null,
|
|
24
27
|
enabled: null,
|
|
25
|
-
subscribed_applications_ids: null,
|
|
26
28
|
params: null)
|
|
27
29
|
```
|
|
28
30
|
|
data/docs/NewCustomerProfile.md
CHANGED
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
7
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'TalonOne'
|
|
13
13
|
|
|
14
|
-
instance = TalonOne::NewCustomerProfile.new(attributes:
|
|
14
|
+
instance = TalonOne::NewCustomerProfile.new(attributes: {"Language":"english","ShippingCountry":"DE"})
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
|
data/docs/NewCustomerSession.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**profile_id** | **String** | ID of the
|
|
7
|
+
**profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
|
|
8
8
|
**coupon** | **String** | Any coupon code entered. | [optional]
|
|
9
9
|
**referral** | **String** | Any referral code entered. | [optional]
|
|
10
|
-
**state** | **String** | Indicates the current state of the session.
|
|
10
|
+
**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | [optional] [default to 'open']
|
|
11
11
|
**cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. | [optional]
|
|
12
|
-
**identifiers** | **Array<String>** |
|
|
12
|
+
**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). | [optional]
|
|
13
13
|
**total** | **Float** | The total sum of the cart in one session. | [optional]
|
|
14
14
|
**attributes** | [**Object**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. | [optional]
|
|
15
15
|
|
|
@@ -18,12 +18,12 @@ Name | Type | Description | Notes
|
|
|
18
18
|
```ruby
|
|
19
19
|
require 'TalonOne'
|
|
20
20
|
|
|
21
|
-
instance = TalonOne::NewCustomerSession.new(profile_id:
|
|
22
|
-
coupon:
|
|
23
|
-
referral:
|
|
24
|
-
state:
|
|
21
|
+
instance = TalonOne::NewCustomerSession.new(profile_id: URNGV8294NV,
|
|
22
|
+
coupon: XMAS-2021,
|
|
23
|
+
referral: 2740-tbjua-6720,
|
|
24
|
+
state: open,
|
|
25
25
|
cart_items: null,
|
|
26
|
-
identifiers:
|
|
26
|
+
identifiers: [91.11.156.141],
|
|
27
27
|
total: null,
|
|
28
28
|
attributes: null)
|
|
29
29
|
```
|
|
@@ -4,28 +4,32 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**profile_id** | **String** | ID of the
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**
|
|
13
|
-
**
|
|
14
|
-
**
|
|
7
|
+
**profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
|
|
8
|
+
**evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional]
|
|
9
|
+
**coupon_codes** | **Array<String>** | Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional]
|
|
10
|
+
**referral_code** | **String** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional]
|
|
11
|
+
**loyalty_cards** | **Array<String>** | Any loyalty cards used. | [optional]
|
|
12
|
+
**state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). | [optional] [default to 'open']
|
|
13
|
+
**cart_items** | [**Array<CartItem>**](CartItem.md) | The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | [optional]
|
|
14
|
+
**additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional]
|
|
15
|
+
**identifiers** | **Array<String>** | Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). | [optional]
|
|
16
|
+
**attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property. | [optional]
|
|
15
17
|
|
|
16
18
|
## Code Sample
|
|
17
19
|
|
|
18
20
|
```ruby
|
|
19
21
|
require 'TalonOne'
|
|
20
22
|
|
|
21
|
-
instance = TalonOne::NewCustomerSessionV2.new(profile_id:
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
instance = TalonOne::NewCustomerSessionV2.new(profile_id: URNGV8294NV,
|
|
24
|
+
evaluable_campaign_ids: [10, 12],
|
|
25
|
+
coupon_codes: [XMAS-20-2021],
|
|
26
|
+
referral_code: NT2K54D9,
|
|
27
|
+
loyalty_cards: [loyalty-card-1],
|
|
28
|
+
state: open,
|
|
25
29
|
cart_items: null,
|
|
26
|
-
additional_costs:
|
|
27
|
-
identifiers:
|
|
28
|
-
attributes:
|
|
30
|
+
additional_costs: {"shipping":{"price":9}},
|
|
31
|
+
identifiers: [91.11.156.141],
|
|
32
|
+
attributes: {"ShippingCity":"Berlin"})
|
|
29
33
|
```
|
|
30
34
|
|
|
31
35
|
|
data/docs/NewEvent.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**profile_id** | **String** | ID of the
|
|
7
|
+
**profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
|
|
8
8
|
**type** | **String** | A string representing the event. Must not be a reserved event name. |
|
|
9
9
|
**attributes** | [**Object**](.md) | Arbitrary additional JSON data associated with the event. |
|
|
10
10
|
**session_id** | **String** | The ID of the session that this event occurred in. |
|
|
@@ -14,10 +14,10 @@ Name | Type | Description | Notes
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'TalonOne'
|
|
16
16
|
|
|
17
|
-
instance = TalonOne::NewEvent.new(profile_id:
|
|
18
|
-
type:
|
|
19
|
-
attributes:
|
|
20
|
-
session_id:
|
|
17
|
+
instance = TalonOne::NewEvent.new(profile_id: URNGV8294NV,
|
|
18
|
+
type: pageViewed,
|
|
19
|
+
attributes: {"myAttribute":"myValue"},
|
|
20
|
+
session_id: 175KJPS947296)
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
|
data/docs/NewEventType.md
CHANGED
|
@@ -4,32 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**description** | **String** | An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway. |
|
|
11
|
-
**mime_type** | **String** | This defines how the request payload will be parsed before your handler code is run. |
|
|
12
|
-
**example_payload** | **String** | It is often helpful to include an example payload with the event type definition for documentation purposes. | [optional]
|
|
13
|
-
**schema** | [**Object**](.md) | It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing. | [optional]
|
|
14
|
-
**handler_language** | **String** | The language of the handler code. Currently only `\"talang\"` is supported. | [optional]
|
|
15
|
-
**handler** | **String** | Code that will be run after successful parsing & validation of the payload for this event. This code _may_ choose to evaluate campaign rules. |
|
|
16
|
-
**version** | **Integer** | The version of this event type. When updating an existing event type this must be **exactly** `currentVersion + 1`. |
|
|
7
|
+
**title** | **String** | The human-friendly name for this event type. |
|
|
8
|
+
**name** | **String** | The integration name for this event type. This will be used in URLs and cannot be changed after an event type has been created. |
|
|
9
|
+
**description** | **String** | A description of what the event represents. | [optional]
|
|
17
10
|
|
|
18
11
|
## Code Sample
|
|
19
12
|
|
|
20
13
|
```ruby
|
|
21
14
|
require 'TalonOne'
|
|
22
15
|
|
|
23
|
-
instance = TalonOne::NewEventType.new(
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
description: null,
|
|
27
|
-
mime_type: null,
|
|
28
|
-
example_payload: null,
|
|
29
|
-
schema: null,
|
|
30
|
-
handler_language: null,
|
|
31
|
-
handler: null,
|
|
32
|
-
version: null)
|
|
16
|
+
instance = TalonOne::NewEventType.new(title: Survey Completed,
|
|
17
|
+
name: surveyCompleted,
|
|
18
|
+
description: The survey was submitted by the customer.)
|
|
33
19
|
```
|
|
34
20
|
|
|
35
21
|
|
data/docs/NewGiveawaysPool.md
CHANGED
|
@@ -6,16 +6,18 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The name of this giveaways pool. |
|
|
8
8
|
**description** | **String** | The description of this giveaways pool. | [optional]
|
|
9
|
-
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this giveaways pool is enabled for | [optional]
|
|
9
|
+
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this giveaways pool is enabled for. | [optional]
|
|
10
|
+
**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. |
|
|
10
11
|
|
|
11
12
|
## Code Sample
|
|
12
13
|
|
|
13
14
|
```ruby
|
|
14
15
|
require 'TalonOne'
|
|
15
16
|
|
|
16
|
-
instance = TalonOne::NewGiveawaysPool.new(name:
|
|
17
|
-
description:
|
|
18
|
-
subscribed_applications_ids:
|
|
17
|
+
instance = TalonOne::NewGiveawaysPool.new(name: My giveaway pool,
|
|
18
|
+
description: Generic pool,
|
|
19
|
+
subscribed_applications_ids: [2, 4],
|
|
20
|
+
sandbox: true)
|
|
19
21
|
```
|
|
20
22
|
|
|
21
23
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::NewInternalAudience
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | The human-friendly display name for this audience. |
|
|
8
|
+
**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
|
|
9
|
+
**description** | **String** | A description of the audience. | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::NewInternalAudience.new(name: Travel audience,
|
|
17
|
+
sandbox: true,
|
|
18
|
+
description: Travel audience 18-25)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/NewInvitation.md
CHANGED
|
@@ -6,17 +6,17 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Name of the user being invited. | [optional]
|
|
8
8
|
**email** | **String** | |
|
|
9
|
-
**acl** | **String** |
|
|
10
|
-
**roles** | **Array<Integer>** | An array of roleIDs to assign the new user to | [optional]
|
|
9
|
+
**acl** | **String** | The `Access Control List` json defining the role of the user. This represents the access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` |
|
|
10
|
+
**roles** | **Array<Integer>** | An array of roleIDs to assign the new user to. | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'TalonOne'
|
|
16
16
|
|
|
17
|
-
instance = TalonOne::NewInvitation.new(name:
|
|
18
|
-
email:
|
|
19
|
-
acl:
|
|
17
|
+
instance = TalonOne::NewInvitation.new(name: John Doe,
|
|
18
|
+
email: john.doe@example.com,
|
|
19
|
+
acl: {"Role":0},
|
|
20
20
|
roles: null)
|
|
21
21
|
```
|
|
22
22
|
|
data/docs/NewLoyaltyProgram.md
CHANGED
|
@@ -4,26 +4,36 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**name** | **String** | The internal name for the Loyalty Program. This is an immutable value. |
|
|
8
7
|
**title** | **String** | The display title for the Loyalty Program. |
|
|
9
8
|
**description** | **String** | Description of our Loyalty Program. | [optional]
|
|
10
9
|
**subscribed_applications** | **Array<Integer>** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional]
|
|
11
|
-
**default_validity** | **String** |
|
|
12
|
-
**default_pending** | **String** |
|
|
13
|
-
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program |
|
|
10
|
+
**default_validity** | **String** | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. |
|
|
11
|
+
**default_pending** | **String** | The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. |
|
|
12
|
+
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. |
|
|
13
|
+
**users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
|
|
14
|
+
**sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. |
|
|
15
|
+
**name** | **String** | The internal name for the Loyalty Program. This is an immutable value. |
|
|
16
|
+
**tiers** | [**Array<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional]
|
|
17
|
+
**timezone** | **String** | A string containing an IANA timezone descriptor. |
|
|
18
|
+
**card_based** | **Boolean** | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. | [default to false]
|
|
14
19
|
|
|
15
20
|
## Code Sample
|
|
16
21
|
|
|
17
22
|
```ruby
|
|
18
23
|
require 'TalonOne'
|
|
19
24
|
|
|
20
|
-
instance = TalonOne::NewLoyaltyProgram.new(
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
25
|
+
instance = TalonOne::NewLoyaltyProgram.new(title: Point collection,
|
|
26
|
+
description: Customers collect 10 points per 1$ spent,
|
|
27
|
+
subscribed_applications: [132, 97],
|
|
28
|
+
default_validity: 2W_U,
|
|
29
|
+
default_pending: immediate,
|
|
30
|
+
allow_subledger: false,
|
|
31
|
+
users_per_card_limit: 111,
|
|
32
|
+
sandbox: true,
|
|
33
|
+
name: GeneralPointCollection,
|
|
34
|
+
tiers: null,
|
|
35
|
+
timezone: null,
|
|
36
|
+
card_based: true)
|
|
27
37
|
```
|
|
28
38
|
|
|
29
39
|
|
data/docs/NewLoyaltyTier.md
CHANGED
|
@@ -5,15 +5,15 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The name of the tier |
|
|
8
|
-
**min_points** | **Float** | The minimum amount of points required to be eligible for the tier |
|
|
8
|
+
**min_points** | **Float** | The minimum amount of points required to be eligible for the tier. |
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'TalonOne'
|
|
14
14
|
|
|
15
|
-
instance = TalonOne::NewLoyaltyTier.new(name:
|
|
16
|
-
min_points:
|
|
15
|
+
instance = TalonOne::NewLoyaltyTier.new(name: Gold,
|
|
16
|
+
min_points: 300.0)
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# TalonOne::NewManagementKey
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | Name for management key. |
|
|
8
|
+
**expiry_date** | **DateTime** | The date the management key expires. |
|
|
9
|
+
**endpoints** | [**Array<Endpoint>**](Endpoint.md) | The list of endpoints that can be accessed with the key |
|
|
10
|
+
**allowed_application_ids** | **Array<Integer>** | A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account. | [optional]
|
|
11
|
+
**id** | **Integer** | ID of the management key. |
|
|
12
|
+
**created_by** | **Integer** | ID of the user who created it. |
|
|
13
|
+
**account_id** | **Integer** | ID of account the key is used for. |
|
|
14
|
+
**created** | **DateTime** | The date the management key was created. |
|
|
15
|
+
**key** | **String** | The management key. |
|
|
16
|
+
|
|
17
|
+
## Code Sample
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'TalonOne'
|
|
21
|
+
|
|
22
|
+
instance = TalonOne::NewManagementKey.new(name: My generated key,
|
|
23
|
+
expiry_date: 2023-08-24T14:00Z,
|
|
24
|
+
endpoints: null,
|
|
25
|
+
allowed_application_ids: [1, 2, 3],
|
|
26
|
+
id: 34,
|
|
27
|
+
created_by: 280,
|
|
28
|
+
account_id: 13,
|
|
29
|
+
created: 2022-03-02T16:46:17.758585Z,
|
|
30
|
+
key: f45f90d21dcd9bac965c45e547e9754a3196891d09948e35adbcbedc4e9e4b01)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
|