talon_one 2.4.0 → 2.5.1
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 +198 -160
- data/docs/Account.md +3 -3
- data/docs/AccountAdditionalCost.md +6 -4
- data/docs/AccountAnalytics.md +20 -18
- data/docs/AccountEntity.md +1 -1
- data/docs/AddFreeItemEffectProps.md +1 -1
- data/docs/AddLoyaltyPointsEffectProps.md +17 -9
- data/docs/AdditionalCost.md +1 -1
- data/docs/Application.md +22 -18
- data/docs/ApplicationAPIKey.md +9 -9
- data/docs/ApplicationApiHealth.md +1 -1
- data/docs/ApplicationCustomer.md +10 -8
- data/docs/ApplicationCustomerEntity.md +1 -1
- data/docs/ApplicationEntity.md +1 -1
- data/docs/ApplicationEvent.md +4 -4
- data/docs/ApplicationNotification.md +17 -0
- data/docs/ApplicationReferee.md +1 -1
- data/docs/ApplicationSession.md +13 -11
- data/docs/AsyncCouponCreationResponse.md +17 -0
- data/docs/Attribute.md +10 -4
- data/docs/Audience.md +9 -9
- data/docs/BaseLoyaltyProgram.md +29 -0
- data/docs/Binding.md +6 -4
- data/docs/BulkApplicationNotification.md +19 -0
- data/docs/BulkCampaignNotification.md +19 -0
- data/docs/Campaign.md +26 -18
- data/docs/CampaignCollection.md +37 -0
- data/docs/CampaignCollectionWithoutPayload.md +35 -0
- data/docs/CampaignCopy.md +2 -2
- data/docs/CampaignCreatedNotification.md +17 -0
- data/docs/CampaignDeletedNotification.md +17 -0
- data/docs/CampaignEditedNotification.md +19 -0
- data/docs/CampaignEntity.md +1 -1
- data/docs/CampaignGroup.md +4 -4
- 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/CampaignSet.md +3 -3
- data/docs/CampaignSetIDs.md +17 -0
- data/docs/CampaignSetV2.md +25 -0
- data/docs/CampaignStateChangedNotification.md +21 -0
- data/docs/CampaignTemplate.md +59 -0
- data/docs/CampaignTemplateCollection.md +19 -0
- data/docs/CampaignTemplateParams.md +21 -0
- data/docs/CartItem.md +20 -14
- data/docs/Catalog.md +33 -0
- data/docs/Change.md +2 -2
- data/docs/CodeGeneratorSettings.md +4 -4
- data/docs/Collection.md +39 -0
- data/docs/CollectionWithoutPayload.md +37 -0
- data/docs/Coupon.md +17 -15
- data/docs/CouponConstraints.md +3 -3
- data/docs/CouponCreationJob.md +57 -0
- data/docs/CouponLimitConfigs.md +17 -0
- data/docs/CouponRejectionReason.md +3 -3
- data/docs/CouponReservations.md +1 -1
- data/docs/CouponValue.md +2 -2
- data/docs/CreateApplicationAPIKey.md +4 -4
- data/docs/CreateTemplateCampaign.md +29 -0
- data/docs/CreateTemplateCampaignResponse.md +21 -0
- data/docs/CustomEffect.md +6 -6
- data/docs/CustomEffectProps.md +4 -2
- data/docs/CustomerActivityReport.md +2 -2
- data/docs/CustomerInventory.md +2 -2
- data/docs/CustomerProfile.md +11 -9
- data/docs/CustomerProfileAudienceRequestItem.md +6 -6
- data/docs/CustomerProfileIntegrationRequestV2.md +3 -3
- data/docs/CustomerProfileSearchQuery.md +1 -1
- data/docs/CustomerSession.md +10 -8
- data/docs/CustomerSessionV2.md +26 -20
- data/docs/DeductLoyaltyPointsEffectProps.md +5 -1
- data/docs/Effect.md +6 -6
- data/docs/EffectEntity.md +6 -6
- data/docs/EmailEntity.md +1 -1
- data/docs/Entity.md +2 -2
- data/docs/Environment.md +7 -5
- data/docs/ErrorResponseWithStatus.md +21 -0
- data/docs/Event.md +10 -10
- data/docs/EventType.md +4 -18
- data/docs/EventV2.md +21 -0
- data/docs/Export.md +3 -3
- data/docs/Giveaway.md +3 -3
- data/docs/GiveawaysPool.md +3 -3
- data/docs/Import.md +7 -7
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +2 -4
- data/docs/InlineResponse20012.md +3 -3
- data/docs/InlineResponse20013.md +4 -2
- data/docs/InlineResponse20014.md +1 -1
- data/docs/InlineResponse20015.md +2 -2
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +2 -2
- data/docs/InlineResponse20018.md +3 -3
- data/docs/InlineResponse20019.md +3 -5
- data/docs/InlineResponse20020.md +5 -3
- data/docs/InlineResponse20021.md +4 -2
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +1 -1
- data/docs/InlineResponse20027.md +2 -4
- data/docs/InlineResponse20028.md +1 -1
- data/docs/InlineResponse20029.md +4 -2
- data/docs/InlineResponse20030.md +19 -0
- data/docs/InlineResponse20031.md +19 -0
- data/docs/InlineResponse2008.md +5 -3
- data/docs/InlineResponse2009.md +4 -2
- data/docs/IntegrationApi.md +462 -179
- data/docs/IntegrationCustomerSessionResponse.md +17 -0
- data/docs/IntegrationEntity.md +2 -2
- data/docs/IntegrationEvent.md +4 -4
- data/docs/IntegrationEventV2Request.md +23 -0
- data/docs/IntegrationProfileEntity.md +2 -2
- data/docs/IntegrationRequest.md +2 -2
- data/docs/IntegrationStateV2.md +6 -2
- data/docs/InventoryCoupon.md +19 -17
- data/docs/InventoryReferral.md +43 -0
- data/docs/LedgerEntry.md +6 -6
- data/docs/LedgerInfo.md +31 -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/LoyaltyCard.md +35 -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 +1 -1
- data/docs/LoyaltyLedgerEntry.md +3 -1
- data/docs/LoyaltyMembership.md +1 -1
- data/docs/LoyaltyProgram.md +21 -13
- data/docs/LoyaltyProgramBalance.md +10 -10
- data/docs/LoyaltyProgramEntity.md +1 -1
- data/docs/LoyaltyProgramLedgers.md +5 -5
- data/docs/LoyaltyProjection.md +21 -0
- data/docs/LoyaltyProjectionData.md +23 -0
- data/docs/LoyaltyStatistics.md +16 -6
- data/docs/LoyaltySubLedger.md +13 -11
- data/docs/LoyaltyTier.md +5 -5
- data/docs/ManagementApi.md +1627 -1247
- data/docs/ModelReturn.md +37 -0
- data/docs/MultipleAttribute.md +17 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +3 -3
- data/docs/MultipleNewAttribute.md +17 -0
- data/docs/MutableEntity.md +1 -1
- data/docs/NewAccountSignUp.md +2 -2
- data/docs/NewAdditionalCost.md +3 -1
- data/docs/NewApplication.md +18 -14
- data/docs/NewApplicationAPIKey.md +11 -11
- data/docs/NewAttribute.md +4 -0
- data/docs/NewAudience.md +6 -6
- data/docs/NewCampaign.md +14 -14
- data/docs/NewCampaignCollection.md +19 -0
- data/docs/NewCampaignSet.md +1 -1
- data/docs/NewCampaignSetV2.md +21 -0
- data/docs/NewCampaignTemplate.md +41 -0
- data/docs/NewCatalog.md +21 -0
- data/docs/NewCollection.md +21 -0
- data/docs/NewCouponCreationJob.md +29 -0
- data/docs/NewCoupons.md +12 -10
- data/docs/NewCouponsForMultipleRecipients.md +5 -5
- data/docs/NewCustomEffect.md +3 -3
- data/docs/NewCustomerProfile.md +1 -1
- data/docs/NewCustomerSession.md +5 -5
- data/docs/NewCustomerSessionV2.md +17 -15
- data/docs/NewEvent.md +5 -5
- data/docs/NewEventType.md +3 -17
- data/docs/NewInvitation.md +3 -3
- data/docs/NewLoyaltyProgram.md +16 -8
- data/docs/NewLoyaltyTier.md +2 -2
- data/docs/NewNotificationWebhook.md +19 -0
- data/docs/NewReferral.md +7 -7
- data/docs/NewReferralsForMultipleAdvocates.md +10 -10
- data/docs/NewReturn.md +17 -0
- data/docs/NewRole.md +2 -2
- data/docs/NewRuleset.md +4 -4
- data/docs/NewUser.md +3 -3
- data/docs/NotificationWebhook.md +27 -0
- data/docs/Referral.md +13 -13
- data/docs/ReferralConstraints.md +4 -4
- data/docs/ReturnIntegrationRequest.md +19 -0
- data/docs/ReturnedCartItem.md +19 -0
- data/docs/Role.md +5 -5
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +7 -1
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +3 -1
- data/docs/RollbackDiscountEffectProps.md +12 -2
- data/docs/Rule.md +4 -4
- data/docs/RuleFailureReason.md +1 -1
- data/docs/Ruleset.md +10 -8
- data/docs/SamlConnection.md +2 -2
- data/docs/Session.md +3 -3
- data/docs/SetDiscountEffectProps.md +3 -1
- data/docs/SetDiscountPerAdditionalCostEffectProps.md +25 -0
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +29 -0
- data/docs/SetDiscountPerItemEffectProps.md +13 -5
- data/docs/TemplateDef.md +3 -3
- data/docs/TemplateLimitConfig.md +23 -0
- data/docs/Tier.md +19 -0
- data/docs/UpdateApplication.md +19 -15
- data/docs/UpdateAudience.md +2 -2
- data/docs/UpdateCampaign.md +3 -3
- data/docs/UpdateCampaignCollection.md +17 -0
- data/docs/UpdateCampaignTemplate.md +45 -0
- data/docs/UpdateCatalog.md +21 -0
- data/docs/UpdateCollection.md +19 -0
- data/docs/UpdateCoupon.md +5 -3
- data/docs/UpdateCouponBatch.md +4 -4
- data/docs/UpdateCustomEffect.md +3 -3
- data/docs/UpdateLoyaltyCard.md +17 -0
- data/docs/UpdateLoyaltyProgram.md +10 -6
- data/docs/UpdateReferral.md +4 -4
- data/docs/UpdateReferralBatch.md +25 -0
- data/docs/UpdateRole.md +2 -2
- data/docs/User.md +12 -12
- data/docs/Webhook.md +3 -3
- data/lib/talon_one/api/integration_api.rb +561 -165
- data/lib/talon_one/api/management_api.rb +2256 -1674
- data/lib/talon_one/api_client.rb +1 -1
- data/lib/talon_one/api_error.rb +1 -1
- data/lib/talon_one/configuration.rb +1 -8
- data/lib/talon_one/models/accept_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/accept_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/access_log_entry.rb +1 -1
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +93 -5
- data/lib/talon_one/models/account_analytics.rb +21 -6
- data/lib/talon_one/models/account_entity.rb +1 -1
- data/lib/talon_one/models/account_limits.rb +1 -1
- data/lib/talon_one/models/add_free_item_effect_props.rb +1 -1
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +73 -14
- data/lib/talon_one/models/additional_cost.rb +1 -1
- data/lib/talon_one/models/api_error.rb +1 -1
- data/lib/talon_one/models/application.rb +48 -12
- data/lib/talon_one/models/application_api_health.rb +1 -1
- data/lib/talon_one/models/application_api_key.rb +4 -4
- data/lib/talon_one/models/application_campaign_stats.rb +1 -1
- data/lib/talon_one/models/application_customer.rb +53 -9
- data/lib/talon_one/models/application_customer_entity.rb +1 -1
- data/lib/talon_one/models/application_entity.rb +1 -1
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_notification.rb +212 -0
- data/lib/talon_one/models/application_referee.rb +39 -1
- data/lib/talon_one/models/application_session.rb +55 -6
- data/lib/talon_one/models/application_session_entity.rb +1 -1
- data/lib/talon_one/models/async_coupon_creation_response.rb +212 -0
- data/lib/talon_one/models/attribute.rb +80 -5
- data/lib/talon_one/models/attributes_mandatory.rb +1 -1
- data/lib/talon_one/models/attributes_settings.rb +1 -1
- data/lib/talon_one/models/audience.rb +12 -51
- data/lib/talon_one/models/audience_membership.rb +1 -1
- data/lib/talon_one/models/award_giveaway_effect_props.rb +20 -1
- data/lib/talon_one/models/base_loyalty_program.rb +284 -0
- data/lib/talon_one/models/base_saml_connection.rb +1 -1
- data/lib/talon_one/models/binding.rb +16 -6
- data/lib/talon_one/models/{new_feature_flags.rb → bulk_application_notification.rb} +29 -29
- data/lib/talon_one/models/bulk_campaign_notification.rb +227 -0
- data/lib/talon_one/models/campaign.rb +53 -13
- data/lib/talon_one/models/campaign_analytics.rb +1 -1
- 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 +3 -3
- data/lib/talon_one/models/campaign_created_notification.rb +212 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +212 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +226 -0
- data/lib/talon_one/models/campaign_entity.rb +1 -1
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_group_entity.rb +1 -1
- data/lib/talon_one/models/campaign_notification.rb +212 -0
- data/lib/talon_one/models/campaign_priorities_changed_notification.rb +241 -0
- data/lib/talon_one/models/campaign_priorities_v2.rb +230 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +235 -0
- data/lib/talon_one/models/campaign_search.rb +1 -1
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_set_branch_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_i_ds.rb +208 -0
- data/lib/talon_one/models/campaign_set_leaf_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_v2.rb +291 -0
- data/lib/talon_one/models/campaign_state_changed_notification.rb +242 -0
- data/lib/talon_one/models/campaign_template.rb +533 -0
- data/lib/talon_one/models/{update_loyalty_tier.rb → campaign_template_collection.rb} +30 -34
- data/lib/talon_one/models/campaign_template_params.rb +295 -0
- data/lib/talon_one/models/cart_item.rb +44 -7
- data/lib/talon_one/models/catalog.rb +330 -0
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/change_profile_password.rb +1 -1
- data/lib/talon_one/models/code_generator_settings.rb +3 -3
- data/lib/talon_one/models/collection.rb +382 -0
- data/lib/talon_one/models/collection_without_payload.rb +370 -0
- data/lib/talon_one/models/coupon.rb +35 -6
- data/lib/talon_one/models/coupon_constraints.rb +2 -2
- data/lib/talon_one/models/coupon_created_effect_props.rb +1 -1
- data/lib/talon_one/models/coupon_creation_job.rb +560 -0
- data/lib/talon_one/models/coupon_limit_configs.rb +209 -0
- data/lib/talon_one/models/coupon_rejection_reason.rb +1 -1
- data/lib/talon_one/models/coupon_reservations.rb +1 -1
- data/lib/talon_one/models/coupon_search.rb +1 -1
- data/lib/talon_one/models/coupon_value.rb +2 -2
- data/lib/talon_one/models/create_application_api_key.rb +4 -4
- data/lib/talon_one/models/create_template_campaign.rb +302 -0
- data/lib/talon_one/models/create_template_campaign_response.rb +236 -0
- data/lib/talon_one/models/custom_effect.rb +61 -14
- data/lib/talon_one/models/custom_effect_props.rb +26 -11
- data/lib/talon_one/models/customer_activity_report.rb +20 -1
- data/lib/talon_one/models/customer_analytics.rb +1 -1
- data/lib/talon_one/models/customer_inventory.rb +3 -2
- data/lib/talon_one/models/customer_profile.rb +49 -15
- data/lib/talon_one/models/customer_profile_audience_request.rb +1 -1
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +23 -1
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +2 -2
- data/lib/talon_one/models/customer_profile_search_query.rb +2 -2
- data/lib/talon_one/models/customer_session.rb +44 -10
- data/lib/talon_one/models/customer_session_v2.rb +87 -26
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +30 -5
- data/lib/talon_one/models/effect.rb +1 -1
- data/lib/talon_one/models/effect_entity.rb +1 -1
- data/lib/talon_one/models/email_entity.rb +1 -1
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +1 -1
- data/lib/talon_one/models/environment.rb +21 -8
- data/lib/talon_one/models/error_effect_props.rb +1 -1
- data/lib/talon_one/models/error_response.rb +1 -1
- data/lib/talon_one/models/error_response_with_status.rb +228 -0
- data/lib/talon_one/models/error_source.rb +1 -1
- data/lib/talon_one/models/event.rb +3 -3
- data/lib/talon_one/models/event_type.rb +5 -148
- data/lib/talon_one/models/event_v2.rb +252 -0
- data/lib/talon_one/models/export.rb +3 -3
- data/lib/talon_one/models/feature_flag.rb +1 -1
- data/lib/talon_one/models/features_feed.rb +1 -1
- data/lib/talon_one/models/feed_notification.rb +1 -1
- data/lib/talon_one/models/func_arg_def.rb +1 -1
- data/lib/talon_one/models/function_def.rb +1 -1
- data/lib/talon_one/models/giveaway.rb +2 -2
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/import.rb +3 -3
- data/lib/talon_one/models/import_entity.rb +1 -1
- data/lib/talon_one/models/inline_response200.rb +1 -1
- data/lib/talon_one/models/inline_response2001.rb +1 -1
- data/lib/talon_one/models/inline_response20010.rb +12 -12
- data/lib/talon_one/models/inline_response20011.rb +8 -12
- data/lib/talon_one/models/inline_response20012.rb +12 -12
- data/lib/talon_one/models/inline_response20013.rb +12 -8
- data/lib/talon_one/models/inline_response20014.rb +2 -2
- data/lib/talon_one/models/inline_response20015.rb +7 -2
- data/lib/talon_one/models/inline_response20016.rb +12 -12
- data/lib/talon_one/models/inline_response20017.rb +2 -7
- data/lib/talon_one/models/inline_response20018.rb +12 -12
- data/lib/talon_one/models/inline_response20019.rb +8 -12
- data/lib/talon_one/models/inline_response2002.rb +1 -1
- data/lib/talon_one/models/inline_response20020.rb +12 -8
- data/lib/talon_one/models/inline_response20021.rb +17 -3
- data/lib/talon_one/models/inline_response20022.rb +2 -2
- data/lib/talon_one/models/inline_response20023.rb +2 -2
- data/lib/talon_one/models/inline_response20024.rb +2 -2
- data/lib/talon_one/models/inline_response20025.rb +2 -2
- data/lib/talon_one/models/inline_response20026.rb +2 -2
- data/lib/talon_one/models/inline_response20027.rb +8 -12
- data/lib/talon_one/models/inline_response20028.rb +2 -2
- data/lib/talon_one/models/inline_response20029.rb +12 -8
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- 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_response2004.rb +1 -1
- data/lib/talon_one/models/inline_response2005.rb +1 -1
- data/lib/talon_one/models/inline_response2006.rb +1 -1
- data/lib/talon_one/models/inline_response2007.rb +1 -1
- data/lib/talon_one/models/inline_response2008.rb +12 -8
- data/lib/talon_one/models/inline_response2009.rb +12 -8
- data/lib/talon_one/models/inline_response201.rb +1 -1
- data/lib/talon_one/models/integration_customer_session_response.rb +206 -0
- data/lib/talon_one/models/integration_entity.rb +20 -1
- data/lib/talon_one/models/integration_event.rb +2 -2
- data/lib/talon_one/models/integration_event_v2_request.rb +286 -0
- data/lib/talon_one/models/integration_profile_entity.rb +2 -2
- data/lib/talon_one/models/integration_request.rb +2 -2
- data/lib/talon_one/models/integration_state.rb +1 -1
- data/lib/talon_one/models/integration_state_v2.rb +26 -6
- data/lib/talon_one/models/inventory_coupon.rb +36 -7
- data/lib/talon_one/models/inventory_referral.rb +446 -0
- data/lib/talon_one/models/ledger_entry.rb +2 -2
- data/lib/talon_one/models/ledger_info.rb +301 -0
- data/lib/talon_one/models/library_attribute.rb +1 -1
- data/lib/talon_one/models/limit_config.rb +27 -5
- data/lib/talon_one/models/limit_counter.rb +398 -0
- data/lib/talon_one/models/login_params.rb +1 -1
- data/lib/talon_one/models/loyalty.rb +15 -3
- data/lib/talon_one/models/loyalty_card.rb +350 -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 +3 -3
- data/lib/talon_one/models/loyalty_ledger_entry.rb +11 -7
- data/lib/talon_one/models/loyalty_membership.rb +1 -1
- data/lib/talon_one/models/loyalty_points.rb +6 -6
- data/lib/talon_one/models/loyalty_program.rb +124 -33
- data/lib/talon_one/models/loyalty_program_balance.rb +6 -6
- data/lib/talon_one/models/loyalty_program_entity.rb +1 -1
- data/lib/talon_one/models/loyalty_program_ledgers.rb +4 -4
- data/lib/talon_one/models/loyalty_projection.rb +239 -0
- data/lib/talon_one/models/loyalty_projection_data.rb +257 -0
- data/lib/talon_one/models/loyalty_statistics.rb +82 -9
- data/lib/talon_one/models/loyalty_sub_ledger.rb +25 -16
- data/lib/talon_one/models/loyalty_tier.rb +6 -6
- data/lib/talon_one/models/manager_config.rb +1 -1
- data/lib/talon_one/models/meta.rb +1 -1
- data/lib/talon_one/models/model_return.rb +384 -0
- data/lib/talon_one/models/multi_application_entity.rb +1 -1
- data/lib/talon_one/models/{application_customer_search.rb → multiple_attribute.rb} +10 -31
- data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +1 -1
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +21 -2
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +1 -1
- data/lib/talon_one/models/multiple_new_attribute.rb +208 -0
- data/lib/talon_one/models/mutable_entity.rb +1 -1
- data/lib/talon_one/models/new_account.rb +1 -1
- data/lib/talon_one/models/new_account_sign_up.rb +1 -1
- data/lib/talon_one/models/new_additional_cost.rb +93 -5
- data/lib/talon_one/models/new_application.rb +48 -12
- data/lib/talon_one/models/new_application_api_key.rb +5 -5
- data/lib/talon_one/models/new_attribute.rb +68 -2
- data/lib/talon_one/models/new_audience.rb +12 -51
- data/lib/talon_one/models/new_campaign.rb +8 -8
- data/lib/talon_one/models/new_campaign_collection.rb +253 -0
- data/lib/talon_one/models/new_campaign_group.rb +1 -1
- data/lib/talon_one/models/new_campaign_set.rb +1 -1
- data/lib/talon_one/models/new_campaign_set_v2.rb +261 -0
- data/lib/talon_one/models/new_campaign_template.rb +408 -0
- data/lib/talon_one/models/{feature_flags.rb → new_catalog.rb} +36 -39
- data/lib/talon_one/models/new_collection.rb +265 -0
- data/lib/talon_one/models/new_coupon_creation_job.rb +353 -0
- data/lib/talon_one/models/new_coupons.rb +33 -6
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +4 -4
- data/lib/talon_one/models/new_custom_effect.rb +62 -14
- data/lib/talon_one/models/new_customer_profile.rb +1 -1
- data/lib/talon_one/models/new_customer_session.rb +6 -6
- data/lib/talon_one/models/new_customer_session_v2.rb +24 -12
- data/lib/talon_one/models/new_event.rb +2 -2
- data/lib/talon_one/models/new_event_type.rb +5 -148
- data/lib/talon_one/models/new_giveaways_pool.rb +1 -1
- data/lib/talon_one/models/new_invitation.rb +2 -2
- data/lib/talon_one/models/new_invite_email.rb +1 -1
- data/lib/talon_one/models/new_loyalty_program.rb +109 -21
- data/lib/talon_one/models/new_loyalty_tier.rb +7 -7
- data/lib/talon_one/models/new_notification_webhook.rb +229 -0
- data/lib/talon_one/models/new_password.rb +1 -1
- data/lib/talon_one/models/new_password_email.rb +1 -1
- data/lib/talon_one/models/new_referral.rb +21 -2
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +4 -4
- data/lib/talon_one/models/new_return.rb +214 -0
- data/lib/talon_one/models/new_role.rb +12 -12
- data/lib/talon_one/models/new_ruleset.rb +3 -3
- data/lib/talon_one/models/new_saml_connection.rb +1 -1
- data/lib/talon_one/models/new_template_def.rb +1 -1
- data/lib/talon_one/models/new_user.rb +1 -1
- data/lib/talon_one/models/new_webhook.rb +22 -1
- data/lib/talon_one/models/notification.rb +1 -1
- data/lib/talon_one/models/notification_webhook.rb +290 -0
- data/lib/talon_one/models/profile_audiences_changes.rb +1 -1
- data/lib/talon_one/models/redeem_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/referral.rb +22 -3
- data/lib/talon_one/models/referral_constraints.rb +2 -2
- data/lib/talon_one/models/referral_created_effect_props.rb +1 -1
- data/lib/talon_one/models/referral_rejection_reason.rb +1 -1
- data/lib/talon_one/models/reject_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/reject_referral_effect_props.rb +1 -1
- 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 +2 -2
- data/lib/talon_one/models/role_assign.rb +1 -1
- data/lib/talon_one/models/role_membership.rb +1 -1
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +54 -5
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +34 -5
- data/lib/talon_one/models/rollback_discount_effect_props.rb +57 -7
- data/lib/talon_one/models/rollback_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/rule.rb +1 -1
- data/lib/talon_one/models/rule_failure_reason.rb +2 -2
- data/lib/talon_one/models/ruleset.rb +24 -19
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/saml_connection_metadata.rb +1 -1
- data/lib/talon_one/models/saml_login_endpoint.rb +1 -1
- data/lib/talon_one/models/session.rb +2 -2
- data/lib/talon_one/models/set_discount_effect_props.rb +15 -5
- 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 +50 -10
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +1 -1
- data/lib/talon_one/models/show_notification_effect_props.rb +1 -1
- data/lib/talon_one/models/slot_def.rb +1 -1
- data/lib/talon_one/models/template_arg_def.rb +1 -1
- data/lib/talon_one/models/template_def.rb +1 -1
- 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/trigger_webhook_effect_props.rb +1 -1
- data/lib/talon_one/models/update_account.rb +1 -1
- data/lib/talon_one/models/update_application.rb +51 -15
- data/lib/talon_one/models/update_attribute_effect_props.rb +1 -1
- data/lib/talon_one/models/update_audience.rb +2 -2
- data/lib/talon_one/models/update_campaign.rb +4 -4
- data/lib/talon_one/models/update_campaign_collection.rb +207 -0
- data/lib/talon_one/models/update_campaign_group.rb +1 -1
- data/lib/talon_one/models/update_campaign_template.rb +435 -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 +30 -3
- data/lib/talon_one/models/update_coupon_batch.rb +2 -7
- data/lib/talon_one/models/update_custom_effect.rb +61 -14
- data/lib/talon_one/models/update_loyalty_card.rb +212 -0
- data/lib/talon_one/models/update_loyalty_program.rb +43 -6
- data/lib/talon_one/models/update_referral.rb +16 -1
- data/lib/talon_one/models/update_referral_batch.rb +276 -0
- data/lib/talon_one/models/update_role.rb +9 -9
- data/lib/talon_one/models/update_user.rb +1 -1
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +1 -1
- data/lib/talon_one/models/user.rb +1 -1
- data/lib/talon_one/models/user_entity.rb +1 -1
- data/lib/talon_one/models/user_feed_notifications.rb +1 -1
- data/lib/talon_one/models/webhook.rb +22 -1
- data/lib/talon_one/models/webhook_activation_log_entry.rb +1 -1
- data/lib/talon_one/models/webhook_log_entry.rb +1 -1
- data/lib/talon_one/models/will_award_giveaway_effect_props.rb +20 -1
- data/lib/talon_one/version.rb +2 -2
- data/lib/talon_one.rb +68 -5
- data/spec/api/integration_api_spec.rb +129 -54
- data/spec/api/management_api_spec.rb +526 -459
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/accept_coupon_effect_props_spec.rb +1 -1
- data/spec/models/accept_referral_effect_props_spec.rb +1 -1
- data/spec/models/access_log_entry_spec.rb +1 -1
- data/spec/models/account_additional_cost_spec.rb +11 -1
- data/spec/models/account_analytics_spec.rb +7 -1
- data/spec/models/account_entity_spec.rb +1 -1
- data/spec/models/account_limits_spec.rb +1 -1
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/add_free_item_effect_props_spec.rb +1 -1
- data/spec/models/add_loyalty_points_effect_props_spec.rb +25 -1
- data/spec/models/additional_cost_spec.rb +1 -1
- data/spec/models/api_error_spec.rb +1 -1
- data/spec/models/application_api_health_spec.rb +1 -1
- data/spec/models/application_api_key_spec.rb +2 -2
- data/spec/models/application_campaign_stats_spec.rb +1 -1
- data/spec/models/application_customer_entity_spec.rb +1 -1
- data/spec/models/application_customer_spec.rb +7 -1
- data/spec/models/application_entity_spec.rb +1 -1
- data/spec/models/application_event_spec.rb +1 -1
- data/spec/models/application_notification_spec.rb +41 -0
- data/spec/models/application_referee_spec.rb +1 -1
- data/spec/models/application_session_entity_spec.rb +1 -1
- data/spec/models/application_session_spec.rb +8 -2
- data/spec/models/application_spec.rb +17 -1
- data/spec/models/async_coupon_creation_response_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +19 -1
- data/spec/models/attributes_mandatory_spec.rb +1 -1
- data/spec/models/attributes_settings_spec.rb +1 -1
- data/spec/models/audience_membership_spec.rb +1 -1
- data/spec/models/audience_spec.rb +1 -5
- data/spec/models/award_giveaway_effect_props_spec.rb +1 -1
- data/spec/models/base_loyalty_program_spec.rb +77 -0
- data/spec/models/base_saml_connection_spec.rb +1 -1
- data/spec/models/binding_spec.rb +7 -1
- data/spec/models/bulk_application_notification_spec.rb +47 -0
- data/spec/models/bulk_campaign_notification_spec.rb +47 -0
- data/spec/models/campaign_analytics_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/campaign_created_notification_spec.rb +41 -0
- data/spec/models/campaign_deleted_notification_spec.rb +41 -0
- data/spec/models/campaign_edited_notification_spec.rb +47 -0
- data/spec/models/campaign_entity_spec.rb +1 -1
- data/spec/models/campaign_group_entity_spec.rb +1 -1
- data/spec/models/campaign_group_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/campaign_set_branch_node_spec.rb +1 -1
- data/spec/models/campaign_set_i_ds_spec.rb +41 -0
- data/spec/models/campaign_set_leaf_node_spec.rb +1 -1
- data/spec/models/campaign_set_node_spec.rb +1 -1
- data/spec/models/campaign_set_spec.rb +1 -1
- data/spec/models/campaign_set_v2_spec.rb +65 -0
- data/spec/models/campaign_spec.rb +25 -1
- data/spec/models/campaign_state_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_template_collection_spec.rb +47 -0
- data/spec/models/campaign_template_params_spec.rb +57 -0
- data/spec/models/campaign_template_spec.rb +175 -0
- data/spec/models/cart_item_spec.rb +19 -1
- data/spec/models/catalog_spec.rb +89 -0
- data/spec/models/change_profile_password_spec.rb +1 -1
- data/spec/models/change_spec.rb +1 -1
- data/spec/models/code_generator_settings_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/coupon_created_effect_props_spec.rb +1 -1
- data/spec/models/coupon_creation_job_spec.rb +161 -0
- data/spec/models/coupon_limit_configs_spec.rb +41 -0
- data/spec/models/coupon_rejection_reason_spec.rb +1 -1
- data/spec/models/coupon_reservations_spec.rb +1 -1
- data/spec/models/coupon_search_spec.rb +1 -1
- data/spec/models/coupon_spec.rb +7 -1
- data/spec/models/coupon_value_spec.rb +1 -1
- data/spec/models/create_application_api_key_spec.rb +2 -2
- data/spec/models/create_template_campaign_response_spec.rb +53 -0
- data/spec/models/create_template_campaign_spec.rb +77 -0
- data/spec/models/custom_effect_props_spec.rb +8 -2
- data/spec/models/custom_effect_spec.rb +7 -7
- data/spec/models/customer_activity_report_spec.rb +1 -1
- data/spec/models/customer_analytics_spec.rb +1 -1
- data/spec/models/customer_inventory_spec.rb +1 -1
- data/spec/models/customer_profile_audience_request_item_spec.rb +1 -1
- data/spec/models/customer_profile_audience_request_spec.rb +1 -1
- data/spec/models/customer_profile_integration_request_v2_spec.rb +1 -1
- data/spec/models/customer_profile_search_query_spec.rb +1 -1
- data/spec/models/customer_profile_spec.rb +8 -2
- data/spec/models/customer_session_spec.rb +8 -2
- data/spec/models/customer_session_v2_spec.rb +21 -3
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +13 -1
- data/spec/models/effect_entity_spec.rb +1 -1
- data/spec/models/effect_spec.rb +1 -1
- data/spec/models/email_entity_spec.rb +1 -1
- data/spec/models/entity_spec.rb +1 -1
- data/spec/models/entity_with_talang_visible_id_spec.rb +1 -1
- data/spec/models/environment_spec.rb +8 -2
- data/spec/models/error_effect_props_spec.rb +1 -1
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/error_response_with_status_spec.rb +53 -0
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/event_spec.rb +1 -1
- data/spec/models/event_type_spec.rb +1 -51
- data/spec/models/event_v2_spec.rb +53 -0
- data/spec/models/export_spec.rb +2 -2
- data/spec/models/feature_flag_spec.rb +1 -1
- data/spec/models/features_feed_spec.rb +1 -1
- data/spec/models/feed_notification_spec.rb +1 -1
- data/spec/models/func_arg_def_spec.rb +1 -1
- data/spec/models/function_def_spec.rb +1 -1
- data/spec/models/giveaway_spec.rb +1 -1
- data/spec/models/giveaways_pool_spec.rb +1 -1
- data/spec/models/import_entity_spec.rb +1 -1
- data/spec/models/import_spec.rb +1 -1
- data/spec/models/inline_response20010_spec.rb +2 -2
- data/spec/models/inline_response20011_spec.rb +1 -7
- data/spec/models/inline_response20012_spec.rb +2 -2
- data/spec/models/inline_response20013_spec.rb +7 -1
- data/spec/models/inline_response20014_spec.rb +1 -1
- data/spec/models/inline_response20015_spec.rb +1 -1
- data/spec/models/inline_response20016_spec.rb +2 -2
- data/spec/models/inline_response20017_spec.rb +1 -1
- data/spec/models/inline_response20018_spec.rb +2 -2
- data/spec/models/inline_response20019_spec.rb +1 -7
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +7 -1
- data/spec/models/inline_response20021_spec.rb +7 -1
- data/spec/models/inline_response20022_spec.rb +1 -1
- data/spec/models/inline_response20023_spec.rb +1 -1
- data/spec/models/inline_response20024_spec.rb +1 -1
- data/spec/models/inline_response20025_spec.rb +1 -1
- data/spec/models/inline_response20026_spec.rb +1 -1
- data/spec/models/inline_response20027_spec.rb +1 -7
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +7 -1
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response20030_spec.rb +47 -0
- data/spec/models/inline_response20031_spec.rb +47 -0
- data/spec/models/inline_response2003_spec.rb +1 -1
- data/spec/models/inline_response2004_spec.rb +1 -1
- data/spec/models/inline_response2005_spec.rb +1 -1
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2007_spec.rb +1 -1
- data/spec/models/inline_response2008_spec.rb +7 -1
- data/spec/models/inline_response2009_spec.rb +7 -1
- data/spec/models/inline_response200_spec.rb +1 -1
- data/spec/models/inline_response201_spec.rb +1 -1
- data/spec/models/integration_customer_session_response_spec.rb +41 -0
- data/spec/models/integration_entity_spec.rb +1 -1
- data/spec/models/integration_event_spec.rb +1 -1
- data/spec/models/integration_event_v2_request_spec.rb +63 -0
- data/spec/models/integration_profile_entity_spec.rb +1 -1
- data/spec/models/integration_request_spec.rb +2 -2
- data/spec/models/integration_state_spec.rb +1 -1
- data/spec/models/integration_state_v2_spec.rb +13 -1
- data/spec/models/inventory_coupon_spec.rb +7 -1
- data/spec/models/inventory_referral_spec.rb +119 -0
- data/spec/models/ledger_entry_spec.rb +1 -1
- data/spec/models/ledger_info_spec.rb +83 -0
- data/spec/models/library_attribute_spec.rb +1 -1
- data/spec/models/limit_config_spec.rb +11 -1
- data/spec/models/limit_counter_spec.rb +125 -0
- data/spec/models/login_params_spec.rb +1 -1
- 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 +95 -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 +7 -1
- data/spec/models/loyalty_ledger_spec.rb +1 -1
- data/spec/models/loyalty_membership_spec.rb +1 -1
- data/spec/models/loyalty_points_spec.rb +1 -1
- data/spec/models/loyalty_program_balance_spec.rb +1 -1
- data/spec/models/loyalty_program_entity_spec.rb +1 -1
- data/spec/models/loyalty_program_ledgers_spec.rb +1 -1
- data/spec/models/loyalty_program_spec.rb +32 -8
- data/spec/models/loyalty_projection_data_spec.rb +59 -0
- data/spec/models/loyalty_projection_spec.rb +53 -0
- data/spec/models/loyalty_spec.rb +7 -1
- data/spec/models/loyalty_statistics_spec.rb +31 -1
- data/spec/models/loyalty_sub_ledger_spec.rb +7 -1
- data/spec/models/loyalty_tier_spec.rb +1 -1
- data/spec/models/manager_config_spec.rb +1 -1
- data/spec/models/meta_spec.rb +1 -1
- data/spec/models/model_return_spec.rb +101 -0
- data/spec/models/multi_application_entity_spec.rb +1 -1
- data/spec/models/multiple_attribute_spec.rb +41 -0
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +1 -1
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +1 -1
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +1 -1
- data/spec/models/multiple_new_attribute_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +1 -1
- data/spec/models/new_account_sign_up_spec.rb +1 -1
- data/spec/models/new_account_spec.rb +1 -1
- data/spec/models/new_additional_cost_spec.rb +11 -1
- data/spec/models/new_application_api_key_spec.rb +2 -2
- data/spec/models/new_application_spec.rb +17 -1
- data/spec/models/new_attribute_spec.rb +13 -1
- data/spec/models/new_audience_spec.rb +1 -5
- data/spec/models/new_campaign_collection_spec.rb +47 -0
- data/spec/models/new_campaign_group_spec.rb +1 -1
- data/spec/models/new_campaign_set_spec.rb +1 -1
- data/spec/models/new_campaign_set_v2_spec.rb +53 -0
- data/spec/models/new_campaign_spec.rb +1 -1
- data/spec/models/new_campaign_template_spec.rb +121 -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 +77 -0
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +1 -1
- data/spec/models/new_coupons_spec.rb +7 -1
- data/spec/models/new_custom_effect_spec.rb +7 -7
- data/spec/models/new_customer_profile_spec.rb +1 -1
- data/spec/models/new_customer_session_spec.rb +2 -2
- data/spec/models/new_customer_session_v2_spec.rb +8 -2
- data/spec/models/new_event_spec.rb +1 -1
- data/spec/models/new_event_type_spec.rb +1 -51
- data/spec/models/new_giveaways_pool_spec.rb +1 -1
- data/spec/models/new_invitation_spec.rb +1 -1
- data/spec/models/new_invite_email_spec.rb +1 -1
- data/spec/models/new_loyalty_program_spec.rb +31 -7
- data/spec/models/new_loyalty_tier_spec.rb +1 -1
- data/spec/models/new_notification_webhook_spec.rb +47 -0
- data/spec/models/new_password_email_spec.rb +1 -1
- data/spec/models/new_password_spec.rb +1 -1
- data/spec/models/new_referral_spec.rb +1 -1
- data/spec/models/new_referrals_for_multiple_advocates_spec.rb +1 -1
- data/spec/models/new_return_spec.rb +41 -0
- data/spec/models/new_role_spec.rb +2 -2
- data/spec/models/new_ruleset_spec.rb +1 -1
- data/spec/models/new_saml_connection_spec.rb +1 -1
- data/spec/models/new_template_def_spec.rb +1 -1
- data/spec/models/new_user_spec.rb +1 -1
- data/spec/models/new_webhook_spec.rb +1 -1
- data/spec/models/notification_spec.rb +1 -1
- data/spec/models/notification_webhook_spec.rb +71 -0
- data/spec/models/profile_audiences_changes_spec.rb +1 -1
- data/spec/models/redeem_referral_effect_props_spec.rb +1 -1
- data/spec/models/referral_constraints_spec.rb +1 -1
- data/spec/models/referral_created_effect_props_spec.rb +1 -1
- data/spec/models/referral_rejection_reason_spec.rb +1 -1
- data/spec/models/referral_spec.rb +1 -1
- data/spec/models/reject_coupon_effect_props_spec.rb +1 -1
- data/spec/models/reject_referral_effect_props_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/role_membership_spec.rb +1 -1
- data/spec/models/role_spec.rb +1 -1
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +19 -1
- data/spec/models/rollback_coupon_effect_props_spec.rb +1 -1
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +7 -1
- data/spec/models/rollback_discount_effect_props_spec.rb +31 -1
- data/spec/models/rollback_referral_effect_props_spec.rb +1 -1
- data/spec/models/rule_failure_reason_spec.rb +1 -1
- data/spec/models/rule_spec.rb +1 -1
- data/spec/models/ruleset_spec.rb +13 -7
- data/spec/models/saml_connection_metadata_spec.rb +1 -1
- data/spec/models/saml_connection_spec.rb +1 -1
- data/spec/models/saml_login_endpoint_spec.rb +1 -1
- data/spec/models/session_spec.rb +1 -1
- data/spec/models/set_discount_effect_props_spec.rb +7 -1
- 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 +25 -1
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +1 -1
- data/spec/models/show_notification_effect_props_spec.rb +1 -1
- data/spec/models/slot_def_spec.rb +1 -1
- data/spec/models/template_arg_def_spec.rb +1 -1
- data/spec/models/template_def_spec.rb +1 -1
- data/spec/models/template_limit_config_spec.rb +67 -0
- data/spec/models/tier_spec.rb +47 -0
- data/spec/models/trigger_webhook_effect_props_spec.rb +1 -1
- data/spec/models/update_account_spec.rb +1 -1
- data/spec/models/update_application_spec.rb +17 -1
- data/spec/models/update_attribute_effect_props_spec.rb +1 -1
- data/spec/models/update_audience_spec.rb +1 -1
- data/spec/models/update_campaign_collection_spec.rb +41 -0
- data/spec/models/update_campaign_group_spec.rb +1 -1
- data/spec/models/update_campaign_spec.rb +1 -1
- data/spec/models/update_campaign_template_spec.rb +133 -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 +1 -1
- data/spec/models/update_coupon_spec.rb +7 -1
- data/spec/models/update_custom_effect_spec.rb +7 -7
- data/spec/models/update_loyalty_card_spec.rb +41 -0
- data/spec/models/update_loyalty_program_spec.rb +13 -1
- data/spec/models/update_referral_batch_spec.rb +65 -0
- data/spec/models/update_referral_spec.rb +1 -1
- data/spec/models/update_role_spec.rb +2 -2
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +1 -1
- data/spec/models/update_user_spec.rb +1 -1
- data/spec/models/user_entity_spec.rb +1 -1
- data/spec/models/user_feed_notifications_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/webhook_activation_log_entry_spec.rb +1 -1
- data/spec/models/webhook_log_entry_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/will_award_giveaway_effect_props_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/talon_one.gemspec +1 -1
- metadata +493 -240
- data/docs/ApplicationCustomerSearch.md +0 -21
- data/docs/FeatureFlags.md +0 -23
- 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/new_feature_flags_spec.rb +0 -53
- data/spec/models/update_loyalty_tier_spec.rb +0 -47
data/docs/ModelReturn.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# TalonOne::ModelReturn
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | Unique ID for this entity. |
|
|
8
|
+
**created** | **DateTime** | The exact moment this entity was created. |
|
|
9
|
+
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
10
|
+
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
|
11
|
+
**returned_cart_items** | [**Array<ReturnedCartItem>**](ReturnedCartItem.md) | List of cart items to be returned |
|
|
12
|
+
**event_id** | **Integer** | The event ID of that was generated for this return. |
|
|
13
|
+
**session_id** | **Integer** | The internal ID of the session this return was requested on. |
|
|
14
|
+
**session_integration_id** | **String** | The integration ID of the session this return was requested on. |
|
|
15
|
+
**profile_id** | **Integer** | The internal ID of the profile this return was requested on. | [optional]
|
|
16
|
+
**profile_integration_id** | **String** | The integration ID of the profile this return was requested on. | [optional]
|
|
17
|
+
**created_by** | **Integer** | ID of the user who requested this return. | [optional]
|
|
18
|
+
|
|
19
|
+
## Code Sample
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'TalonOne'
|
|
23
|
+
|
|
24
|
+
instance = TalonOne::ModelReturn.new(id: 6,
|
|
25
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
26
|
+
application_id: 322,
|
|
27
|
+
account_id: 3886,
|
|
28
|
+
returned_cart_items: null,
|
|
29
|
+
event_id: 123,
|
|
30
|
+
session_id: 123,
|
|
31
|
+
session_integration_id: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c,
|
|
32
|
+
profile_id: 123,
|
|
33
|
+
profile_integration_id: 0c0e0207-eb30-4e06-a56c-2b7c8a64953c,
|
|
34
|
+
created_by: 123)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::MultipleAttribute
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**attributes** | [**Array<Attribute>**](Attribute.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::MultipleAttribute.new(attributes: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -5,15 +5,15 @@
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
8
|
-
**integration_id** | **String** | The custom identifier for this profile, must be unique within the account. |
|
|
8
|
+
**integration_id** | **String** | The custom identifier for this profile, must be unique within the account. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2). |
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'TalonOne'
|
|
14
14
|
|
|
15
|
-
instance = TalonOne::MultipleCustomerProfileIntegrationRequestItem.new(attributes:
|
|
16
|
-
integration_id:
|
|
15
|
+
instance = TalonOne::MultipleCustomerProfileIntegrationRequestItem.new(attributes: {"Language":"english","ShippingCountry":"DE"},
|
|
16
|
+
integration_id: R195412)
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::MultipleNewAttribute
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**attributes** | [**Array<NewAttribute>**](NewAttribute.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::MultipleNewAttribute.new(attributes: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/MutableEntity.md
CHANGED
data/docs/NewAccountSignUp.md
CHANGED
|
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::NewAccountSignUp.new(email:
|
|
17
|
-
password:
|
|
16
|
+
instance = TalonOne::NewAccountSignUp.new(email: john.doe@example.com,
|
|
17
|
+
password: admin123456,
|
|
18
18
|
company_name: null)
|
|
19
19
|
```
|
|
20
20
|
|
data/docs/NewAdditionalCost.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**title** | **String** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. |
|
|
9
9
|
**description** | **String** | A description of this additional cost. |
|
|
10
10
|
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost | [optional]
|
|
11
|
+
**type** | **String** | The type of additional cost. The following options can be chosen: - `session`: Additional cost will be added per session, - `item`: Additional cost will be added per item, - `both`: Additional cost will be added per item and session. | [optional] [default to 'session']
|
|
11
12
|
|
|
12
13
|
## Code Sample
|
|
13
14
|
|
|
@@ -17,7 +18,8 @@ require 'TalonOne'
|
|
|
17
18
|
instance = TalonOne::NewAdditionalCost.new(name: null,
|
|
18
19
|
title: null,
|
|
19
20
|
description: null,
|
|
20
|
-
subscribed_applications_ids: null
|
|
21
|
+
subscribed_applications_ids: null,
|
|
22
|
+
type: null)
|
|
21
23
|
```
|
|
22
24
|
|
|
23
25
|
|
data/docs/NewApplication.md
CHANGED
|
@@ -7,17 +7,19 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**name** | **String** | The name of this application. |
|
|
8
8
|
**description** | **String** | A longer description of the application. | [optional]
|
|
9
9
|
**timezone** | **String** | A string containing an IANA timezone descriptor. |
|
|
10
|
-
**currency** | **String** |
|
|
11
|
-
**case_sensitivity** | **String** |
|
|
12
|
-
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]
|
|
13
|
-
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional]
|
|
14
|
-
**campaign_priority** | **String** | Default priority for campaigns created in this
|
|
15
|
-
**exclusive_campaigns_strategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation
|
|
16
|
-
**default_discount_scope** | **String** | The default scope to apply
|
|
17
|
-
**enable_cascading_discounts** | **Boolean** |
|
|
18
|
-
**enable_flattened_cart_items** | **Boolean** |
|
|
10
|
+
**currency** | **String** | The default currency for new customer sessions. |
|
|
11
|
+
**case_sensitivity** | **String** | The case sensitivity behavior to check coupon codes in the campaigns of this Application. | [optional]
|
|
12
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional]
|
|
13
|
+
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional]
|
|
14
|
+
**campaign_priority** | **String** | Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application. | [optional] [default to 'universal']
|
|
15
|
+
**exclusive_campaigns_strategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation. | [optional] [default to 'listOrder']
|
|
16
|
+
**default_discount_scope** | **String** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect. | [optional]
|
|
17
|
+
**enable_cascading_discounts** | **Boolean** | Indicates if discounts should cascade for this Application. | [optional]
|
|
18
|
+
**enable_flattened_cart_items** | **Boolean** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items). | [optional]
|
|
19
19
|
**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) | | [optional]
|
|
20
|
-
**sandbox** | **Boolean** |
|
|
20
|
+
**sandbox** | **Boolean** | Indicates if this is a live or sandbox Application. | [optional]
|
|
21
|
+
**enable_partial_discounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional]
|
|
22
|
+
**default_discount_additional_cost_per_item_scope** | **String** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional]
|
|
21
23
|
**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | [optional]
|
|
22
24
|
|
|
23
25
|
## Code Sample
|
|
@@ -25,10 +27,10 @@ Name | Type | Description | Notes
|
|
|
25
27
|
```ruby
|
|
26
28
|
require 'TalonOne'
|
|
27
29
|
|
|
28
|
-
instance = TalonOne::NewApplication.new(name:
|
|
29
|
-
description:
|
|
30
|
-
timezone:
|
|
31
|
-
currency:
|
|
30
|
+
instance = TalonOne::NewApplication.new(name: My Application,
|
|
31
|
+
description: A test Application,
|
|
32
|
+
timezone: Europe/Berlin,
|
|
33
|
+
currency: EUR,
|
|
32
34
|
case_sensitivity: null,
|
|
33
35
|
attributes: null,
|
|
34
36
|
limits: null,
|
|
@@ -39,6 +41,8 @@ instance = TalonOne::NewApplication.new(name: null,
|
|
|
39
41
|
enable_flattened_cart_items: null,
|
|
40
42
|
attributes_settings: null,
|
|
41
43
|
sandbox: null,
|
|
44
|
+
enable_partial_discounts: false,
|
|
45
|
+
default_discount_additional_cost_per_item_scope: null,
|
|
42
46
|
key: null)
|
|
43
47
|
```
|
|
44
48
|
|
|
@@ -6,28 +6,28 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**title** | **String** | Title for API Key |
|
|
8
8
|
**expires** | **DateTime** | The date the API key expired |
|
|
9
|
-
**platform** | **String** |
|
|
9
|
+
**platform** | **String** | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. | [optional]
|
|
10
10
|
**id** | **Integer** | ID of the API Key |
|
|
11
11
|
**created_by** | **Integer** | ID of user who created |
|
|
12
12
|
**account_id** | **Integer** | ID of account the key is used for |
|
|
13
13
|
**application_id** | **Integer** | ID of application the key is used for |
|
|
14
14
|
**created** | **DateTime** | The date the API key was created |
|
|
15
|
-
**key** | **String** |
|
|
15
|
+
**key** | **String** | The API key |
|
|
16
16
|
|
|
17
17
|
## Code Sample
|
|
18
18
|
|
|
19
19
|
```ruby
|
|
20
20
|
require 'TalonOne'
|
|
21
21
|
|
|
22
|
-
instance = TalonOne::NewApplicationAPIKey.new(title:
|
|
23
|
-
expires:
|
|
24
|
-
platform:
|
|
25
|
-
id:
|
|
26
|
-
created_by:
|
|
27
|
-
account_id:
|
|
28
|
-
application_id:
|
|
29
|
-
created:
|
|
30
|
-
key:
|
|
22
|
+
instance = TalonOne::NewApplicationAPIKey.new(title: My generated key,
|
|
23
|
+
expires: 2023-08-24T14:00Z,
|
|
24
|
+
platform: none,
|
|
25
|
+
id: 34,
|
|
26
|
+
created_by: 280,
|
|
27
|
+
account_id: 13,
|
|
28
|
+
application_id: 54,
|
|
29
|
+
created: 2022-03-02T16:46:17.758585Z,
|
|
30
|
+
key: f45f90d21dcd9bac965c45e547e9754a3196891d09948e35adbcbedc4e9e4b01)
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
|
data/docs/NewAttribute.md
CHANGED
|
@@ -11,6 +11,8 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**type** | **String** | The data type of the attribute, a `time` attribute must be sent as a string that conforms to the [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp format. |
|
|
12
12
|
**description** | **String** | A description of this attribute. |
|
|
13
13
|
**suggestions** | **Array<String>** | A list of suggestions for the attribute. |
|
|
14
|
+
**has_allowed_list** | **Boolean** | Whether or not this attribute has an allowed list of values associated with it. | [optional] [default to false]
|
|
15
|
+
**restricted_by_suggestions** | **Boolean** | Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property). | [optional] [default to false]
|
|
14
16
|
**editable** | **Boolean** | Whether or not this attribute can be edited. |
|
|
15
17
|
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this attribute | [optional]
|
|
16
18
|
|
|
@@ -26,6 +28,8 @@ instance = TalonOne::NewAttribute.new(entity: null,
|
|
|
26
28
|
type: null,
|
|
27
29
|
description: null,
|
|
28
30
|
suggestions: null,
|
|
31
|
+
has_allowed_list: null,
|
|
32
|
+
restricted_by_suggestions: null,
|
|
29
33
|
editable: null,
|
|
30
34
|
subscribed_applications_ids: null)
|
|
31
35
|
```
|
data/docs/NewAudience.md
CHANGED
|
@@ -4,18 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**name** | **String** | The human-friendly display name for this
|
|
8
|
-
**integration** | **String** |
|
|
9
|
-
**integration_id** | **String** | The ID of this
|
|
7
|
+
**name** | **String** | The human-friendly display name for this audience. |
|
|
8
|
+
**integration** | **String** | The 3rd-party platform that this audience was created in. For example, mParticle. | [optional]
|
|
9
|
+
**integration_id** | **String** | The ID of this audience in the third-party integration. | [optional]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'TalonOne'
|
|
15
15
|
|
|
16
|
-
instance = TalonOne::NewAudience.new(name:
|
|
17
|
-
integration:
|
|
18
|
-
integration_id:
|
|
16
|
+
instance = TalonOne::NewAudience.new(name: mPTravel,
|
|
17
|
+
integration: mparticle,
|
|
18
|
+
integration_id: 382370BKDB946)
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
|
data/docs/NewCampaign.md
CHANGED
|
@@ -4,38 +4,38 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**name** | **String** | A
|
|
7
|
+
**name** | **String** | A user-facing name for this campaign. |
|
|
8
8
|
**description** | **String** | A detailed description of the campaign. | [optional]
|
|
9
|
-
**start_time** | **DateTime** |
|
|
10
|
-
**end_time** | **DateTime** |
|
|
9
|
+
**start_time** | **DateTime** | Timestamp when the campaign will become active. | [optional]
|
|
10
|
+
**end_time** | **DateTime** | Timestamp the campaign will become inactive. | [optional]
|
|
11
11
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional]
|
|
12
12
|
**state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to 'enabled']
|
|
13
|
-
**active_ruleset_id** | **Integer** | ID of Ruleset this campaign applies on customer session evaluation.
|
|
13
|
+
**active_ruleset_id** | **Integer** | [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
|
|
14
14
|
**tags** | **Array<String>** | A list of tags for the campaign. |
|
|
15
|
-
**features** | **Array<String>** |
|
|
15
|
+
**features** | **Array<String>** | The features enabled in this campaign. |
|
|
16
16
|
**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
17
17
|
**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
18
|
-
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of limits
|
|
19
|
-
**campaign_groups** | **Array<Integer>** | The IDs of the campaign groups
|
|
18
|
+
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign. |
|
|
19
|
+
**campaign_groups** | **Array<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to. | [optional]
|
|
20
20
|
|
|
21
21
|
## Code Sample
|
|
22
22
|
|
|
23
23
|
```ruby
|
|
24
24
|
require 'TalonOne'
|
|
25
25
|
|
|
26
|
-
instance = TalonOne::NewCampaign.new(name:
|
|
27
|
-
description:
|
|
28
|
-
start_time:
|
|
29
|
-
end_time:
|
|
26
|
+
instance = TalonOne::NewCampaign.new(name: Summer promotions,
|
|
27
|
+
description: Campaign for all summer 2021 promotions,
|
|
28
|
+
start_time: 2021-07-20T22:00Z,
|
|
29
|
+
end_time: 2021-09-22T22:00Z,
|
|
30
30
|
attributes: null,
|
|
31
31
|
state: null,
|
|
32
32
|
active_ruleset_id: null,
|
|
33
|
-
tags:
|
|
34
|
-
features:
|
|
33
|
+
tags: [summer],
|
|
34
|
+
features: [coupons, referrals],
|
|
35
35
|
coupon_settings: null,
|
|
36
36
|
referral_settings: null,
|
|
37
37
|
limits: null,
|
|
38
|
-
campaign_groups:
|
|
38
|
+
campaign_groups: [1, 3])
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::NewCampaignCollection
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**description** | **String** | A short description of the purpose of this collection. | [optional]
|
|
8
|
+
**name** | **String** | The name of this collection. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::NewCampaignCollection.new(description: My collection of SKUs,
|
|
16
|
+
name: My collection)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
data/docs/NewCampaignSet.md
CHANGED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::NewCampaignSetV2
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
8
|
+
**version** | **Integer** | Version of the campaign set |
|
|
9
|
+
**set** | [**CampaignPrioritiesV2**](CampaignPrioritiesV2.md) | |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::NewCampaignSetV2.new(application_id: 322,
|
|
17
|
+
version: null,
|
|
18
|
+
set: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
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) | Template parameters are 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
|
+
|
|
21
|
+
## Code Sample
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'TalonOne'
|
|
25
|
+
|
|
26
|
+
instance = TalonOne::NewCampaignTemplate.new(name: null,
|
|
27
|
+
description: null,
|
|
28
|
+
instructions: null,
|
|
29
|
+
campaign_attributes: null,
|
|
30
|
+
coupon_attributes: null,
|
|
31
|
+
state: null,
|
|
32
|
+
tags: null,
|
|
33
|
+
features: null,
|
|
34
|
+
coupon_settings: null,
|
|
35
|
+
referral_settings: null,
|
|
36
|
+
limits: null,
|
|
37
|
+
template_params: null,
|
|
38
|
+
campaign_collections: null)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
|
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 items catalog name. |
|
|
8
|
+
**description** | **String** | A description of this cart items 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: null,
|
|
17
|
+
description: null,
|
|
18
|
+
subscribed_applications_ids: null)
|
|
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,29 @@
|
|
|
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 amount of discounts that can be given with this coupon code. | [optional]
|
|
9
|
+
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
10
|
+
**expiry_date** | **DateTime** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
|
|
11
|
+
**number_of_coupons** | **Integer** | The number of new coupon codes to generate for the campaign. Must be between 20,001 and 5,000,000. |
|
|
12
|
+
**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
|
13
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with coupons |
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'TalonOne'
|
|
19
|
+
|
|
20
|
+
instance = TalonOne::NewCouponCreationJob.new(usage_limit: 100,
|
|
21
|
+
discount_limit: 30.0,
|
|
22
|
+
start_date: null,
|
|
23
|
+
expiry_date: null,
|
|
24
|
+
number_of_coupons: 200000,
|
|
25
|
+
coupon_settings: null,
|
|
26
|
+
attributes: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
data/docs/NewCoupons.md
CHANGED
|
@@ -4,32 +4,34 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**usage_limit** | **Integer** | The number of times
|
|
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
8
|
**discount_limit** | **Float** | The amount of discounts that can be given with this coupon code. | [optional]
|
|
9
9
|
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
10
10
|
**expiry_date** | **DateTime** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
|
|
11
|
+
**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
12
|
**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
|
+
**unique_prefix** | **String** | **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously endpoint](https://docs.talon.one/management-api/#operation/createCouponsAsync). | [optional]
|
|
13
14
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
14
15
|
**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
|
|
16
|
+
**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]
|
|
17
|
+
**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]
|
|
17
18
|
|
|
18
19
|
## Code Sample
|
|
19
20
|
|
|
20
21
|
```ruby
|
|
21
22
|
require 'TalonOne'
|
|
22
23
|
|
|
23
|
-
instance = TalonOne::NewCoupons.new(usage_limit:
|
|
24
|
-
discount_limit:
|
|
24
|
+
instance = TalonOne::NewCoupons.new(usage_limit: 100,
|
|
25
|
+
discount_limit: 30.0,
|
|
25
26
|
start_date: null,
|
|
26
27
|
expiry_date: null,
|
|
27
|
-
|
|
28
|
+
limits: null,
|
|
29
|
+
number_of_coupons: 1,
|
|
28
30
|
unique_prefix: null,
|
|
29
31
|
attributes: null,
|
|
30
|
-
recipient_integration_id:
|
|
31
|
-
valid_characters:
|
|
32
|
-
coupon_pattern:
|
|
32
|
+
recipient_integration_id: URNGV8294NV,
|
|
33
|
+
valid_characters: [A, B, G, Y],
|
|
34
|
+
coupon_pattern: SUMMER-#####)
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
|
|
@@ -4,22 +4,22 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**usage_limit** | **Integer** | The number of times
|
|
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
8
|
**discount_limit** | **Float** | The amount of discounts that can be given with this coupon code. | [optional]
|
|
9
9
|
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
|
10
10
|
**expiry_date** | **DateTime** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional]
|
|
11
11
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
|
12
12
|
**recipients_integration_ids** | **Array<String>** | The integration IDs for recipients |
|
|
13
|
-
**valid_characters** | **Array<String>** |
|
|
14
|
-
**coupon_pattern** | **String** | The pattern
|
|
13
|
+
**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]
|
|
14
|
+
**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
15
|
|
|
16
16
|
## Code Sample
|
|
17
17
|
|
|
18
18
|
```ruby
|
|
19
19
|
require 'TalonOne'
|
|
20
20
|
|
|
21
|
-
instance = TalonOne::NewCouponsForMultipleRecipients.new(usage_limit:
|
|
22
|
-
discount_limit:
|
|
21
|
+
instance = TalonOne::NewCouponsForMultipleRecipients.new(usage_limit: 100,
|
|
22
|
+
discount_limit: 30.0,
|
|
23
23
|
start_date: null,
|
|
24
24
|
expiry_date: null,
|
|
25
25
|
attributes: null,
|
data/docs/NewCustomEffect.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
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. |
|
|
7
8
|
**name** | **String** | The name of this effect. |
|
|
8
9
|
**title** | **String** | The title of this effect. |
|
|
9
10
|
**payload** | **String** | The JSON payload of this effect. |
|
|
10
11
|
**description** | **String** | The description of this effect. | [optional]
|
|
11
12
|
**enabled** | **Boolean** | Determines if this effect is active. |
|
|
12
|
-
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this effect is enabled for | [optional]
|
|
13
13
|
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions | [optional]
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
|
@@ -17,12 +17,12 @@ Name | Type | Description | Notes
|
|
|
17
17
|
```ruby
|
|
18
18
|
require 'TalonOne'
|
|
19
19
|
|
|
20
|
-
instance = TalonOne::NewCustomEffect.new(
|
|
20
|
+
instance = TalonOne::NewCustomEffect.new(application_ids: null,
|
|
21
|
+
name: null,
|
|
21
22
|
title: null,
|
|
22
23
|
payload: null,
|
|
23
24
|
description: null,
|
|
24
25
|
enabled: null,
|
|
25
|
-
subscribed_applications_ids: null,
|
|
26
26
|
params: null)
|
|
27
27
|
```
|
|
28
28
|
|
data/docs/NewCustomerProfile.md
CHANGED
|
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
|
|
|
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
|
|