talon_one 1.3.0 → 2.2.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 +196 -30
- 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 -14
- data/docs/AccountEntity.md +9 -0
- data/docs/AccountLimits.md +32 -11
- data/docs/AddFreeItemEffectProps.md +19 -0
- data/docs/AddLoyaltyPointsEffectProps.md +29 -0
- data/docs/AdditionalCost.md +17 -0
- data/docs/Application.md +33 -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 +17 -1
- data/docs/ApplicationSession.md +25 -3
- data/docs/ApplicationSessionEntity.md +9 -0
- data/docs/Attribute.md +23 -2
- data/docs/AttributesMandatory.md +19 -0
- data/docs/AttributesSettings.md +17 -0
- data/docs/Audience.md +27 -0
- data/docs/AudienceMembership.md +19 -0
- data/docs/BaseSamlConnection.md +31 -0
- data/docs/Binding.md +10 -0
- data/docs/Campaign.md +36 -1
- data/docs/CampaignAnalytics.md +46 -3
- data/docs/CampaignCopy.md +19 -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 +21 -1
- data/docs/CartItemAdjustment.md +11 -0
- data/docs/Change.md +16 -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 +23 -0
- data/docs/CustomerProfile.md +20 -2
- data/docs/CustomerProfileAudienceRequest.md +17 -0
- data/docs/CustomerProfileAudienceRequestItem.md +21 -0
- data/docs/CustomerProfileIntegrationRequestV2.md +19 -0
- data/docs/CustomerProfileSearchQuery.md +12 -1
- data/docs/CustomerSession.md +24 -3
- data/docs/CustomerSessionV2.md +45 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +23 -0
- data/docs/Effect.md +27 -0
- data/docs/EffectEntity.md +25 -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 +14 -0
- data/docs/ImportCoupons.md +9 -0
- 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 +11 -1
- 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 +12 -3
- data/docs/InlineResponse20026.md +11 -1
- data/docs/InlineResponse20027.md +14 -2
- data/docs/InlineResponse20028.md +11 -1
- data/docs/InlineResponse20029.md +19 -0
- 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 +327 -72
- 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 +35 -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 +9 -0
- data/docs/LoyaltyProgramLedgers.md +14 -2
- data/docs/LoyaltyStatistics.md +23 -0
- data/docs/LoyaltySubLedger.md +28 -3
- data/docs/ManagementApi.md +927 -853
- 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 +29 -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 +20 -1
- 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/NewImport.md +9 -0
- 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 +21 -3
- 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/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 +19 -0
- data/docs/RejectReferralEffectProps.md +19 -0
- data/docs/Role.md +18 -2
- data/docs/RoleAssign.md +10 -0
- data/docs/RoleMembership.md +10 -0
- data/docs/RollbackCouponEffectProps.md +17 -0
- data/docs/RollbackDiscountEffectProps.md +19 -0
- data/docs/Rule.md +13 -0
- data/docs/Ruleset.md +18 -1
- data/docs/SamlConnection.md +24 -6
- data/docs/SamlConnectionMetadata.md +23 -0
- 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 +28 -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 +88 -35
- data/lib/talon_one/api/integration_api.rb +518 -138
- data/lib/talon_one/api/management_api.rb +2328 -1477
- 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 +151 -68
- data/lib/talon_one/models/account_entity.rb +39 -16
- data/lib/talon_one/models/account_limits.rb +83 -45
- data/lib/talon_one/models/add_free_item_effect_props.rb +228 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +293 -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 +131 -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 +48 -25
- 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 +222 -0
- data/lib/talon_one/models/attributes_settings.rb +207 -0
- 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 +359 -0
- data/lib/talon_one/models/binding.rb +39 -16
- data/lib/talon_one/models/campaign.rb +93 -58
- data/lib/talon_one/models/campaign_analytics.rb +223 -50
- data/lib/talon_one/models/campaign_copy.rb +86 -21
- 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 +49 -26
- data/lib/talon_one/models/cart_item_adjustment.rb +43 -20
- data/lib/talon_one/models/change.rb +46 -23
- data/lib/talon_one/models/change_profile_password.rb +227 -0
- data/lib/talon_one/models/code_generator_settings.rb +41 -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 +237 -0
- 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 +242 -0
- data/lib/talon_one/models/customer_profile_search_query.rb +42 -19
- data/lib/talon_one/models/customer_session.rb +60 -37
- data/lib/talon_one/models/customer_session_v2.rb +447 -0
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +258 -0
- data/lib/talon_one/models/effect.rb +287 -0
- data/lib/talon_one/models/effect_entity.rb +273 -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 +48 -25
- data/lib/talon_one/models/import_coupons.rb +38 -15
- 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_response20012.rb +231 -0
- 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_response_200_12.rb → inline_response20020.rb} +42 -19
- data/lib/talon_one/models/inline_response20021.rb +227 -0
- data/lib/talon_one/models/{inline_response_200_20.rb → inline_response20022.rb} +41 -18
- 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} +44 -21
- data/lib/talon_one/models/{inline_response_200_26.rb → inline_response20028.rb} +41 -18
- 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_28.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 +313 -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 +43 -20
- 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 +59 -26
- data/lib/talon_one/models/loyalty_program.rb +67 -29
- data/lib/talon_one/models/loyalty_program_balance.rb +39 -16
- data/lib/talon_one/models/loyalty_program_ledgers.rb +43 -21
- 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/multiple_customer_profile_integration_request.rb +208 -0
- 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 +138 -48
- 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 +89 -32
- data/lib/talon_one/models/new_customer_profile.rb +38 -15
- data/lib/talon_one/models/new_customer_session.rb +50 -27
- data/lib/talon_one/models/new_customer_session_v2.rb +322 -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_import.rb +41 -18
- 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 +105 -67
- 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/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 +228 -0
- data/lib/talon_one/models/reject_referral_effect_props.rb +228 -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_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/rollback_discount_effect_props.rb +228 -0
- data/lib/talon_one/models/rule.rb +42 -19
- data/lib/talon_one/models/ruleset.rb +51 -28
- data/lib/talon_one/models/saml_connection.rb +93 -103
- data/lib/talon_one/models/saml_connection_metadata.rb +294 -0
- data/lib/talon_one/models/saml_login_endpoint.rb +265 -0
- 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 +135 -29
- 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 +76 -15
- data/spec/api/management_api_spec.rb +155 -143
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/{misc_update_user_latest_feature_spec.rb → accept_coupon_effect_props_spec.rb} +11 -11
- 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 +33 -9
- data/spec/models/account_entity_spec.rb +4 -4
- data/spec/models/account_limits_spec.rb +10 -4
- 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 +77 -0
- data/spec/models/additional_cost_spec.rb +41 -0
- 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 +4 -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 +43 -5
- data/spec/models/attribute_spec.rb +10 -4
- data/spec/models/attributes_mandatory_spec.rb +47 -0
- data/spec/models/attributes_settings_spec.rb +41 -0
- 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 +83 -0
- data/spec/models/binding_spec.rb +4 -4
- data/spec/models/campaign_analytics_spec.rb +64 -4
- data/spec/models/campaign_copy_spec.rb +28 -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 +10 -4
- data/spec/models/cart_item_adjustment_spec.rb +4 -4
- data/spec/models/cart_item_spec.rb +4 -4
- data/spec/models/change_profile_password_spec.rb +47 -0
- data/spec/models/change_spec.rb +4 -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 +59 -0
- 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 +51 -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 +59 -0
- data/spec/models/effect_entity_spec.rb +65 -0
- data/spec/models/effect_spec.rb +71 -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_coupons_spec.rb +4 -4
- data/spec/models/import_spec.rb +4 -4
- 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 -10
- data/spec/models/{inline_response_200_26_spec.rb → inline_response20026_spec.rb} +4 -4
- data/spec/models/{inline_response_200_27_spec.rb → inline_response20027_spec.rb} +10 -4
- data/spec/models/{inline_response_200_28_spec.rb → inline_response20028_spec.rb} +4 -4
- data/spec/models/inline_response20029_spec.rb +47 -0
- 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 +95 -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 -4
- 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 +4 -4
- data/spec/models/loyalty_program_ledgers_spec.rb +4 -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 +48 -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_spec.rb +10 -4
- 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_import_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 +17 -11
- 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/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 +47 -0
- data/spec/models/reject_referral_effect_props_spec.rb +47 -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_coupon_effect_props_spec.rb +41 -0
- data/spec/models/rollback_discount_effect_props_spec.rb +47 -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 +59 -0
- data/spec/models/saml_connection_spec.rb +13 -19
- data/spec/models/saml_login_endpoint_spec.rb +47 -0
- data/spec/models/session_spec.rb +4 -4
- data/spec/models/set_discount_effect_props_spec.rb +53 -0
- 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 +48 -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 +314 -228
- data/CHANGELOG.md +0 -63
- data/docs/AttributeQuery.md +0 -7
- data/docs/MiscUpdateUserLatestFeature.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/inline_response_200_16.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/docs/InlineResponse20025.md
CHANGED
@@ -1,10 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20025
|
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::InlineResponse20025.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
9
18
|
|
10
19
|
|
data/docs/InlineResponse20026.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20026
|
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::InlineResponse20026.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse20027.md
CHANGED
@@ -1,9 +1,21 @@
|
|
1
1
|
# TalonOne::InlineResponse20027
|
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::InlineResponse20027.new(total_result_size: null,
|
17
|
+
has_more: null,
|
18
|
+
data: null)
|
19
|
+
```
|
8
20
|
|
9
21
|
|
data/docs/InlineResponse20028.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20028
|
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::InlineResponse20028.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::InlineResponse20029
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**total_result_size** | **Integer** | |
|
8
|
+
**data** | [**Array<Import>**](Import.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
|
+
```
|
18
|
+
|
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,6 +1,6 @@
|
|
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
|
------------- | ------------- | -------------
|
@@ -8,14 +8,20 @@ Method | HTTP request | Description
|
|
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
10
|
[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
|
11
|
-
[**
|
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
12
|
[**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
|
13
13
|
[**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
|
14
|
-
[**update_customer_profile**](IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
|
15
|
-
[**
|
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
|
16
20
|
|
17
21
|
|
18
|
-
|
22
|
+
|
23
|
+
## create_coupon_reservation
|
24
|
+
|
19
25
|
> Coupon create_coupon_reservation(coupon_value, body)
|
20
26
|
|
21
27
|
Create a new coupon reservation
|
@@ -23,6 +29,7 @@ Create a new coupon reservation
|
|
23
29
|
Creates a coupon reservation for all passed customer profiles on this couponID
|
24
30
|
|
25
31
|
### Example
|
32
|
+
|
26
33
|
```ruby
|
27
34
|
# load the gem
|
28
35
|
require 'talon_one'
|
@@ -40,12 +47,9 @@ TalonOne.configure do |config|
|
|
40
47
|
end
|
41
48
|
|
42
49
|
api_instance = TalonOne::IntegrationApi.new
|
43
|
-
|
44
50
|
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
45
|
-
|
46
51
|
body = TalonOne::CouponReservations.new # CouponReservations |
|
47
52
|
|
48
|
-
|
49
53
|
begin
|
50
54
|
#Create a new coupon reservation
|
51
55
|
result = api_instance.create_coupon_reservation(coupon_value, body)
|
@@ -57,6 +61,7 @@ end
|
|
57
61
|
|
58
62
|
### Parameters
|
59
63
|
|
64
|
+
|
60
65
|
Name | Type | Description | Notes
|
61
66
|
------------- | ------------- | ------------- | -------------
|
62
67
|
**coupon_value** | **String**| The value of a coupon |
|
@@ -72,12 +77,12 @@ Name | Type | Description | Notes
|
|
72
77
|
|
73
78
|
### HTTP request headers
|
74
79
|
|
75
|
-
|
76
|
-
|
80
|
+
- **Content-Type**: application/json
|
81
|
+
- **Accept**: application/json
|
77
82
|
|
78
83
|
|
84
|
+
## create_referral
|
79
85
|
|
80
|
-
# **create_referral**
|
81
86
|
> Referral create_referral(body)
|
82
87
|
|
83
88
|
Create a referral code for an advocate
|
@@ -85,6 +90,7 @@ Create a referral code for an advocate
|
|
85
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.
|
86
91
|
|
87
92
|
### Example
|
93
|
+
|
88
94
|
```ruby
|
89
95
|
# load the gem
|
90
96
|
require 'talon_one'
|
@@ -102,10 +108,8 @@ TalonOne.configure do |config|
|
|
102
108
|
end
|
103
109
|
|
104
110
|
api_instance = TalonOne::IntegrationApi.new
|
105
|
-
|
106
111
|
body = TalonOne::NewReferral.new # NewReferral |
|
107
112
|
|
108
|
-
|
109
113
|
begin
|
110
114
|
#Create a referral code for an advocate
|
111
115
|
result = api_instance.create_referral(body)
|
@@ -117,6 +121,7 @@ end
|
|
117
121
|
|
118
122
|
### Parameters
|
119
123
|
|
124
|
+
|
120
125
|
Name | Type | Description | Notes
|
121
126
|
------------- | ------------- | ------------- | -------------
|
122
127
|
**body** | [**NewReferral**](NewReferral.md)| |
|
@@ -131,12 +136,12 @@ Name | Type | Description | Notes
|
|
131
136
|
|
132
137
|
### HTTP request headers
|
133
138
|
|
134
|
-
|
135
|
-
|
139
|
+
- **Content-Type**: application/json
|
140
|
+
- **Accept**: application/json
|
136
141
|
|
137
142
|
|
143
|
+
## delete_coupon_reservation
|
138
144
|
|
139
|
-
# **delete_coupon_reservation**
|
140
145
|
> delete_coupon_reservation(coupon_value, body)
|
141
146
|
|
142
147
|
Delete coupon reservations
|
@@ -144,6 +149,7 @@ Delete coupon reservations
|
|
144
149
|
Removes all passed customer profiles reservation from this coupon
|
145
150
|
|
146
151
|
### Example
|
152
|
+
|
147
153
|
```ruby
|
148
154
|
# load the gem
|
149
155
|
require 'talon_one'
|
@@ -161,12 +167,9 @@ TalonOne.configure do |config|
|
|
161
167
|
end
|
162
168
|
|
163
169
|
api_instance = TalonOne::IntegrationApi.new
|
164
|
-
|
165
170
|
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
166
|
-
|
167
171
|
body = TalonOne::CouponReservations.new # CouponReservations |
|
168
172
|
|
169
|
-
|
170
173
|
begin
|
171
174
|
#Delete coupon reservations
|
172
175
|
api_instance.delete_coupon_reservation(coupon_value, body)
|
@@ -177,6 +180,7 @@ end
|
|
177
180
|
|
178
181
|
### Parameters
|
179
182
|
|
183
|
+
|
180
184
|
Name | Type | Description | Notes
|
181
185
|
------------- | ------------- | ------------- | -------------
|
182
186
|
**coupon_value** | **String**| The value of a coupon |
|
@@ -192,12 +196,12 @@ nil (empty response body)
|
|
192
196
|
|
193
197
|
### HTTP request headers
|
194
198
|
|
195
|
-
|
196
|
-
|
199
|
+
- **Content-Type**: application/json
|
200
|
+
- **Accept**: Not defined
|
197
201
|
|
198
202
|
|
203
|
+
## delete_customer_data
|
199
204
|
|
200
|
-
# **delete_customer_data**
|
201
205
|
> delete_customer_data(integration_id)
|
202
206
|
|
203
207
|
Delete the personal data of a customer.
|
@@ -205,6 +209,7 @@ Delete the personal data of a customer.
|
|
205
209
|
Delete all attributes on the customer profile and on entities that reference that customer profile.
|
206
210
|
|
207
211
|
### Example
|
212
|
+
|
208
213
|
```ruby
|
209
214
|
# load the gem
|
210
215
|
require 'talon_one'
|
@@ -222,10 +227,8 @@ TalonOne.configure do |config|
|
|
222
227
|
end
|
223
228
|
|
224
229
|
api_instance = TalonOne::IntegrationApi.new
|
225
|
-
|
226
230
|
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
227
231
|
|
228
|
-
|
229
232
|
begin
|
230
233
|
#Delete the personal data of a customer.
|
231
234
|
api_instance.delete_customer_data(integration_id)
|
@@ -236,6 +239,7 @@ end
|
|
236
239
|
|
237
240
|
### Parameters
|
238
241
|
|
242
|
+
|
239
243
|
Name | Type | Description | Notes
|
240
244
|
------------- | ------------- | ------------- | -------------
|
241
245
|
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
@@ -250,19 +254,20 @@ nil (empty response body)
|
|
250
254
|
|
251
255
|
### HTTP request headers
|
252
256
|
|
253
|
-
|
254
|
-
|
257
|
+
- **Content-Type**: Not defined
|
258
|
+
- **Accept**: Not defined
|
255
259
|
|
256
260
|
|
261
|
+
## get_customer_inventory
|
257
262
|
|
258
|
-
|
259
|
-
> InlineResponse2001 get_reserved_coupons(integration_id)
|
263
|
+
> CustomerInventory get_customer_inventory(integration_id, opts)
|
260
264
|
|
261
|
-
Get all
|
265
|
+
Get an inventory of all data associated with a specific customer profile.
|
262
266
|
|
263
|
-
|
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.
|
264
268
|
|
265
269
|
### Example
|
270
|
+
|
266
271
|
```ruby
|
267
272
|
# load the gem
|
268
273
|
require 'talon_one'
|
@@ -280,28 +285,37 @@ TalonOne.configure do |config|
|
|
280
285
|
end
|
281
286
|
|
282
287
|
api_instance = TalonOne::IntegrationApi.new
|
283
|
-
|
284
288
|
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
285
|
-
|
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
|
294
|
+
}
|
286
295
|
|
287
296
|
begin
|
288
|
-
#Get all
|
289
|
-
result = api_instance.
|
297
|
+
#Get an inventory of all data associated with a specific customer profile.
|
298
|
+
result = api_instance.get_customer_inventory(integration_id, opts)
|
290
299
|
p result
|
291
300
|
rescue TalonOne::ApiError => e
|
292
|
-
puts "Exception when calling IntegrationApi->
|
301
|
+
puts "Exception when calling IntegrationApi->get_customer_inventory: #{e}"
|
293
302
|
end
|
294
303
|
```
|
295
304
|
|
296
305
|
### Parameters
|
297
306
|
|
307
|
+
|
298
308
|
Name | Type | Description | Notes
|
299
309
|
------------- | ------------- | ------------- | -------------
|
300
310
|
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
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]
|
301
315
|
|
302
316
|
### Return type
|
303
317
|
|
304
|
-
[**
|
318
|
+
[**CustomerInventory**](CustomerInventory.md)
|
305
319
|
|
306
320
|
### Authorization
|
307
321
|
|
@@ -309,12 +323,12 @@ Name | Type | Description | Notes
|
|
309
323
|
|
310
324
|
### HTTP request headers
|
311
325
|
|
312
|
-
|
313
|
-
|
326
|
+
- **Content-Type**: Not defined
|
327
|
+
- **Accept**: application/json
|
314
328
|
|
315
329
|
|
330
|
+
## get_reserved_customers
|
316
331
|
|
317
|
-
# **get_reserved_customers**
|
318
332
|
> InlineResponse200 get_reserved_customers(coupon_value)
|
319
333
|
|
320
334
|
Get the users that have this coupon reserved
|
@@ -322,6 +336,7 @@ Get the users that have this coupon reserved
|
|
322
336
|
Returns all users that have this coupon marked as reserved
|
323
337
|
|
324
338
|
### Example
|
339
|
+
|
325
340
|
```ruby
|
326
341
|
# load the gem
|
327
342
|
require 'talon_one'
|
@@ -339,10 +354,8 @@ TalonOne.configure do |config|
|
|
339
354
|
end
|
340
355
|
|
341
356
|
api_instance = TalonOne::IntegrationApi.new
|
342
|
-
|
343
357
|
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
344
358
|
|
345
|
-
|
346
359
|
begin
|
347
360
|
#Get the users that have this coupon reserved
|
348
361
|
result = api_instance.get_reserved_customers(coupon_value)
|
@@ -354,6 +367,7 @@ end
|
|
354
367
|
|
355
368
|
### Parameters
|
356
369
|
|
370
|
+
|
357
371
|
Name | Type | Description | Notes
|
358
372
|
------------- | ------------- | ------------- | -------------
|
359
373
|
**coupon_value** | **String**| The value of a coupon |
|
@@ -368,19 +382,20 @@ Name | Type | Description | Notes
|
|
368
382
|
|
369
383
|
### HTTP request headers
|
370
384
|
|
371
|
-
|
372
|
-
|
385
|
+
- **Content-Type**: Not defined
|
386
|
+
- **Accept**: application/json
|
373
387
|
|
374
388
|
|
389
|
+
## track_event
|
375
390
|
|
376
|
-
|
377
|
-
> IntegrationState track_event(body)
|
391
|
+
> IntegrationState track_event(body, opts)
|
378
392
|
|
379
393
|
Track an Event
|
380
394
|
|
381
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.
|
382
396
|
|
383
397
|
### Example
|
398
|
+
|
384
399
|
```ruby
|
385
400
|
# load the gem
|
386
401
|
require 'talon_one'
|
@@ -398,13 +413,14 @@ TalonOne.configure do |config|
|
|
398
413
|
end
|
399
414
|
|
400
415
|
api_instance = TalonOne::IntegrationApi.new
|
401
|
-
|
402
416
|
body = TalonOne::NewEvent.new # NewEvent |
|
403
|
-
|
417
|
+
opts = {
|
418
|
+
dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
419
|
+
}
|
404
420
|
|
405
421
|
begin
|
406
422
|
#Track an Event
|
407
|
-
result = api_instance.track_event(body)
|
423
|
+
result = api_instance.track_event(body, opts)
|
408
424
|
p result
|
409
425
|
rescue TalonOne::ApiError => e
|
410
426
|
puts "Exception when calling IntegrationApi->track_event: #{e}"
|
@@ -413,9 +429,11 @@ end
|
|
413
429
|
|
414
430
|
### Parameters
|
415
431
|
|
432
|
+
|
416
433
|
Name | Type | Description | Notes
|
417
434
|
------------- | ------------- | ------------- | -------------
|
418
435
|
**body** | [**NewEvent**](NewEvent.md)| |
|
436
|
+
**dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
419
437
|
|
420
438
|
### Return type
|
421
439
|
|
@@ -427,19 +445,20 @@ Name | Type | Description | Notes
|
|
427
445
|
|
428
446
|
### HTTP request headers
|
429
447
|
|
430
|
-
|
431
|
-
|
448
|
+
- **Content-Type**: application/json
|
449
|
+
- **Accept**: application/json
|
432
450
|
|
433
451
|
|
452
|
+
## update_customer_profile
|
434
453
|
|
435
|
-
|
436
|
-
> IntegrationState update_customer_profile(integration_id, body)
|
454
|
+
> IntegrationState update_customer_profile(integration_id, body, opts)
|
437
455
|
|
438
|
-
Update a Customer Profile
|
456
|
+
Update a Customer Profile V1
|
439
457
|
|
440
|
-
Update (or create) a [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
|
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, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [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
|
441
459
|
|
442
460
|
### Example
|
461
|
+
|
443
462
|
```ruby
|
444
463
|
# load the gem
|
445
464
|
require 'talon_one'
|
@@ -457,15 +476,15 @@ TalonOne.configure do |config|
|
|
457
476
|
end
|
458
477
|
|
459
478
|
api_instance = TalonOne::IntegrationApi.new
|
460
|
-
|
461
479
|
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
462
|
-
|
463
480
|
body = TalonOne::NewCustomerProfile.new # NewCustomerProfile |
|
464
|
-
|
481
|
+
opts = {
|
482
|
+
dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
483
|
+
}
|
465
484
|
|
466
485
|
begin
|
467
|
-
#Update a Customer Profile
|
468
|
-
result = api_instance.update_customer_profile(integration_id, body)
|
486
|
+
#Update a Customer Profile V1
|
487
|
+
result = api_instance.update_customer_profile(integration_id, body, opts)
|
469
488
|
p result
|
470
489
|
rescue TalonOne::ApiError => e
|
471
490
|
puts "Exception when calling IntegrationApi->update_customer_profile: #{e}"
|
@@ -474,10 +493,12 @@ end
|
|
474
493
|
|
475
494
|
### Parameters
|
476
495
|
|
496
|
+
|
477
497
|
Name | Type | Description | Notes
|
478
498
|
------------- | ------------- | ------------- | -------------
|
479
499
|
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
480
500
|
**body** | [**NewCustomerProfile**](NewCustomerProfile.md)| |
|
501
|
+
**dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
481
502
|
|
482
503
|
### Return type
|
483
504
|
|
@@ -489,19 +510,193 @@ Name | Type | Description | Notes
|
|
489
510
|
|
490
511
|
### HTTP request headers
|
491
512
|
|
492
|
-
|
493
|
-
|
513
|
+
- **Content-Type**: application/json
|
514
|
+
- **Accept**: application/json
|
494
515
|
|
495
516
|
|
517
|
+
## update_customer_profile_audiences
|
496
518
|
|
497
|
-
|
498
|
-
> IntegrationState update_customer_session(customer_session_id, body)
|
519
|
+
> update_customer_profile_audiences(body)
|
499
520
|
|
500
|
-
Update a Customer
|
521
|
+
Update a Customer Profile Audiences
|
522
|
+
|
523
|
+
Update one ore multiple Customer Profiles with the specified Audiences
|
524
|
+
|
525
|
+
### Example
|
526
|
+
|
527
|
+
```ruby
|
528
|
+
# load the gem
|
529
|
+
require 'talon_one'
|
530
|
+
# setup authorization
|
531
|
+
TalonOne.configure do |config|
|
532
|
+
# Configure API key authorization: api_key_v1
|
533
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
534
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
535
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
536
|
+
end
|
537
|
+
|
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][]. 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. [Customer Profile]: /Getting-Started/entities#customer-profile
|
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'
|
587
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
588
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
589
|
+
end
|
590
|
+
|
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: true, # Boolean | Flag to indicate whether to run the rule engine (Defaults to false).
|
596
|
+
dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'. Only used when 'runRuleEngine' is set to 'true').
|
597
|
+
}
|
598
|
+
|
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
|
+
```
|
607
|
+
|
608
|
+
### Parameters
|
501
609
|
|
502
|
-
|
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**| Flag to indicate whether to run the rule engine (Defaults to false). | [optional]
|
616
|
+
**dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'. Only used when 'runRuleEngine' is set to 'true'). | [optional]
|
617
|
+
|
618
|
+
### Return type
|
619
|
+
|
620
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
621
|
+
|
622
|
+
### Authorization
|
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][] in 1 request. 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. [Customer Profiles]: /Getting-Started/entities#customer-profile
|
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 the IntegrationStateV2 generated.
|
657
|
+
}
|
658
|
+
|
659
|
+
begin
|
660
|
+
#Update multiple Customer Profiles
|
661
|
+
result = api_instance.update_customer_profiles_v2(body, opts)
|
662
|
+
p result
|
663
|
+
rescue TalonOne::ApiError => e
|
664
|
+
puts "Exception when calling IntegrationApi->update_customer_profiles_v2: #{e}"
|
665
|
+
end
|
666
|
+
```
|
667
|
+
|
668
|
+
### Parameters
|
669
|
+
|
670
|
+
|
671
|
+
Name | Type | Description | Notes
|
672
|
+
------------- | ------------- | ------------- | -------------
|
673
|
+
**body** | [**MultipleCustomerProfileIntegrationRequest**](MultipleCustomerProfileIntegrationRequest.md)| |
|
674
|
+
**silent** | **String**| If set to 'yes', response will be an empty 204, otherwise a list of the IntegrationStateV2 generated. | [optional]
|
675
|
+
|
676
|
+
### Return type
|
677
|
+
|
678
|
+
[**MultipleCustomerProfileIntegrationResponseV2**](MultipleCustomerProfileIntegrationResponseV2.md)
|
679
|
+
|
680
|
+
### Authorization
|
681
|
+
|
682
|
+
[api_key_v1](../README.md#api_key_v1)
|
683
|
+
|
684
|
+
### HTTP request headers
|
685
|
+
|
686
|
+
- **Content-Type**: application/json
|
687
|
+
- **Accept**: application/json
|
688
|
+
|
689
|
+
|
690
|
+
## update_customer_session
|
691
|
+
|
692
|
+
> IntegrationState update_customer_session(customer_session_id, body, opts)
|
693
|
+
|
694
|
+
Update a Customer Session V1
|
695
|
+
|
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, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. 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. 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. [Customer Session]: /Getting-Started/entities#customer-session
|
503
697
|
|
504
698
|
### Example
|
699
|
+
|
505
700
|
```ruby
|
506
701
|
# load the gem
|
507
702
|
require 'talon_one'
|
@@ -519,15 +714,15 @@ TalonOne.configure do |config|
|
|
519
714
|
end
|
520
715
|
|
521
716
|
api_instance = TalonOne::IntegrationApi.new
|
522
|
-
|
523
717
|
customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
|
524
|
-
|
525
718
|
body = TalonOne::NewCustomerSession.new # NewCustomerSession |
|
526
|
-
|
719
|
+
opts = {
|
720
|
+
dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
721
|
+
}
|
527
722
|
|
528
723
|
begin
|
529
|
-
#Update a Customer Session
|
530
|
-
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)
|
531
726
|
p result
|
532
727
|
rescue TalonOne::ApiError => e
|
533
728
|
puts "Exception when calling IntegrationApi->update_customer_session: #{e}"
|
@@ -536,10 +731,12 @@ end
|
|
536
731
|
|
537
732
|
### Parameters
|
538
733
|
|
734
|
+
|
539
735
|
Name | Type | Description | Notes
|
540
736
|
------------- | ------------- | ------------- | -------------
|
541
737
|
**customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
|
542
738
|
**body** | [**NewCustomerSession**](NewCustomerSession.md)| |
|
739
|
+
**dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
543
740
|
|
544
741
|
### Return type
|
545
742
|
|
@@ -551,8 +748,66 @@ Name | Type | Description | Notes
|
|
551
748
|
|
552
749
|
### HTTP request headers
|
553
750
|
|
554
|
-
|
555
|
-
|
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)
|
758
|
+
|
759
|
+
Update a Customer Session
|
760
|
+
|
761
|
+
Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter \"responseContent\". 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. [Customer Session]: /Getting-Started/entities#customer-session
|
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 | Flag to indicate 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
|
+
```
|
556
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**| Flag to indicate 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
|
557
810
|
|
811
|
+
- **Content-Type**: application/json
|
812
|
+
- **Accept**: application/json
|
558
813
|
|