talon_one 1.4.0 → 2.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rspec +2 -0
- data/Gemfile +3 -1
- data/README.md +204 -36
- data/Rakefile +2 -0
- data/docs/APIError.md +11 -0
- data/docs/AcceptCouponEffectProps.md +17 -0
- data/docs/AcceptReferralEffectProps.md +17 -0
- data/docs/AccessLogEntry.md +15 -0
- data/docs/Account.md +28 -2
- data/docs/AccountAdditionalCost.md +29 -0
- data/docs/AccountAnalytics.md +44 -15
- data/docs/AccountEntity.md +9 -0
- data/docs/AccountLimits.md +32 -12
- data/docs/AddFreeItemEffectProps.md +19 -0
- data/docs/AddLoyaltyPointsEffectProps.md +31 -0
- data/docs/AdditionalCost.md +17 -0
- data/docs/Application.md +34 -2
- data/docs/ApplicationAPIKey.md +19 -2
- data/docs/ApplicationApiHealth.md +10 -0
- data/docs/ApplicationCustomer.md +21 -2
- data/docs/ApplicationCustomerEntity.md +9 -0
- data/docs/ApplicationCustomerSearch.md +12 -1
- data/docs/ApplicationEntity.md +9 -0
- data/docs/ApplicationEvent.md +19 -1
- data/docs/ApplicationSession.md +25 -3
- data/docs/ApplicationSessionEntity.md +9 -0
- data/docs/Attribute.md +23 -2
- data/docs/AttributesMandatory.md +10 -0
- data/docs/AttributesSettings.md +9 -0
- data/docs/Audience.md +27 -0
- data/docs/AudienceMembership.md +19 -0
- data/docs/BaseSamlConnection.md +17 -1
- data/docs/Binding.md +12 -0
- data/docs/Campaign.md +47 -2
- data/docs/CampaignAnalytics.md +37 -0
- data/docs/CampaignCopy.md +15 -1
- data/docs/CampaignEntity.md +9 -0
- data/docs/CampaignGroup.md +31 -0
- data/docs/CampaignGroupEntity.md +17 -0
- data/docs/CampaignSearch.md +10 -1
- data/docs/CampaignSet.md +14 -0
- data/docs/CampaignSetBranchNode.md +12 -0
- data/docs/CampaignSetLeafNode.md +10 -0
- data/docs/CampaignSetNode.md +9 -0
- data/docs/CartItem.md +20 -2
- data/docs/Change.md +18 -2
- data/docs/ChangeProfilePassword.md +19 -0
- data/docs/CodeGeneratorSettings.md +10 -0
- data/docs/Coupon.md +31 -3
- data/docs/CouponConstraints.md +13 -0
- data/docs/CouponCreatedEffectProps.md +19 -0
- data/docs/CouponRejectionReason.md +11 -0
- data/docs/CouponReservations.md +9 -0
- data/docs/CouponSearch.md +10 -1
- data/docs/CouponValue.md +9 -0
- data/docs/CreateApplicationAPIKey.md +12 -0
- data/docs/CustomerActivityReport.md +22 -1
- data/docs/CustomerAnalytics.md +15 -0
- data/docs/CustomerInventory.md +14 -0
- data/docs/CustomerProfile.md +20 -2
- data/docs/CustomerProfileAudienceRequest.md +17 -0
- data/docs/CustomerProfileAudienceRequestItem.md +21 -0
- data/docs/CustomerProfileIntegrationRequestV2.md +21 -0
- data/docs/CustomerProfileSearchQuery.md +12 -1
- data/docs/CustomerSession.md +24 -3
- data/docs/CustomerSessionV2.md +45 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +25 -0
- data/docs/Effect.md +29 -0
- data/docs/EffectEntity.md +27 -0
- data/docs/EmailEntity.md +9 -0
- data/docs/Entity.md +10 -0
- data/docs/EntityWithTalangVisibleID.md +19 -0
- data/docs/Environment.md +15 -0
- data/docs/ErrorEffectProps.md +17 -0
- data/docs/ErrorResponse.md +10 -0
- data/docs/ErrorSource.md +12 -0
- data/docs/Event.md +19 -1
- data/docs/EventType.md +21 -1
- data/docs/Export.md +15 -1
- data/docs/FeatureFlag.md +12 -0
- data/docs/FeatureFlags.md +15 -3
- data/docs/FeaturesFeed.md +10 -0
- data/docs/FeedNotification.md +27 -0
- data/docs/FuncArgDef.md +10 -0
- data/docs/FunctionDef.md +13 -0
- data/docs/Import.md +15 -1
- data/docs/InlineResponse200.md +10 -0
- data/docs/InlineResponse2001.md +11 -1
- data/docs/InlineResponse20010.md +11 -1
- data/docs/InlineResponse20011.md +10 -0
- data/docs/InlineResponse20012.md +13 -1
- data/docs/InlineResponse20013.md +11 -1
- data/docs/InlineResponse20014.md +10 -0
- data/docs/InlineResponse20015.md +11 -1
- data/docs/InlineResponse20016.md +11 -1
- data/docs/InlineResponse20017.md +10 -0
- data/docs/InlineResponse20018.md +11 -1
- data/docs/InlineResponse20019.md +10 -0
- data/docs/InlineResponse2002.md +11 -1
- data/docs/InlineResponse20020.md +12 -2
- data/docs/InlineResponse20021.md +11 -1
- data/docs/InlineResponse20022.md +11 -1
- data/docs/InlineResponse20023.md +11 -1
- data/docs/InlineResponse20024.md +11 -1
- data/docs/InlineResponse20025.md +11 -1
- data/docs/InlineResponse20026.md +12 -3
- data/docs/InlineResponse20027.md +11 -1
- data/docs/InlineResponse20028.md +14 -2
- data/docs/InlineResponse20029.md +11 -1
- data/docs/InlineResponse2003.md +11 -1
- data/docs/InlineResponse20030.md +19 -0
- data/docs/InlineResponse2004.md +11 -1
- data/docs/InlineResponse2005.md +11 -1
- data/docs/InlineResponse2006.md +10 -0
- data/docs/InlineResponse2007.md +11 -1
- data/docs/InlineResponse2008.md +10 -0
- data/docs/InlineResponse2009.md +10 -0
- data/docs/IntegrationApi.md +302 -113
- data/docs/IntegrationEntity.md +11 -1
- data/docs/IntegrationEvent.md +12 -1
- data/docs/IntegrationProfileEntity.md +9 -0
- data/docs/IntegrationRequest.md +19 -0
- data/docs/IntegrationState.md +13 -0
- data/docs/IntegrationStateV2.md +37 -0
- data/docs/LedgerEntry.md +18 -0
- data/docs/LibraryAttribute.md +15 -0
- data/docs/LimitConfig.md +11 -0
- data/docs/LoginParams.md +10 -0
- data/docs/Loyalty.md +9 -0
- data/docs/LoyaltyLedger.md +11 -1
- data/docs/LoyaltyLedgerEntry.md +23 -1
- data/docs/LoyaltyMembership.md +10 -0
- data/docs/LoyaltyPoints.md +15 -1
- data/docs/LoyaltyProgram.md +20 -2
- data/docs/LoyaltyProgramBalance.md +18 -1
- data/docs/LoyaltyProgramLedgers.md +16 -2
- data/docs/LoyaltyStatistics.md +23 -0
- data/docs/LoyaltySubLedger.md +28 -3
- data/docs/ManagementApi.md +1419 -952
- data/docs/ManagerConfig.md +9 -0
- data/docs/Meta.md +16 -3
- data/docs/MultiApplicationEntity.md +9 -0
- data/docs/MultipleCustomerProfileIntegrationRequest.md +17 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +19 -0
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +17 -0
- data/docs/MutableEntity.md +9 -0
- data/docs/NewAccount.md +9 -0
- data/docs/NewAccountSignUp.md +11 -0
- data/docs/NewAdditionalCost.md +23 -0
- data/docs/NewApplication.md +30 -1
- data/docs/NewApplicationAPIKey.md +20 -2
- data/docs/NewAttribute.md +20 -2
- data/docs/NewAudience.md +21 -0
- data/docs/NewCampaign.md +23 -1
- data/docs/NewCampaignGroup.md +23 -0
- data/docs/NewCampaignSet.md +12 -0
- data/docs/NewCoupons.md +22 -3
- data/docs/NewCouponsForMultipleRecipients.md +31 -0
- data/docs/NewCustomerProfile.md +10 -1
- data/docs/NewCustomerSession.md +17 -1
- data/docs/NewCustomerSessionV2.md +31 -0
- data/docs/NewEvent.md +13 -1
- data/docs/NewEventType.md +19 -1
- data/docs/NewFeatureFlags.md +14 -3
- data/docs/NewInvitation.md +12 -0
- data/docs/NewInviteEmail.md +10 -0
- data/docs/NewLoyaltyProgram.md +18 -2
- data/docs/NewPassword.md +10 -0
- data/docs/NewPasswordEmail.md +9 -0
- data/docs/NewReferral.md +13 -0
- data/docs/NewRole.md +12 -0
- data/docs/NewRuleset.md +13 -1
- data/docs/NewSamlConnection.md +18 -1
- data/docs/NewTemplateDef.md +16 -1
- data/docs/NewUser.md +12 -0
- data/docs/NewWebhook.md +17 -1
- data/docs/Notification.md +11 -0
- data/docs/ProfileAudiencesChanges.md +19 -0
- data/docs/RedeemReferralEffectProps.md +19 -0
- data/docs/Referral.md +18 -0
- data/docs/ReferralCreatedEffectProps.md +17 -0
- data/docs/ReferralRejectionReason.md +11 -0
- data/docs/RejectCouponEffectProps.md +25 -0
- data/docs/RejectReferralEffectProps.md +25 -0
- data/docs/Role.md +18 -2
- data/docs/RoleAssign.md +10 -0
- data/docs/RoleMembership.md +10 -0
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +25 -0
- data/docs/RollbackCouponEffectProps.md +17 -0
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +29 -0
- data/docs/RollbackDiscountEffectProps.md +19 -0
- data/docs/RollbackReferralEffectProps.md +17 -0
- data/docs/Rule.md +13 -0
- data/docs/RuleFailureReason.md +39 -0
- data/docs/Ruleset.md +18 -1
- data/docs/SamlConnection.md +20 -1
- data/docs/SamlConnectionMetadata.md +13 -1
- data/docs/SamlLoginEndpoint.md +19 -0
- data/docs/Session.md +11 -0
- data/docs/SetDiscountEffectProps.md +21 -0
- data/docs/SetDiscountPerItemEffectProps.md +23 -0
- data/docs/ShowBundleMetadataEffectProps.md +21 -0
- data/docs/ShowNotificationEffectProps.md +21 -0
- data/docs/SlotDef.md +15 -1
- data/docs/TemplateArgDef.md +13 -1
- data/docs/TemplateDef.md +20 -1
- data/docs/TriggerWebhookEffectProps.md +19 -0
- data/docs/UpdateAccount.md +16 -1
- data/docs/UpdateApplication.md +29 -1
- data/docs/UpdateAttributeEffectProps.md +19 -0
- data/docs/UpdateAudience.md +17 -0
- data/docs/UpdateCampaign.md +23 -1
- data/docs/UpdateCampaignGroup.md +23 -0
- data/docs/UpdateCoupon.md +16 -1
- data/docs/UpdateCouponBatch.md +16 -1
- data/docs/UpdateLoyaltyProgram.md +17 -2
- data/docs/UpdateRole.md +13 -1
- data/docs/UpdateUser.md +14 -6
- data/docs/UpdateUserLatestFeedTimestamp.md +17 -0
- data/docs/User.md +25 -5
- data/docs/UserEntity.md +9 -0
- data/docs/UserFeedNotifications.md +19 -0
- data/docs/Webhook.md +20 -1
- data/docs/WebhookActivationLogEntry.md +13 -0
- data/docs/WebhookLogEntry.md +18 -0
- data/lib/talon_one.rb +89 -39
- data/lib/talon_one/api/integration_api.rb +509 -189
- data/lib/talon_one/api/management_api.rb +2930 -1563
- data/lib/talon_one/api_client.rb +45 -46
- data/lib/talon_one/api_error.rb +22 -3
- data/lib/talon_one/configuration.rb +48 -9
- data/lib/talon_one/models/accept_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/accept_referral_effect_props.rb +213 -0
- data/lib/talon_one/models/access_log_entry.rb +47 -24
- data/lib/talon_one/models/account.rb +72 -49
- data/lib/talon_one/models/account_additional_cost.rb +300 -0
- data/lib/talon_one/models/account_analytics.rb +153 -85
- data/lib/talon_one/models/account_entity.rb +39 -16
- data/lib/talon_one/models/account_limits.rb +83 -55
- data/lib/talon_one/models/add_free_item_effect_props.rb +228 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +308 -0
- data/lib/talon_one/models/additional_cost.rb +211 -0
- data/lib/talon_one/models/api_error.rb +40 -17
- data/lib/talon_one/models/application.rb +144 -77
- data/lib/talon_one/models/application_api_health.rb +43 -20
- data/lib/talon_one/models/application_api_key.rb +121 -53
- data/lib/talon_one/models/application_customer.rb +66 -31
- data/lib/talon_one/models/application_customer_entity.rb +39 -16
- data/lib/talon_one/models/application_customer_search.rb +42 -19
- data/lib/talon_one/models/application_entity.rb +39 -16
- data/lib/talon_one/models/application_event.rb +64 -29
- data/lib/talon_one/models/application_session.rb +73 -35
- data/lib/talon_one/models/application_session_entity.rb +39 -16
- data/lib/talon_one/models/attribute.rb +73 -38
- data/lib/talon_one/models/attributes_mandatory.rb +39 -16
- data/lib/talon_one/models/attributes_settings.rb +38 -15
- data/lib/talon_one/models/audience.rb +360 -0
- data/lib/talon_one/models/audience_membership.rb +227 -0
- data/lib/talon_one/models/base_saml_connection.rb +51 -28
- data/lib/talon_one/models/binding.rb +50 -17
- data/lib/talon_one/models/campaign.rb +144 -59
- data/lib/talon_one/models/campaign_analytics.rb +142 -59
- data/lib/talon_one/models/campaign_copy.rb +47 -24
- data/lib/talon_one/models/campaign_entity.rb +39 -16
- data/lib/talon_one/models/campaign_group.rb +326 -0
- data/lib/talon_one/models/campaign_group_entity.rb +209 -0
- data/lib/talon_one/models/campaign_search.rb +38 -15
- data/lib/talon_one/models/campaign_set.rb +77 -20
- data/lib/talon_one/models/campaign_set_branch_node.rb +47 -24
- data/lib/talon_one/models/campaign_set_leaf_node.rb +43 -20
- data/lib/talon_one/models/campaign_set_node.rb +38 -15
- data/lib/talon_one/models/cart_item.rb +52 -38
- data/lib/talon_one/models/change.rb +55 -22
- data/lib/talon_one/models/change_profile_password.rb +227 -0
- data/lib/talon_one/models/code_generator_settings.rb +50 -18
- data/lib/talon_one/models/coupon.rb +117 -40
- data/lib/talon_one/models/coupon_constraints.rb +78 -21
- data/lib/talon_one/models/coupon_created_effect_props.rb +228 -0
- data/lib/talon_one/models/coupon_rejection_reason.rb +45 -22
- data/lib/talon_one/models/coupon_reservations.rb +39 -16
- data/lib/talon_one/models/coupon_search.rb +38 -15
- data/lib/talon_one/models/coupon_value.rb +38 -15
- data/lib/talon_one/models/create_application_api_key.rb +87 -20
- data/lib/talon_one/models/customer_activity_report.rb +62 -39
- data/lib/talon_one/models/customer_analytics.rb +51 -28
- data/lib/talon_one/models/customer_inventory.rb +63 -20
- data/lib/talon_one/models/customer_profile.rb +65 -30
- data/lib/talon_one/models/customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +273 -0
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +251 -0
- data/lib/talon_one/models/customer_profile_search_query.rb +42 -19
- data/lib/talon_one/models/customer_session.rb +98 -37
- data/lib/talon_one/models/customer_session_v2.rb +462 -0
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +273 -0
- data/lib/talon_one/models/effect.rb +297 -0
- data/lib/talon_one/models/effect_entity.rb +283 -0
- data/lib/talon_one/models/email_entity.rb +38 -15
- data/lib/talon_one/models/entity.rb +39 -16
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +227 -0
- data/lib/talon_one/models/environment.rb +45 -22
- data/lib/talon_one/models/error_effect_props.rb +213 -0
- data/lib/talon_one/models/error_response.rb +39 -16
- data/lib/talon_one/models/error_source.rb +41 -18
- data/lib/talon_one/models/event.rb +51 -28
- data/lib/talon_one/models/event_type.rb +59 -36
- data/lib/talon_one/models/export.rb +48 -25
- data/lib/talon_one/models/feature_flag.rb +41 -18
- data/lib/talon_one/models/feature_flags.rb +46 -23
- data/lib/talon_one/models/features_feed.rb +40 -17
- data/lib/talon_one/models/feed_notification.rb +322 -0
- data/lib/talon_one/models/func_arg_def.rb +42 -19
- data/lib/talon_one/models/function_def.rb +42 -19
- data/lib/talon_one/models/import.rb +46 -57
- data/lib/talon_one/models/{inline_response_200.rb → inline_response200.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_2.rb → inline_response2001.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_10.rb → inline_response20010.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_11.rb → inline_response20011.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_12.rb → inline_response20012.rb} +50 -23
- data/lib/talon_one/models/{inline_response_200_13.rb → inline_response20013.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_14.rb → inline_response20014.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_15.rb → inline_response20015.rb} +41 -18
- data/lib/talon_one/models/inline_response20016.rb +222 -0
- data/lib/talon_one/models/{inline_response_200_17.rb → inline_response20017.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_18.rb → inline_response20018.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_19.rb → inline_response20019.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_3.rb → inline_response2002.rb} +41 -18
- data/lib/talon_one/models/inline_response20020.rb +222 -0
- data/lib/talon_one/models/{inline_response_200_20.rb → inline_response20021.rb} +41 -18
- data/lib/talon_one/models/inline_response20022.rb +227 -0
- data/lib/talon_one/models/{inline_response_200_21.rb → inline_response20023.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_22.rb → inline_response20024.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_23.rb → inline_response20025.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_24.rb → inline_response20026.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_25.rb → inline_response20027.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_26.rb → inline_response20028.rb} +44 -21
- data/lib/talon_one/models/{inline_response_200_27.rb → inline_response20029.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_4.rb → inline_response2003.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_29.rb → inline_response20030.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_1.rb → inline_response2004.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_5.rb → inline_response2005.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_6.rb → inline_response2006.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_7.rb → inline_response2007.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_8.rb → inline_response2008.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_9.rb → inline_response2009.rb} +40 -17
- data/lib/talon_one/models/integration_entity.rb +41 -18
- data/lib/talon_one/models/integration_event.rb +41 -18
- data/lib/talon_one/models/integration_profile_entity.rb +39 -16
- data/lib/talon_one/models/integration_request.rb +246 -0
- data/lib/talon_one/models/integration_state.rb +42 -19
- data/lib/talon_one/models/integration_state_v2.rb +324 -0
- data/lib/talon_one/models/ledger_entry.rb +53 -30
- data/lib/talon_one/models/library_attribute.rb +50 -27
- data/lib/talon_one/models/limit_config.rb +40 -29
- data/lib/talon_one/models/login_params.rb +39 -16
- data/lib/talon_one/models/loyalty.rb +38 -15
- data/lib/talon_one/models/loyalty_ledger.rb +40 -18
- data/lib/talon_one/models/loyalty_ledger_entry.rb +76 -67
- data/lib/talon_one/models/loyalty_membership.rb +40 -17
- data/lib/talon_one/models/loyalty_points.rb +87 -26
- data/lib/talon_one/models/loyalty_program.rb +67 -29
- data/lib/talon_one/models/loyalty_program_balance.rb +104 -20
- data/lib/talon_one/models/loyalty_program_ledgers.rb +59 -22
- data/lib/talon_one/models/loyalty_statistics.rb +258 -0
- data/lib/talon_one/models/loyalty_sub_ledger.rb +144 -24
- data/lib/talon_one/models/manager_config.rb +39 -16
- data/lib/talon_one/models/meta.rb +45 -21
- data/lib/talon_one/models/multi_application_entity.rb +39 -16
- data/lib/talon_one/models/{new_import.rb → multiple_customer_profile_integration_request.rb} +47 -63
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +223 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +208 -0
- data/lib/talon_one/models/mutable_entity.rb +38 -15
- data/lib/talon_one/models/new_account.rb +39 -16
- data/lib/talon_one/models/new_account_sign_up.rb +41 -18
- data/lib/talon_one/models/new_additional_cost.rb +255 -0
- data/lib/talon_one/models/new_application.rb +153 -50
- data/lib/talon_one/models/new_application_api_key.rb +119 -52
- data/lib/talon_one/models/new_attribute.rb +69 -34
- data/lib/talon_one/models/new_audience.rb +314 -0
- data/lib/talon_one/models/new_campaign.rb +73 -38
- data/lib/talon_one/models/new_campaign_group.rb +265 -0
- data/lib/talon_one/models/new_campaign_set.rb +75 -18
- data/lib/talon_one/models/new_coupons.rb +116 -64
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +368 -0
- data/lib/talon_one/models/new_customer_profile.rb +38 -15
- data/lib/talon_one/models/new_customer_session.rb +80 -27
- data/lib/talon_one/models/new_customer_session_v2.rb +337 -0
- data/lib/talon_one/models/new_event.rb +43 -20
- data/lib/talon_one/models/new_event_type.rb +57 -34
- data/lib/talon_one/models/new_feature_flags.rb +44 -21
- data/lib/talon_one/models/new_invitation.rb +41 -18
- data/lib/talon_one/models/new_invite_email.rb +39 -16
- data/lib/talon_one/models/new_loyalty_program.rb +64 -26
- data/lib/talon_one/models/new_password.rb +40 -17
- data/lib/talon_one/models/new_password_email.rb +38 -15
- data/lib/talon_one/models/new_referral.rb +47 -24
- data/lib/talon_one/models/new_role.rb +41 -18
- data/lib/talon_one/models/new_ruleset.rb +43 -20
- data/lib/talon_one/models/new_saml_connection.rb +52 -29
- data/lib/talon_one/models/new_template_def.rb +45 -22
- data/lib/talon_one/models/new_user.rb +42 -19
- data/lib/talon_one/models/new_webhook.rb +50 -27
- data/lib/talon_one/models/notification.rb +40 -17
- data/lib/talon_one/models/profile_audiences_changes.rb +231 -0
- data/lib/talon_one/models/redeem_referral_effect_props.rb +228 -0
- data/lib/talon_one/models/referral.rb +54 -31
- data/lib/talon_one/models/referral_created_effect_props.rb +213 -0
- data/lib/talon_one/models/referral_rejection_reason.rb +45 -22
- data/lib/talon_one/models/reject_coupon_effect_props.rb +258 -0
- data/lib/talon_one/models/reject_referral_effect_props.rb +258 -0
- data/lib/talon_one/models/role.rb +58 -25
- data/lib/talon_one/models/role_assign.rb +39 -16
- data/lib/talon_one/models/role_membership.rb +41 -18
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +273 -0
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +293 -0
- data/lib/talon_one/models/rollback_discount_effect_props.rb +228 -0
- data/lib/talon_one/models/rollback_referral_effect_props.rb +213 -0
- data/lib/talon_one/models/rule.rb +42 -19
- data/lib/talon_one/models/rule_failure_reason.rb +343 -0
- data/lib/talon_one/models/ruleset.rb +51 -28
- data/lib/talon_one/models/saml_connection.rb +55 -32
- data/lib/talon_one/models/saml_connection_metadata.rb +44 -21
- data/lib/talon_one/models/{cart_item_adjustment.rb → saml_login_endpoint.rb} +81 -64
- data/lib/talon_one/models/session.rb +41 -18
- data/lib/talon_one/models/set_discount_effect_props.rb +238 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +253 -0
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +247 -0
- data/lib/talon_one/models/show_notification_effect_props.rb +243 -0
- data/lib/talon_one/models/slot_def.rb +44 -21
- data/lib/talon_one/models/template_arg_def.rb +44 -21
- data/lib/talon_one/models/template_def.rb +50 -27
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +228 -0
- data/lib/talon_one/models/update_account.rb +100 -23
- data/lib/talon_one/models/update_application.rb +150 -31
- data/lib/talon_one/models/update_attribute_effect_props.rb +228 -0
- data/lib/talon_one/models/update_audience.rb +231 -0
- data/lib/talon_one/models/update_campaign.rb +73 -38
- data/lib/talon_one/models/update_campaign_group.rb +266 -0
- data/lib/talon_one/models/update_coupon.rb +81 -24
- data/lib/talon_one/models/update_coupon_batch.rb +81 -24
- data/lib/talon_one/models/update_loyalty_program.rb +58 -25
- data/lib/talon_one/models/update_role.rb +42 -19
- data/lib/talon_one/models/update_user.rb +47 -80
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +213 -0
- data/lib/talon_one/models/user.rb +67 -59
- data/lib/talon_one/models/user_entity.rb +39 -16
- data/lib/talon_one/models/user_feed_notifications.rb +230 -0
- data/lib/talon_one/models/webhook.rb +53 -30
- data/lib/talon_one/models/webhook_activation_log_entry.rb +46 -23
- data/lib/talon_one/models/webhook_log_entry.rb +52 -29
- data/lib/talon_one/version.rb +4 -4
- data/spec/api/integration_api_spec.rb +74 -27
- data/spec/api/management_api_spec.rb +294 -181
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/{new_import_spec.rb → accept_coupon_effect_props_spec.rb} +11 -15
- data/spec/models/accept_referral_effect_props_spec.rb +41 -0
- data/spec/models/access_log_entry_spec.rb +4 -4
- data/spec/models/account_additional_cost_spec.rb +77 -0
- data/spec/models/account_analytics_spec.rb +30 -12
- data/spec/models/account_entity_spec.rb +4 -4
- data/spec/models/account_limits_spec.rb +10 -10
- data/spec/models/account_spec.rb +5 -5
- data/spec/models/add_free_item_effect_props_spec.rb +47 -0
- data/spec/models/add_loyalty_points_effect_props_spec.rb +83 -0
- data/spec/models/{import_coupons_spec.rb → additional_cost_spec.rb} +11 -11
- data/spec/models/api_error_spec.rb +4 -4
- data/spec/models/application_api_health_spec.rb +4 -4
- data/spec/models/application_api_key_spec.rb +21 -11
- data/spec/models/application_customer_entity_spec.rb +4 -4
- data/spec/models/application_customer_search_spec.rb +4 -4
- data/spec/models/application_customer_spec.rb +10 -4
- data/spec/models/application_entity_spec.rb +4 -4
- data/spec/models/application_event_spec.rb +10 -4
- data/spec/models/application_session_entity_spec.rb +4 -4
- data/spec/models/application_session_spec.rb +10 -4
- data/spec/models/application_spec.rb +47 -5
- data/spec/models/attribute_spec.rb +10 -4
- data/spec/models/attributes_mandatory_spec.rb +4 -4
- data/spec/models/attributes_settings_spec.rb +4 -4
- data/spec/models/audience_membership_spec.rb +47 -0
- data/spec/models/audience_spec.rb +75 -0
- data/spec/models/base_saml_connection_spec.rb +4 -4
- data/spec/models/binding_spec.rb +10 -4
- data/spec/models/campaign_analytics_spec.rb +28 -4
- data/spec/models/campaign_copy_spec.rb +4 -4
- data/spec/models/campaign_entity_spec.rb +4 -4
- data/spec/models/campaign_group_entity_spec.rb +41 -0
- data/spec/models/campaign_group_spec.rb +83 -0
- data/spec/models/campaign_search_spec.rb +4 -4
- data/spec/models/campaign_set_branch_node_spec.rb +4 -4
- data/spec/models/campaign_set_leaf_node_spec.rb +4 -4
- data/spec/models/campaign_set_node_spec.rb +4 -4
- data/spec/models/campaign_set_spec.rb +10 -4
- data/spec/models/campaign_spec.rb +40 -4
- data/spec/models/cart_item_spec.rb +4 -10
- data/spec/models/change_profile_password_spec.rb +47 -0
- data/spec/models/change_spec.rb +10 -4
- data/spec/models/code_generator_settings_spec.rb +4 -4
- data/spec/models/coupon_constraints_spec.rb +10 -4
- data/spec/models/coupon_created_effect_props_spec.rb +47 -0
- data/spec/models/coupon_rejection_reason_spec.rb +5 -5
- data/spec/models/coupon_reservations_spec.rb +4 -4
- data/spec/models/coupon_search_spec.rb +4 -4
- data/spec/models/coupon_spec.rb +22 -4
- data/spec/models/coupon_value_spec.rb +4 -4
- data/spec/models/create_application_api_key_spec.rb +14 -4
- data/spec/models/customer_activity_report_spec.rb +4 -4
- data/spec/models/customer_analytics_spec.rb +4 -4
- data/spec/models/customer_inventory_spec.rb +16 -4
- data/spec/models/customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/customer_profile_integration_request_v2_spec.rb +57 -0
- data/spec/models/customer_profile_search_query_spec.rb +4 -4
- data/spec/models/customer_profile_spec.rb +10 -4
- data/spec/models/customer_session_spec.rb +4 -4
- data/spec/models/customer_session_v2_spec.rb +129 -0
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +65 -0
- data/spec/models/effect_entity_spec.rb +71 -0
- data/spec/models/effect_spec.rb +77 -0
- data/spec/models/email_entity_spec.rb +4 -4
- data/spec/models/entity_spec.rb +4 -4
- data/spec/models/entity_with_talang_visible_id_spec.rb +47 -0
- data/spec/models/environment_spec.rb +4 -4
- data/spec/models/error_effect_props_spec.rb +41 -0
- data/spec/models/error_response_spec.rb +4 -4
- data/spec/models/error_source_spec.rb +4 -4
- data/spec/models/event_spec.rb +4 -4
- data/spec/models/event_type_spec.rb +4 -4
- data/spec/models/export_spec.rb +4 -4
- data/spec/models/feature_flag_spec.rb +4 -4
- data/spec/models/feature_flags_spec.rb +4 -4
- data/spec/models/features_feed_spec.rb +4 -4
- data/spec/models/feed_notification_spec.rb +75 -0
- data/spec/models/func_arg_def_spec.rb +4 -4
- data/spec/models/function_def_spec.rb +4 -4
- data/spec/models/import_spec.rb +4 -8
- data/spec/models/{inline_response_200_10_spec.rb → inline_response20010_spec.rb} +4 -4
- data/spec/models/{inline_response_200_11_spec.rb → inline_response20011_spec.rb} +4 -4
- data/spec/models/{inline_response_200_12_spec.rb → inline_response20012_spec.rb} +10 -4
- data/spec/models/{inline_response_200_13_spec.rb → inline_response20013_spec.rb} +4 -4
- data/spec/models/{inline_response_200_14_spec.rb → inline_response20014_spec.rb} +4 -4
- data/spec/models/{inline_response_200_15_spec.rb → inline_response20015_spec.rb} +4 -4
- data/spec/models/{inline_response_200_16_spec.rb → inline_response20016_spec.rb} +5 -5
- data/spec/models/{inline_response_200_17_spec.rb → inline_response20017_spec.rb} +4 -4
- data/spec/models/{inline_response_200_18_spec.rb → inline_response20018_spec.rb} +4 -4
- data/spec/models/{inline_response_200_19_spec.rb → inline_response20019_spec.rb} +4 -4
- data/spec/models/{inline_response_200_1_spec.rb → inline_response2001_spec.rb} +4 -4
- data/spec/models/{inline_response_200_20_spec.rb → inline_response20020_spec.rb} +4 -4
- data/spec/models/{inline_response_200_21_spec.rb → inline_response20021_spec.rb} +4 -4
- data/spec/models/{inline_response_200_22_spec.rb → inline_response20022_spec.rb} +4 -4
- data/spec/models/{inline_response_200_23_spec.rb → inline_response20023_spec.rb} +4 -4
- data/spec/models/{inline_response_200_24_spec.rb → inline_response20024_spec.rb} +4 -4
- data/spec/models/{inline_response_200_25_spec.rb → inline_response20025_spec.rb} +4 -4
- data/spec/models/{inline_response_200_26_spec.rb → inline_response20026_spec.rb} +4 -10
- data/spec/models/{inline_response_200_27_spec.rb → inline_response20027_spec.rb} +4 -4
- data/spec/models/{inline_response_200_28_spec.rb → inline_response20028_spec.rb} +10 -4
- data/spec/models/{inline_response_200_29_spec.rb → inline_response20029_spec.rb} +4 -4
- data/spec/models/{inline_response_200_2_spec.rb → inline_response2002_spec.rb} +4 -4
- data/spec/models/inline_response20030_spec.rb +47 -0
- data/spec/models/{inline_response_200_3_spec.rb → inline_response2003_spec.rb} +4 -4
- data/spec/models/{inline_response_200_4_spec.rb → inline_response2004_spec.rb} +4 -4
- data/spec/models/{inline_response_200_5_spec.rb → inline_response2005_spec.rb} +4 -4
- data/spec/models/{inline_response_200_6_spec.rb → inline_response2006_spec.rb} +4 -4
- data/spec/models/{inline_response_200_7_spec.rb → inline_response2007_spec.rb} +4 -4
- data/spec/models/{inline_response_200_8_spec.rb → inline_response2008_spec.rb} +4 -4
- data/spec/models/{inline_response_200_9_spec.rb → inline_response2009_spec.rb} +4 -4
- data/spec/models/{inline_response_200_spec.rb → inline_response200_spec.rb} +4 -4
- data/spec/models/integration_entity_spec.rb +4 -4
- data/spec/models/integration_event_spec.rb +4 -4
- data/spec/models/integration_profile_entity_spec.rb +4 -4
- data/spec/models/integration_request_spec.rb +51 -0
- data/spec/models/integration_state_spec.rb +4 -4
- data/spec/models/integration_state_v2_spec.rb +101 -0
- data/spec/models/ledger_entry_spec.rb +4 -4
- data/spec/models/library_attribute_spec.rb +4 -4
- data/spec/models/limit_config_spec.rb +4 -8
- data/spec/models/login_params_spec.rb +4 -4
- data/spec/models/loyalty_ledger_entry_spec.rb +16 -8
- data/spec/models/loyalty_ledger_spec.rb +4 -4
- data/spec/models/loyalty_membership_spec.rb +4 -4
- data/spec/models/loyalty_points_spec.rb +11 -5
- data/spec/models/loyalty_program_balance_spec.rb +28 -4
- data/spec/models/loyalty_program_ledgers_spec.rb +10 -4
- data/spec/models/loyalty_program_spec.rb +10 -4
- data/spec/models/loyalty_spec.rb +4 -4
- data/spec/models/loyalty_statistics_spec.rb +59 -0
- data/spec/models/loyalty_sub_ledger_spec.rb +46 -4
- data/spec/models/manager_config_spec.rb +4 -4
- data/spec/models/meta_spec.rb +4 -4
- data/spec/models/multi_application_entity_spec.rb +4 -4
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +47 -0
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +41 -0
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +4 -4
- data/spec/models/new_account_sign_up_spec.rb +4 -4
- data/spec/models/new_account_spec.rb +4 -4
- data/spec/models/new_additional_cost_spec.rb +59 -0
- data/spec/models/new_application_api_key_spec.rb +21 -11
- data/spec/models/new_application_spec.rb +52 -4
- data/spec/models/new_attribute_spec.rb +10 -4
- data/spec/models/new_audience_spec.rb +57 -0
- data/spec/models/new_campaign_group_spec.rb +59 -0
- data/spec/models/new_campaign_set_spec.rb +10 -4
- data/spec/models/new_campaign_spec.rb +10 -4
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +83 -0
- data/spec/models/new_coupons_spec.rb +16 -10
- data/spec/models/new_customer_profile_spec.rb +4 -4
- data/spec/models/new_customer_session_spec.rb +4 -4
- data/spec/models/new_customer_session_v2_spec.rb +87 -0
- data/spec/models/new_event_spec.rb +4 -4
- data/spec/models/new_event_type_spec.rb +4 -4
- data/spec/models/new_feature_flags_spec.rb +4 -4
- data/spec/models/new_invitation_spec.rb +4 -4
- data/spec/models/new_invite_email_spec.rb +4 -4
- data/spec/models/new_loyalty_program_spec.rb +10 -4
- data/spec/models/new_password_email_spec.rb +4 -4
- data/spec/models/new_password_spec.rb +4 -4
- data/spec/models/new_referral_spec.rb +4 -4
- data/spec/models/new_role_spec.rb +4 -4
- data/spec/models/new_ruleset_spec.rb +4 -4
- data/spec/models/new_saml_connection_spec.rb +4 -4
- data/spec/models/new_template_def_spec.rb +4 -4
- data/spec/models/new_user_spec.rb +4 -4
- data/spec/models/new_webhook_spec.rb +4 -4
- data/spec/models/notification_spec.rb +4 -4
- data/spec/models/profile_audiences_changes_spec.rb +47 -0
- data/spec/models/redeem_referral_effect_props_spec.rb +47 -0
- data/spec/models/referral_created_effect_props_spec.rb +41 -0
- data/spec/models/referral_rejection_reason_spec.rb +5 -5
- data/spec/models/referral_spec.rb +4 -4
- data/spec/models/reject_coupon_effect_props_spec.rb +65 -0
- data/spec/models/reject_referral_effect_props_spec.rb +65 -0
- data/spec/models/role_assign_spec.rb +4 -4
- data/spec/models/role_membership_spec.rb +4 -4
- data/spec/models/role_spec.rb +10 -4
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +65 -0
- data/spec/models/rollback_coupon_effect_props_spec.rb +41 -0
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +77 -0
- data/spec/models/rollback_discount_effect_props_spec.rb +47 -0
- data/spec/models/{misc_update_user_latest_feature_spec.rb → rollback_referral_effect_props_spec.rb} +11 -11
- data/spec/models/rule_failure_reason_spec.rb +107 -0
- data/spec/models/rule_spec.rb +4 -4
- data/spec/models/ruleset_spec.rb +4 -4
- data/spec/models/saml_connection_metadata_spec.rb +4 -4
- data/spec/models/saml_connection_spec.rb +4 -4
- data/spec/models/saml_login_endpoint_spec.rb +47 -0
- data/spec/models/session_spec.rb +4 -4
- data/spec/models/{cart_item_adjustment_spec.rb → set_discount_effect_props_spec.rb} +13 -13
- data/spec/models/set_discount_per_item_effect_props_spec.rb +59 -0
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +53 -0
- data/spec/models/show_notification_effect_props_spec.rb +53 -0
- data/spec/models/slot_def_spec.rb +4 -4
- data/spec/models/template_arg_def_spec.rb +4 -4
- data/spec/models/template_def_spec.rb +4 -4
- data/spec/models/trigger_webhook_effect_props_spec.rb +47 -0
- data/spec/models/update_account_spec.rb +20 -4
- data/spec/models/update_application_spec.rb +52 -4
- data/spec/models/update_attribute_effect_props_spec.rb +47 -0
- data/spec/models/update_audience_spec.rb +41 -0
- data/spec/models/update_campaign_group_spec.rb +59 -0
- data/spec/models/update_campaign_spec.rb +10 -4
- data/spec/models/update_coupon_batch_spec.rb +10 -4
- data/spec/models/update_coupon_spec.rb +10 -4
- data/spec/models/update_loyalty_program_spec.rb +10 -4
- data/spec/models/update_role_spec.rb +4 -4
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +41 -0
- data/spec/models/update_user_spec.rb +4 -34
- data/spec/models/user_entity_spec.rb +4 -4
- data/spec/models/user_feed_notifications_spec.rb +47 -0
- data/spec/models/user_spec.rb +5 -11
- data/spec/models/webhook_activation_log_entry_spec.rb +4 -4
- data/spec/models/webhook_log_entry_spec.rb +4 -4
- data/spec/models/webhook_spec.rb +4 -4
- data/spec/spec_helper.rb +3 -3
- data/talon_one.gemspec +6 -11
- metadata +317 -244
- data/CHANGELOG.md +0 -63
- data/docs/AttributeQuery.md +0 -7
- data/docs/CartItemAdjustment.md +0 -10
- data/docs/ImportCoupons.md +0 -8
- data/docs/MiscUpdateUserLatestFeature.md +0 -8
- data/docs/NewImport.md +0 -8
- data/docs/Notifications.md +0 -7
- data/git_push.sh +0 -55
- data/lib/talon_one/models/attribute_query.rb +0 -174
- data/lib/talon_one/models/import_coupons.rb +0 -188
- data/lib/talon_one/models/inline_response_200_16.rb +0 -204
- data/lib/talon_one/models/inline_response_200_28.rb +0 -204
- data/lib/talon_one/models/misc_update_user_latest_feature.rb +0 -183
- data/lib/talon_one/models/notifications.rb +0 -174
- data/spec/models/attribute_query_spec.rb +0 -35
- data/spec/models/notifications_spec.rb +0 -35
- data/talon_one-1.0.0.gem +0 -0
- data/talon_one-1.1.0.gem +0 -0
- data/talon_one-1.1.1.gem +0 -0
- data/talon_one-1.1.2.gem +0 -0
- data/talon_one-1.2.0.gem +0 -0
- data/talon_one-1.3.0.gem +0 -0
data/docs/InlineResponse20026.md
CHANGED
@@ -1,10 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20026
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**total_result_size** | **Integer** | |
|
7
|
-
**
|
8
|
-
|
7
|
+
**total_result_size** | **Integer** | |
|
8
|
+
**data** | [**Array<EventType>**](EventType.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20026.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
9
18
|
|
10
19
|
|
data/docs/InlineResponse20027.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20027
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
7
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<User>**](User.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20027.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse20028.md
CHANGED
@@ -1,9 +1,21 @@
|
|
1
1
|
# TalonOne::InlineResponse20028
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**total_result_size** | **Integer** | |
|
7
|
-
**
|
7
|
+
**total_result_size** | **Integer** | | [optional]
|
8
|
+
**has_more** | **Boolean** | | [optional]
|
9
|
+
**data** | [**Array<Change>**](Change.md) | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'TalonOne'
|
15
|
+
|
16
|
+
instance = TalonOne::InlineResponse20028.new(total_result_size: null,
|
17
|
+
has_more: null,
|
18
|
+
data: null)
|
19
|
+
```
|
8
20
|
|
9
21
|
|
data/docs/InlineResponse20029.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20029
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
7
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<Export>**](Export.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20029.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse2003.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse2003
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
7
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<Ruleset>**](Ruleset.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse2003.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::InlineResponse20030
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**total_result_size** | **Integer** | |
|
8
|
+
**data** | [**Array<Role>**](Role.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20030.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/InlineResponse2004.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse2004
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
7
|
**total_result_size** | **Integer** | |
|
7
|
-
**data** | [**Array<
|
8
|
+
**data** | [**Array<Coupon>**](Coupon.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse2004.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse2005.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse2005
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**has_more** | **
|
7
|
+
**has_more** | **Boolean** | |
|
7
8
|
**data** | [**Array<Coupon>**](Coupon.md) | |
|
8
9
|
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse2005.new(has_more: null,
|
16
|
+
data: null)
|
17
|
+
```
|
18
|
+
|
9
19
|
|
data/docs/InlineResponse2006.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse2006
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
7
|
**total_result_size** | **Integer** | |
|
7
8
|
**data** | [**Array<Referral>**](Referral.md) | |
|
8
9
|
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse2006.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
18
|
+
|
9
19
|
|
data/docs/InlineResponse2007.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse2007
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**has_more** | **
|
7
|
+
**has_more** | **Boolean** | |
|
7
8
|
**data** | [**Array<Referral>**](Referral.md) | |
|
8
9
|
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse2007.new(has_more: null,
|
16
|
+
data: null)
|
17
|
+
```
|
18
|
+
|
9
19
|
|
data/docs/InlineResponse2008.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse2008
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
7
|
**total_result_size** | **Integer** | |
|
7
8
|
**data** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | |
|
8
9
|
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse2008.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
18
|
+
|
9
19
|
|
data/docs/InlineResponse2009.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse2009
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
7
|
**total_result_size** | **Integer** | |
|
7
8
|
**data** | [**Array<AccessLogEntry>**](AccessLogEntry.md) | |
|
8
9
|
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse2009.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
18
|
+
|
9
19
|
|
data/docs/IntegrationApi.md
CHANGED
@@ -1,22 +1,27 @@
|
|
1
1
|
# TalonOne::IntegrationApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *http://localhost*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**create_coupon_reservation**](IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation
|
8
8
|
[**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
|
9
9
|
[**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
10
|
-
[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer
|
11
|
-
[**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
|
12
|
-
[**get_reserved_coupons**](IntegrationApi.md#get_reserved_coupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
|
10
|
+
[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer
|
11
|
+
[**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile
|
13
12
|
[**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
|
14
13
|
[**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
|
15
|
-
[**update_customer_profile**](IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
|
16
|
-
[**
|
14
|
+
[**update_customer_profile**](IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1
|
15
|
+
[**update_customer_profile_audiences**](IntegrationApi.md#update_customer_profile_audiences) | **POST** /v2/customer_audiences | Update a Customer Profile Audiences
|
16
|
+
[**update_customer_profile_v2**](IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{integrationId} | Update a Customer Profile
|
17
|
+
[**update_customer_profiles_v2**](IntegrationApi.md#update_customer_profiles_v2) | **PUT** /v2/customer_profiles | Update multiple Customer Profiles
|
18
|
+
[**update_customer_session**](IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session V1
|
19
|
+
[**update_customer_session_v2**](IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update a Customer Session
|
17
20
|
|
18
21
|
|
19
|
-
|
22
|
+
|
23
|
+
## create_coupon_reservation
|
24
|
+
|
20
25
|
> Coupon create_coupon_reservation(coupon_value, body)
|
21
26
|
|
22
27
|
Create a new coupon reservation
|
@@ -24,6 +29,7 @@ Create a new coupon reservation
|
|
24
29
|
Creates a coupon reservation for all passed customer profiles on this couponID
|
25
30
|
|
26
31
|
### Example
|
32
|
+
|
27
33
|
```ruby
|
28
34
|
# load the gem
|
29
35
|
require 'talon_one'
|
@@ -41,12 +47,9 @@ TalonOne.configure do |config|
|
|
41
47
|
end
|
42
48
|
|
43
49
|
api_instance = TalonOne::IntegrationApi.new
|
44
|
-
|
45
50
|
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
46
|
-
|
47
51
|
body = TalonOne::CouponReservations.new # CouponReservations |
|
48
52
|
|
49
|
-
|
50
53
|
begin
|
51
54
|
#Create a new coupon reservation
|
52
55
|
result = api_instance.create_coupon_reservation(coupon_value, body)
|
@@ -58,6 +61,7 @@ end
|
|
58
61
|
|
59
62
|
### Parameters
|
60
63
|
|
64
|
+
|
61
65
|
Name | Type | Description | Notes
|
62
66
|
------------- | ------------- | ------------- | -------------
|
63
67
|
**coupon_value** | **String**| The value of a coupon |
|
@@ -73,12 +77,12 @@ Name | Type | Description | Notes
|
|
73
77
|
|
74
78
|
### HTTP request headers
|
75
79
|
|
76
|
-
|
77
|
-
|
80
|
+
- **Content-Type**: application/json
|
81
|
+
- **Accept**: application/json
|
78
82
|
|
79
83
|
|
84
|
+
## create_referral
|
80
85
|
|
81
|
-
# **create_referral**
|
82
86
|
> Referral create_referral(body)
|
83
87
|
|
84
88
|
Create a referral code for an advocate
|
@@ -86,6 +90,7 @@ Create a referral code for an advocate
|
|
86
90
|
Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
|
87
91
|
|
88
92
|
### Example
|
93
|
+
|
89
94
|
```ruby
|
90
95
|
# load the gem
|
91
96
|
require 'talon_one'
|
@@ -103,10 +108,8 @@ TalonOne.configure do |config|
|
|
103
108
|
end
|
104
109
|
|
105
110
|
api_instance = TalonOne::IntegrationApi.new
|
106
|
-
|
107
111
|
body = TalonOne::NewReferral.new # NewReferral |
|
108
112
|
|
109
|
-
|
110
113
|
begin
|
111
114
|
#Create a referral code for an advocate
|
112
115
|
result = api_instance.create_referral(body)
|
@@ -118,6 +121,7 @@ end
|
|
118
121
|
|
119
122
|
### Parameters
|
120
123
|
|
124
|
+
|
121
125
|
Name | Type | Description | Notes
|
122
126
|
------------- | ------------- | ------------- | -------------
|
123
127
|
**body** | [**NewReferral**](NewReferral.md)| |
|
@@ -132,12 +136,12 @@ Name | Type | Description | Notes
|
|
132
136
|
|
133
137
|
### HTTP request headers
|
134
138
|
|
135
|
-
|
136
|
-
|
139
|
+
- **Content-Type**: application/json
|
140
|
+
- **Accept**: application/json
|
137
141
|
|
138
142
|
|
143
|
+
## delete_coupon_reservation
|
139
144
|
|
140
|
-
# **delete_coupon_reservation**
|
141
145
|
> delete_coupon_reservation(coupon_value, body)
|
142
146
|
|
143
147
|
Delete coupon reservations
|
@@ -145,6 +149,7 @@ Delete coupon reservations
|
|
145
149
|
Removes all passed customer profiles reservation from this coupon
|
146
150
|
|
147
151
|
### Example
|
152
|
+
|
148
153
|
```ruby
|
149
154
|
# load the gem
|
150
155
|
require 'talon_one'
|
@@ -162,12 +167,9 @@ TalonOne.configure do |config|
|
|
162
167
|
end
|
163
168
|
|
164
169
|
api_instance = TalonOne::IntegrationApi.new
|
165
|
-
|
166
170
|
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
167
|
-
|
168
171
|
body = TalonOne::CouponReservations.new # CouponReservations |
|
169
172
|
|
170
|
-
|
171
173
|
begin
|
172
174
|
#Delete coupon reservations
|
173
175
|
api_instance.delete_coupon_reservation(coupon_value, body)
|
@@ -178,6 +180,7 @@ end
|
|
178
180
|
|
179
181
|
### Parameters
|
180
182
|
|
183
|
+
|
181
184
|
Name | Type | Description | Notes
|
182
185
|
------------- | ------------- | ------------- | -------------
|
183
186
|
**coupon_value** | **String**| The value of a coupon |
|
@@ -193,19 +196,20 @@ nil (empty response body)
|
|
193
196
|
|
194
197
|
### HTTP request headers
|
195
198
|
|
196
|
-
|
197
|
-
|
199
|
+
- **Content-Type**: application/json
|
200
|
+
- **Accept**: Not defined
|
198
201
|
|
199
202
|
|
203
|
+
## delete_customer_data
|
200
204
|
|
201
|
-
# **delete_customer_data**
|
202
205
|
> delete_customer_data(integration_id)
|
203
206
|
|
204
|
-
Delete the personal data of a customer
|
207
|
+
Delete the personal data of a customer
|
205
208
|
|
206
209
|
Delete all attributes on the customer profile and on entities that reference that customer profile.
|
207
210
|
|
208
211
|
### Example
|
212
|
+
|
209
213
|
```ruby
|
210
214
|
# load the gem
|
211
215
|
require 'talon_one'
|
@@ -223,12 +227,10 @@ TalonOne.configure do |config|
|
|
223
227
|
end
|
224
228
|
|
225
229
|
api_instance = TalonOne::IntegrationApi.new
|
226
|
-
|
227
230
|
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
228
231
|
|
229
|
-
|
230
232
|
begin
|
231
|
-
#Delete the personal data of a customer
|
233
|
+
#Delete the personal data of a customer
|
232
234
|
api_instance.delete_customer_data(integration_id)
|
233
235
|
rescue TalonOne::ApiError => e
|
234
236
|
puts "Exception when calling IntegrationApi->delete_customer_data: #{e}"
|
@@ -237,6 +239,7 @@ end
|
|
237
239
|
|
238
240
|
### Parameters
|
239
241
|
|
242
|
+
|
240
243
|
Name | Type | Description | Notes
|
241
244
|
------------- | ------------- | ------------- | -------------
|
242
245
|
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
@@ -251,19 +254,20 @@ nil (empty response body)
|
|
251
254
|
|
252
255
|
### HTTP request headers
|
253
256
|
|
254
|
-
|
255
|
-
|
257
|
+
- **Content-Type**: Not defined
|
258
|
+
- **Accept**: Not defined
|
256
259
|
|
257
260
|
|
261
|
+
## get_customer_inventory
|
258
262
|
|
259
|
-
# **get_customer_inventory**
|
260
263
|
> CustomerInventory get_customer_inventory(integration_id, opts)
|
261
264
|
|
262
|
-
Get an inventory of all data associated with a specific customer profile
|
265
|
+
Get an inventory of all data associated with a specific customer profile
|
263
266
|
|
264
|
-
Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information and
|
267
|
+
Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points.
|
265
268
|
|
266
269
|
### Example
|
270
|
+
|
267
271
|
```ruby
|
268
272
|
# load the gem
|
269
273
|
require 'talon_one'
|
@@ -281,16 +285,16 @@ TalonOne.configure do |config|
|
|
281
285
|
end
|
282
286
|
|
283
287
|
api_instance = TalonOne::IntegrationApi.new
|
284
|
-
|
285
288
|
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
289
|
+
opts = {
|
290
|
+
profile: true, # Boolean | optional flag to decide if you would like customer profile information in the response
|
291
|
+
referrals: true, # Boolean | optional flag to decide if you would like referral information in the response
|
292
|
+
coupons: true, # Boolean | optional flag to decide if you would like coupon information in the response
|
293
|
+
loyalty: true # Boolean | optional flag to decide if you would like loyalty information in the response
|
290
294
|
}
|
291
295
|
|
292
296
|
begin
|
293
|
-
#Get an inventory of all data associated with a specific customer profile
|
297
|
+
#Get an inventory of all data associated with a specific customer profile
|
294
298
|
result = api_instance.get_customer_inventory(integration_id, opts)
|
295
299
|
p result
|
296
300
|
rescue TalonOne::ApiError => e
|
@@ -300,11 +304,14 @@ end
|
|
300
304
|
|
301
305
|
### Parameters
|
302
306
|
|
307
|
+
|
303
308
|
Name | Type | Description | Notes
|
304
309
|
------------- | ------------- | ------------- | -------------
|
305
310
|
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
306
|
-
**profile** |
|
307
|
-
**referrals** |
|
311
|
+
**profile** | **Boolean**| optional flag to decide if you would like customer profile information in the response | [optional]
|
312
|
+
**referrals** | **Boolean**| optional flag to decide if you would like referral information in the response | [optional]
|
313
|
+
**coupons** | **Boolean**| optional flag to decide if you would like coupon information in the response | [optional]
|
314
|
+
**loyalty** | **Boolean**| optional flag to decide if you would like loyalty information in the response | [optional]
|
308
315
|
|
309
316
|
### Return type
|
310
317
|
|
@@ -316,19 +323,20 @@ Name | Type | Description | Notes
|
|
316
323
|
|
317
324
|
### HTTP request headers
|
318
325
|
|
319
|
-
|
320
|
-
|
326
|
+
- **Content-Type**: Not defined
|
327
|
+
- **Accept**: application/json
|
321
328
|
|
322
329
|
|
330
|
+
## get_reserved_customers
|
323
331
|
|
324
|
-
|
325
|
-
> InlineResponse2001 get_reserved_coupons(integration_id)
|
332
|
+
> InlineResponse200 get_reserved_customers(coupon_value)
|
326
333
|
|
327
|
-
Get
|
334
|
+
Get the users that have this coupon reserved
|
328
335
|
|
329
|
-
Returns all
|
336
|
+
Returns all users that have this coupon marked as reserved
|
330
337
|
|
331
338
|
### Example
|
339
|
+
|
332
340
|
```ruby
|
333
341
|
# load the gem
|
334
342
|
require 'talon_one'
|
@@ -346,28 +354,27 @@ TalonOne.configure do |config|
|
|
346
354
|
end
|
347
355
|
|
348
356
|
api_instance = TalonOne::IntegrationApi.new
|
349
|
-
|
350
|
-
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
351
|
-
|
357
|
+
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
352
358
|
|
353
359
|
begin
|
354
|
-
#Get
|
355
|
-
result = api_instance.
|
360
|
+
#Get the users that have this coupon reserved
|
361
|
+
result = api_instance.get_reserved_customers(coupon_value)
|
356
362
|
p result
|
357
363
|
rescue TalonOne::ApiError => e
|
358
|
-
puts "Exception when calling IntegrationApi->
|
364
|
+
puts "Exception when calling IntegrationApi->get_reserved_customers: #{e}"
|
359
365
|
end
|
360
366
|
```
|
361
367
|
|
362
368
|
### Parameters
|
363
369
|
|
370
|
+
|
364
371
|
Name | Type | Description | Notes
|
365
372
|
------------- | ------------- | ------------- | -------------
|
366
|
-
**
|
373
|
+
**coupon_value** | **String**| The value of a coupon |
|
367
374
|
|
368
375
|
### Return type
|
369
376
|
|
370
|
-
[**
|
377
|
+
[**InlineResponse200**](InlineResponse200.md)
|
371
378
|
|
372
379
|
### Authorization
|
373
380
|
|
@@ -375,19 +382,20 @@ Name | Type | Description | Notes
|
|
375
382
|
|
376
383
|
### HTTP request headers
|
377
384
|
|
378
|
-
|
379
|
-
|
385
|
+
- **Content-Type**: Not defined
|
386
|
+
- **Accept**: application/json
|
380
387
|
|
381
388
|
|
389
|
+
## track_event
|
382
390
|
|
383
|
-
|
384
|
-
> InlineResponse200 get_reserved_customers(coupon_value)
|
391
|
+
> IntegrationState track_event(body, opts)
|
385
392
|
|
386
|
-
|
393
|
+
Track an Event
|
387
394
|
|
388
|
-
|
395
|
+
Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned. As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.
|
389
396
|
|
390
397
|
### Example
|
398
|
+
|
391
399
|
```ruby
|
392
400
|
# load the gem
|
393
401
|
require 'talon_one'
|
@@ -405,28 +413,31 @@ TalonOne.configure do |config|
|
|
405
413
|
end
|
406
414
|
|
407
415
|
api_instance = TalonOne::IntegrationApi.new
|
408
|
-
|
409
|
-
|
410
|
-
|
416
|
+
body = TalonOne::NewEvent.new # NewEvent |
|
417
|
+
opts = {
|
418
|
+
dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
|
419
|
+
}
|
411
420
|
|
412
421
|
begin
|
413
|
-
#
|
414
|
-
result = api_instance.
|
422
|
+
#Track an Event
|
423
|
+
result = api_instance.track_event(body, opts)
|
415
424
|
p result
|
416
425
|
rescue TalonOne::ApiError => e
|
417
|
-
puts "Exception when calling IntegrationApi->
|
426
|
+
puts "Exception when calling IntegrationApi->track_event: #{e}"
|
418
427
|
end
|
419
428
|
```
|
420
429
|
|
421
430
|
### Parameters
|
422
431
|
|
432
|
+
|
423
433
|
Name | Type | Description | Notes
|
424
434
|
------------- | ------------- | ------------- | -------------
|
425
|
-
**
|
435
|
+
**body** | [**NewEvent**](NewEvent.md)| |
|
436
|
+
**dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
426
437
|
|
427
438
|
### Return type
|
428
439
|
|
429
|
-
[**
|
440
|
+
[**IntegrationState**](IntegrationState.md)
|
430
441
|
|
431
442
|
### Authorization
|
432
443
|
|
@@ -434,19 +445,20 @@ Name | Type | Description | Notes
|
|
434
445
|
|
435
446
|
### HTTP request headers
|
436
447
|
|
437
|
-
|
438
|
-
|
448
|
+
- **Content-Type**: application/json
|
449
|
+
- **Accept**: application/json
|
439
450
|
|
440
451
|
|
452
|
+
## update_customer_profile
|
441
453
|
|
442
|
-
|
443
|
-
> IntegrationState track_event(body)
|
454
|
+
> IntegrationState update_customer_profile(integration_id, body, opts)
|
444
455
|
|
445
|
-
|
456
|
+
Update a Customer Profile V1
|
446
457
|
|
447
|
-
|
458
|
+
⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons
|
448
459
|
|
449
460
|
### Example
|
461
|
+
|
450
462
|
```ruby
|
451
463
|
# load the gem
|
452
464
|
require 'talon_one'
|
@@ -464,24 +476,29 @@ TalonOne.configure do |config|
|
|
464
476
|
end
|
465
477
|
|
466
478
|
api_instance = TalonOne::IntegrationApi.new
|
467
|
-
|
468
|
-
body = TalonOne::
|
469
|
-
|
479
|
+
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
480
|
+
body = TalonOne::NewCustomerProfile.new # NewCustomerProfile |
|
481
|
+
opts = {
|
482
|
+
dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
|
483
|
+
}
|
470
484
|
|
471
485
|
begin
|
472
|
-
#
|
473
|
-
result = api_instance.
|
486
|
+
#Update a Customer Profile V1
|
487
|
+
result = api_instance.update_customer_profile(integration_id, body, opts)
|
474
488
|
p result
|
475
489
|
rescue TalonOne::ApiError => e
|
476
|
-
puts "Exception when calling IntegrationApi->
|
490
|
+
puts "Exception when calling IntegrationApi->update_customer_profile: #{e}"
|
477
491
|
end
|
478
492
|
```
|
479
493
|
|
480
494
|
### Parameters
|
481
495
|
|
496
|
+
|
482
497
|
Name | Type | Description | Notes
|
483
498
|
------------- | ------------- | ------------- | -------------
|
484
|
-
**
|
499
|
+
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
500
|
+
**body** | [**NewCustomerProfile**](NewCustomerProfile.md)| |
|
501
|
+
**dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
485
502
|
|
486
503
|
### Return type
|
487
504
|
|
@@ -493,19 +510,20 @@ Name | Type | Description | Notes
|
|
493
510
|
|
494
511
|
### HTTP request headers
|
495
512
|
|
496
|
-
|
497
|
-
|
513
|
+
- **Content-Type**: application/json
|
514
|
+
- **Accept**: application/json
|
498
515
|
|
499
516
|
|
517
|
+
## update_customer_profile_audiences
|
500
518
|
|
501
|
-
|
502
|
-
> IntegrationState update_customer_profile(integration_id, body)
|
519
|
+
> update_customer_profile_audiences(body)
|
503
520
|
|
504
|
-
Update a Customer Profile
|
521
|
+
Update a Customer Profile Audiences
|
505
522
|
|
506
|
-
Update
|
523
|
+
Update one ore multiple Customer Profiles with the specified Audiences
|
507
524
|
|
508
525
|
### Example
|
526
|
+
|
509
527
|
```ruby
|
510
528
|
# load the gem
|
511
529
|
require 'talon_one'
|
@@ -515,59 +533,170 @@ TalonOne.configure do |config|
|
|
515
533
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
516
534
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
517
535
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
536
|
+
end
|
518
537
|
|
519
|
-
|
520
|
-
|
538
|
+
api_instance = TalonOne::IntegrationApi.new
|
539
|
+
body = TalonOne::CustomerProfileAudienceRequest.new # CustomerProfileAudienceRequest |
|
540
|
+
|
541
|
+
begin
|
542
|
+
#Update a Customer Profile Audiences
|
543
|
+
api_instance.update_customer_profile_audiences(body)
|
544
|
+
rescue TalonOne::ApiError => e
|
545
|
+
puts "Exception when calling IntegrationApi->update_customer_profile_audiences: #{e}"
|
546
|
+
end
|
547
|
+
```
|
548
|
+
|
549
|
+
### Parameters
|
550
|
+
|
551
|
+
|
552
|
+
Name | Type | Description | Notes
|
553
|
+
------------- | ------------- | ------------- | -------------
|
554
|
+
**body** | [**CustomerProfileAudienceRequest**](CustomerProfileAudienceRequest.md)| |
|
555
|
+
|
556
|
+
### Return type
|
557
|
+
|
558
|
+
nil (empty response body)
|
559
|
+
|
560
|
+
### Authorization
|
561
|
+
|
562
|
+
[api_key_v1](../README.md#api_key_v1)
|
563
|
+
|
564
|
+
### HTTP request headers
|
565
|
+
|
566
|
+
- **Content-Type**: application/json
|
567
|
+
- **Accept**: Not defined
|
568
|
+
|
569
|
+
|
570
|
+
## update_customer_profile_v2
|
571
|
+
|
572
|
+
> IntegrationStateV2 update_customer_profile_v2(integration_id, body, opts)
|
573
|
+
|
574
|
+
Update a Customer Profile
|
575
|
+
|
576
|
+
Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Updating a customer profile returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter.
|
577
|
+
|
578
|
+
### Example
|
579
|
+
|
580
|
+
```ruby
|
581
|
+
# load the gem
|
582
|
+
require 'talon_one'
|
583
|
+
# setup authorization
|
584
|
+
TalonOne.configure do |config|
|
585
|
+
# Configure API key authorization: api_key_v1
|
586
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
521
587
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
522
|
-
#config.api_key_prefix['
|
588
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
523
589
|
end
|
524
590
|
|
525
591
|
api_instance = TalonOne::IntegrationApi.new
|
592
|
+
integration_id = 'integration_id_example' # String | The custom identifier for this profile. Must be unique within the account.
|
593
|
+
body = TalonOne::CustomerProfileIntegrationRequestV2.new # CustomerProfileIntegrationRequestV2 |
|
594
|
+
opts = {
|
595
|
+
run_rule_engine: false, # Boolean | Indicates whether to run the rule engine.
|
596
|
+
dry: true # Boolean | Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`.
|
597
|
+
}
|
526
598
|
|
527
|
-
|
599
|
+
begin
|
600
|
+
#Update a Customer Profile
|
601
|
+
result = api_instance.update_customer_profile_v2(integration_id, body, opts)
|
602
|
+
p result
|
603
|
+
rescue TalonOne::ApiError => e
|
604
|
+
puts "Exception when calling IntegrationApi->update_customer_profile_v2: #{e}"
|
605
|
+
end
|
606
|
+
```
|
528
607
|
|
529
|
-
|
608
|
+
### Parameters
|
609
|
+
|
610
|
+
|
611
|
+
Name | Type | Description | Notes
|
612
|
+
------------- | ------------- | ------------- | -------------
|
613
|
+
**integration_id** | **String**| The custom identifier for this profile. Must be unique within the account. |
|
614
|
+
**body** | [**CustomerProfileIntegrationRequestV2**](CustomerProfileIntegrationRequestV2.md)| |
|
615
|
+
**run_rule_engine** | **Boolean**| Indicates whether to run the rule engine. | [optional] [default to false]
|
616
|
+
**dry** | **Boolean**| Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`. | [optional]
|
617
|
+
|
618
|
+
### Return type
|
619
|
+
|
620
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
621
|
+
|
622
|
+
### Authorization
|
530
623
|
|
624
|
+
[api_key_v1](../README.md#api_key_v1)
|
625
|
+
|
626
|
+
### HTTP request headers
|
627
|
+
|
628
|
+
- **Content-Type**: application/json
|
629
|
+
- **Accept**: application/json
|
630
|
+
|
631
|
+
|
632
|
+
## update_customer_profiles_v2
|
633
|
+
|
634
|
+
> MultipleCustomerProfileIntegrationResponseV2 update_customer_profiles_v2(body, opts)
|
635
|
+
|
636
|
+
Update multiple Customer Profiles
|
637
|
+
|
638
|
+
Update (or create) up to 1000 [Customer Profiles](https://developers.talon.one/Getting-Started/entities#customer-profile) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://developers.talon.one/Integration-API/API-Reference#updateCustomerSessionV2).
|
639
|
+
|
640
|
+
### Example
|
641
|
+
|
642
|
+
```ruby
|
643
|
+
# load the gem
|
644
|
+
require 'talon_one'
|
645
|
+
# setup authorization
|
646
|
+
TalonOne.configure do |config|
|
647
|
+
# Configure API key authorization: api_key_v1
|
648
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
649
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
650
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
651
|
+
end
|
652
|
+
|
653
|
+
api_instance = TalonOne::IntegrationApi.new
|
654
|
+
body = TalonOne::MultipleCustomerProfileIntegrationRequest.new # MultipleCustomerProfileIntegrationRequest |
|
655
|
+
opts = {
|
656
|
+
silent: 'silent_example' # String | If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
|
657
|
+
}
|
531
658
|
|
532
659
|
begin
|
533
|
-
#Update
|
534
|
-
result = api_instance.
|
660
|
+
#Update multiple Customer Profiles
|
661
|
+
result = api_instance.update_customer_profiles_v2(body, opts)
|
535
662
|
p result
|
536
663
|
rescue TalonOne::ApiError => e
|
537
|
-
puts "Exception when calling IntegrationApi->
|
664
|
+
puts "Exception when calling IntegrationApi->update_customer_profiles_v2: #{e}"
|
538
665
|
end
|
539
666
|
```
|
540
667
|
|
541
668
|
### Parameters
|
542
669
|
|
670
|
+
|
543
671
|
Name | Type | Description | Notes
|
544
672
|
------------- | ------------- | ------------- | -------------
|
545
|
-
**
|
546
|
-
**
|
673
|
+
**body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md)| |
|
674
|
+
**silent** | **String**| If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000). | [optional]
|
547
675
|
|
548
676
|
### Return type
|
549
677
|
|
550
|
-
[**
|
678
|
+
[**MultipleCustomerProfileIntegrationResponseV2**](MultipleCustomerProfileIntegrationResponseV2.md)
|
551
679
|
|
552
680
|
### Authorization
|
553
681
|
|
554
|
-
[api_key_v1](../README.md#api_key_v1)
|
682
|
+
[api_key_v1](../README.md#api_key_v1)
|
555
683
|
|
556
684
|
### HTTP request headers
|
557
685
|
|
558
|
-
|
559
|
-
|
686
|
+
- **Content-Type**: application/json
|
687
|
+
- **Accept**: application/json
|
560
688
|
|
561
689
|
|
690
|
+
## update_customer_session
|
562
691
|
|
563
|
-
|
564
|
-
> IntegrationState update_customer_session(customer_session_id, body)
|
692
|
+
> IntegrationState update_customer_session(customer_session_id, body, opts)
|
565
693
|
|
566
|
-
Update a Customer Session
|
694
|
+
Update a Customer Session V1
|
567
695
|
|
568
|
-
Update (or create) a [Customer Session]
|
696
|
+
⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](https://developers.talon.one/Getting-Started/APIV2). Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer profile returns a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
|
569
697
|
|
570
698
|
### Example
|
699
|
+
|
571
700
|
```ruby
|
572
701
|
# load the gem
|
573
702
|
require 'talon_one'
|
@@ -585,15 +714,15 @@ TalonOne.configure do |config|
|
|
585
714
|
end
|
586
715
|
|
587
716
|
api_instance = TalonOne::IntegrationApi.new
|
588
|
-
|
589
717
|
customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
|
590
|
-
|
591
718
|
body = TalonOne::NewCustomerSession.new # NewCustomerSession |
|
592
|
-
|
719
|
+
opts = {
|
720
|
+
dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
|
721
|
+
}
|
593
722
|
|
594
723
|
begin
|
595
|
-
#Update a Customer Session
|
596
|
-
result = api_instance.update_customer_session(customer_session_id, body)
|
724
|
+
#Update a Customer Session V1
|
725
|
+
result = api_instance.update_customer_session(customer_session_id, body, opts)
|
597
726
|
p result
|
598
727
|
rescue TalonOne::ApiError => e
|
599
728
|
puts "Exception when calling IntegrationApi->update_customer_session: #{e}"
|
@@ -602,10 +731,12 @@ end
|
|
602
731
|
|
603
732
|
### Parameters
|
604
733
|
|
734
|
+
|
605
735
|
Name | Type | Description | Notes
|
606
736
|
------------- | ------------- | ------------- | -------------
|
607
737
|
**customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
|
608
738
|
**body** | [**NewCustomerSession**](NewCustomerSession.md)| |
|
739
|
+
**dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
609
740
|
|
610
741
|
### Return type
|
611
742
|
|
@@ -617,8 +748,66 @@ Name | Type | Description | Notes
|
|
617
748
|
|
618
749
|
### HTTP request headers
|
619
750
|
|
620
|
-
|
621
|
-
|
751
|
+
- **Content-Type**: application/json
|
752
|
+
- **Accept**: application/json
|
753
|
+
|
754
|
+
|
755
|
+
## update_customer_session_v2
|
756
|
+
|
757
|
+
> IntegrationStateV2 update_customer_session_v2(customer_session_id, body, opts)
|
622
758
|
|
759
|
+
Update a Customer Session
|
760
|
+
|
761
|
+
Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer session returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
|
762
|
+
|
763
|
+
### Example
|
764
|
+
|
765
|
+
```ruby
|
766
|
+
# load the gem
|
767
|
+
require 'talon_one'
|
768
|
+
# setup authorization
|
769
|
+
TalonOne.configure do |config|
|
770
|
+
# Configure API key authorization: api_key_v1
|
771
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
772
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
773
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
774
|
+
end
|
775
|
+
|
776
|
+
api_instance = TalonOne::IntegrationApi.new
|
777
|
+
customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
|
778
|
+
body = TalonOne::IntegrationRequest.new # IntegrationRequest |
|
779
|
+
opts = {
|
780
|
+
dry: true # Boolean | Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
|
781
|
+
}
|
782
|
+
|
783
|
+
begin
|
784
|
+
#Update a Customer Session
|
785
|
+
result = api_instance.update_customer_session_v2(customer_session_id, body, opts)
|
786
|
+
p result
|
787
|
+
rescue TalonOne::ApiError => e
|
788
|
+
puts "Exception when calling IntegrationApi->update_customer_session_v2: #{e}"
|
789
|
+
end
|
790
|
+
```
|
791
|
+
|
792
|
+
### Parameters
|
793
|
+
|
794
|
+
|
795
|
+
Name | Type | Description | Notes
|
796
|
+
------------- | ------------- | ------------- | -------------
|
797
|
+
**customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
|
798
|
+
**body** | [**IntegrationRequest**](IntegrationRequest.md)| |
|
799
|
+
**dry** | **Boolean**| Indicates whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
800
|
+
|
801
|
+
### Return type
|
802
|
+
|
803
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
804
|
+
|
805
|
+
### Authorization
|
806
|
+
|
807
|
+
[api_key_v1](../README.md#api_key_v1)
|
808
|
+
|
809
|
+
### HTTP request headers
|
623
810
|
|
811
|
+
- **Content-Type**: application/json
|
812
|
+
- **Accept**: application/json
|
624
813
|
|