talon_one 1.2.0 → 2.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.rspec +2 -0
- data/Gemfile +3 -1
- data/README.md +176 -27
- 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 +24 -0
- data/docs/AccountEntity.md +9 -0
- data/docs/AccountLimits.md +21 -0
- data/docs/AddFreeItemEffectProps.md +19 -0
- data/docs/AddLoyaltyPointsEffectProps.md +27 -0
- data/docs/AdditionalCost.md +17 -0
- data/docs/Application.md +25 -2
- data/docs/ApplicationAPIKey.md +15 -0
- data/docs/ApplicationApiHealth.md +10 -0
- data/docs/ApplicationCustomer.md +18 -1
- 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 +24 -2
- 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/BaseSamlConnection.md +31 -0
- data/docs/Binding.md +10 -0
- data/docs/Campaign.md +36 -1
- data/docs/CampaignAnalytics.md +38 -3
- data/docs/CampaignCopy.md +18 -0
- data/docs/CampaignEntity.md +9 -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 +10 -0
- data/docs/CustomerActivityReport.md +21 -0
- data/docs/CustomerAnalytics.md +15 -0
- data/docs/CustomerInventory.md +21 -0
- data/docs/CustomerProfile.md +17 -1
- data/docs/CustomerProfileSearchQuery.md +12 -1
- data/docs/CustomerProfileUpdate.md +17 -0
- data/docs/CustomerSession.md +23 -2
- 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/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/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 +10 -0
- 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 +11 -1
- 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 +198 -64
- data/docs/IntegrationEntity.md +10 -0
- data/docs/IntegrationEvent.md +12 -1
- data/docs/IntegrationProfileEntity.md +9 -0
- data/docs/IntegrationRequest.md +19 -0
- data/docs/IntegrationState.md +14 -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 +21 -1
- data/docs/LoyaltyMembership.md +10 -0
- data/docs/LoyaltyPoints.md +12 -0
- data/docs/LoyaltyProgram.md +17 -1
- data/docs/LoyaltyProgramBalance.md +9 -0
- data/docs/LoyaltyProgramLedgers.md +14 -2
- data/docs/LoyaltySubLedger.md +11 -0
- data/docs/ManagementApi.md +834 -815
- data/docs/ManagerConfig.md +9 -0
- data/docs/Meta.md +16 -3
- data/docs/MiscUpdateUserLatestFeature.md +9 -0
- data/docs/MultiApplicationEntity.md +9 -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 +22 -2
- data/docs/NewApplicationAPIKey.md +16 -0
- data/docs/NewAttribute.md +20 -2
- data/docs/NewCampaign.md +21 -1
- 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 +15 -1
- 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 +33 -0
- 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 +15 -1
- 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 +37 -0
- data/docs/SamlConnectionMetadata.md +23 -0
- data/docs/SamlLoginEndpoint.md +19 -0
- data/docs/Session.md +11 -0
- data/docs/SetDiscountEffectProps.md +19 -0
- data/docs/SetDiscountPerItemEffectProps.md +21 -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 +33 -0
- data/docs/UpdateAttributeEffectProps.md +19 -0
- data/docs/UpdateCampaign.md +21 -1
- data/docs/UpdateCoupon.md +16 -1
- data/docs/UpdateCouponBatch.md +16 -1
- data/docs/UpdateLoyaltyProgram.md +14 -1
- data/docs/UpdateRole.md +13 -1
- data/docs/UpdateUser.md +17 -5
- data/docs/User.md +26 -3
- data/docs/UserEntity.md +9 -0
- data/docs/Webhook.md +20 -1
- data/docs/WebhookActivationLogEntry.md +13 -0
- data/docs/WebhookLogEntry.md +18 -0
- data/lib/talon_one.rb +73 -34
- data/lib/talon_one/api/integration_api.rb +372 -130
- data/lib/talon_one/api/management_api.rb +2238 -1444
- data/lib/talon_one/api_client.rb +39 -42
- 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 +78 -40
- data/lib/talon_one/models/account_entity.rb +39 -16
- data/lib/talon_one/models/account_limits.rb +67 -34
- data/lib/talon_one/models/add_free_item_effect_props.rb +228 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +288 -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 +87 -85
- data/lib/talon_one/models/application_api_health.rb +43 -20
- data/lib/talon_one/models/application_api_key.rb +47 -24
- data/lib/talon_one/models/application_customer.rb +52 -29
- 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 +72 -34
- 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/base_saml_connection.rb +359 -0
- data/lib/talon_one/models/binding.rb +39 -16
- data/lib/talon_one/models/campaign.rb +97 -54
- data/lib/talon_one/models/campaign_analytics.rb +160 -47
- 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_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 +39 -16
- data/lib/talon_one/models/customer_activity_report.rb +61 -38
- data/lib/talon_one/models/customer_analytics.rb +51 -28
- data/lib/talon_one/models/customer_inventory.rb +228 -0
- data/lib/talon_one/models/customer_profile.rb +51 -28
- data/lib/talon_one/models/customer_profile_search_query.rb +42 -19
- data/lib/talon_one/models/customer_profile_update.rb +211 -0
- data/lib/talon_one/models/customer_session.rb +59 -36
- 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/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/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_response_200_12.rb → inline_response20012.rb} +40 -17
- 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 +227 -0
- 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} +51 -24
- 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 +40 -17
- 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 +54 -22
- 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 +67 -67
- data/lib/talon_one/models/loyalty_membership.rb +40 -17
- data/lib/talon_one/models/loyalty_points.rb +43 -20
- data/lib/talon_one/models/loyalty_program.rb +50 -27
- 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_sub_ledger.rb +41 -18
- data/lib/talon_one/models/manager_config.rb +39 -16
- data/lib/talon_one/models/meta.rb +44 -21
- data/lib/talon_one/models/misc_update_user_latest_feature.rb +39 -16
- data/lib/talon_one/models/multi_application_entity.rb +39 -16
- 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 +111 -81
- data/lib/talon_one/models/new_application_api_key.rb +48 -25
- data/lib/talon_one/models/new_attribute.rb +69 -34
- data/lib/talon_one/models/new_campaign.rb +57 -34
- 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 +47 -24
- 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 +394 -0
- 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 +45 -22
- 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 +410 -0
- 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 +228 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +243 -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 +406 -0
- data/lib/talon_one/models/update_attribute_effect_props.rb +228 -0
- data/lib/talon_one/models/update_campaign.rb +57 -34
- 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 +46 -23
- data/lib/talon_one/models/update_role.rb +42 -19
- data/lib/talon_one/models/update_user.rb +52 -65
- data/lib/talon_one/models/user.rb +74 -41
- data/lib/talon_one/models/user_entity.rb +39 -16
- 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 +44 -11
- data/spec/api/management_api_spec.rb +141 -140
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/accept_coupon_effect_props_spec.rb +41 -0
- 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 +10 -4
- 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 +71 -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 +4 -4
- 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 +4 -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 +20 -10
- 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/base_saml_connection_spec.rb +83 -0
- data/spec/models/binding_spec.rb +4 -4
- data/spec/models/campaign_analytics_spec.rb +40 -4
- data/spec/models/campaign_copy_spec.rb +28 -4
- data/spec/models/campaign_entity_spec.rb +4 -4
- 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 +16 -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 +4 -4
- 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 +4 -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 +53 -0
- data/spec/models/customer_profile_search_query_spec.rb +4 -4
- data/spec/models/customer_profile_spec.rb +4 -4
- data/spec/models/customer_profile_update_spec.rb +41 -0
- 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/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/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} +4 -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 -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 +10 -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 +5 -5
- data/spec/models/login_params_spec.rb +4 -4
- data/spec/models/loyalty_ledger_entry_spec.rb +10 -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 +4 -4
- 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 +4 -4
- data/spec/models/loyalty_spec.rb +4 -4
- data/spec/models/loyalty_sub_ledger_spec.rb +4 -4
- data/spec/models/manager_config_spec.rb +4 -4
- data/spec/models/meta_spec.rb +4 -4
- data/spec/models/misc_update_user_latest_feature_spec.rb +4 -4
- data/spec/models/multi_application_entity_spec.rb +4 -4
- 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 +4 -4
- data/spec/models/new_application_spec.rb +26 -10
- data/spec/models/new_attribute_spec.rb +10 -4
- data/spec/models/new_campaign_set_spec.rb +10 -4
- data/spec/models/new_campaign_spec.rb +4 -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 +4 -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 +89 -0
- 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 +4 -4
- 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 +4 -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 +101 -0
- 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 +47 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +53 -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 +97 -0
- data/spec/models/update_attribute_effect_props_spec.rb +47 -0
- data/spec/models/update_campaign_spec.rb +4 -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 +4 -4
- data/spec/models/update_role_spec.rb +4 -4
- data/spec/models/update_user_spec.rb +4 -22
- data/spec/models/user_entity_spec.rb +4 -4
- data/spec/models/user_spec.rb +10 -4
- 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 +263 -233
- data/CHANGELOG.md +0 -63
- data/docs/AttributeQuery.md +0 -7
- 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/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/docs/InlineResponse20019.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20019
|
2
2
|
|
3
3
|
## Properties
|
4
|
+
|
4
5
|
Name | Type | Description | Notes
|
5
6
|
------------ | ------------- | ------------- | -------------
|
6
7
|
**total_result_size** | **Integer** | |
|
7
8
|
**data** | **Array<String>** | |
|
8
9
|
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20019.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
18
|
+
|
9
19
|
|
data/docs/InlineResponse2002.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse2002
|
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<Campaign>**](Campaign.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse2002.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse20020.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20020
|
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<Attribute>**](Attribute.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20020.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse20021.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20021
|
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<AccountAdditionalCost>**](AccountAdditionalCost.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20021.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse20022.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20022
|
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<Webhook>**](Webhook.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20022.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse20023.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20023
|
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<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20023.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse20024.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20024
|
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<WebhookLogEntry>**](WebhookLogEntry.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::InlineResponse20024.new(total_result_size: null,
|
16
|
+
data: null)
|
17
|
+
```
|
8
18
|
|
9
19
|
|
data/docs/InlineResponse20025.md
CHANGED
@@ -1,9 +1,19 @@
|
|
1
1
|
# TalonOne::InlineResponse20025
|
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<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
|
+
```
|
8
18
|
|
9
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,18 @@ 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
14
|
[**update_customer_profile**](IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
|
15
|
+
[**update_customer_profile_v2**](IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{customerProfileId} | Update a Customer Profile
|
15
16
|
[**update_customer_session**](IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
|
17
|
+
[**update_customer_session_v2**](IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update a Customer Session
|
16
18
|
|
17
19
|
|
18
|
-
|
20
|
+
|
21
|
+
## create_coupon_reservation
|
22
|
+
|
19
23
|
> Coupon create_coupon_reservation(coupon_value, body)
|
20
24
|
|
21
25
|
Create a new coupon reservation
|
@@ -23,6 +27,7 @@ Create a new coupon reservation
|
|
23
27
|
Creates a coupon reservation for all passed customer profiles on this couponID
|
24
28
|
|
25
29
|
### Example
|
30
|
+
|
26
31
|
```ruby
|
27
32
|
# load the gem
|
28
33
|
require 'talon_one'
|
@@ -40,12 +45,9 @@ TalonOne.configure do |config|
|
|
40
45
|
end
|
41
46
|
|
42
47
|
api_instance = TalonOne::IntegrationApi.new
|
43
|
-
|
44
48
|
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
45
|
-
|
46
49
|
body = TalonOne::CouponReservations.new # CouponReservations |
|
47
50
|
|
48
|
-
|
49
51
|
begin
|
50
52
|
#Create a new coupon reservation
|
51
53
|
result = api_instance.create_coupon_reservation(coupon_value, body)
|
@@ -57,6 +59,7 @@ end
|
|
57
59
|
|
58
60
|
### Parameters
|
59
61
|
|
62
|
+
|
60
63
|
Name | Type | Description | Notes
|
61
64
|
------------- | ------------- | ------------- | -------------
|
62
65
|
**coupon_value** | **String**| The value of a coupon |
|
@@ -72,12 +75,12 @@ Name | Type | Description | Notes
|
|
72
75
|
|
73
76
|
### HTTP request headers
|
74
77
|
|
75
|
-
|
76
|
-
|
78
|
+
- **Content-Type**: application/json
|
79
|
+
- **Accept**: application/json
|
77
80
|
|
78
81
|
|
82
|
+
## create_referral
|
79
83
|
|
80
|
-
# **create_referral**
|
81
84
|
> Referral create_referral(body)
|
82
85
|
|
83
86
|
Create a referral code for an advocate
|
@@ -85,6 +88,7 @@ Create a referral code for an advocate
|
|
85
88
|
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
89
|
|
87
90
|
### Example
|
91
|
+
|
88
92
|
```ruby
|
89
93
|
# load the gem
|
90
94
|
require 'talon_one'
|
@@ -102,10 +106,8 @@ TalonOne.configure do |config|
|
|
102
106
|
end
|
103
107
|
|
104
108
|
api_instance = TalonOne::IntegrationApi.new
|
105
|
-
|
106
109
|
body = TalonOne::NewReferral.new # NewReferral |
|
107
110
|
|
108
|
-
|
109
111
|
begin
|
110
112
|
#Create a referral code for an advocate
|
111
113
|
result = api_instance.create_referral(body)
|
@@ -117,6 +119,7 @@ end
|
|
117
119
|
|
118
120
|
### Parameters
|
119
121
|
|
122
|
+
|
120
123
|
Name | Type | Description | Notes
|
121
124
|
------------- | ------------- | ------------- | -------------
|
122
125
|
**body** | [**NewReferral**](NewReferral.md)| |
|
@@ -131,12 +134,12 @@ Name | Type | Description | Notes
|
|
131
134
|
|
132
135
|
### HTTP request headers
|
133
136
|
|
134
|
-
|
135
|
-
|
137
|
+
- **Content-Type**: application/json
|
138
|
+
- **Accept**: application/json
|
136
139
|
|
137
140
|
|
141
|
+
## delete_coupon_reservation
|
138
142
|
|
139
|
-
# **delete_coupon_reservation**
|
140
143
|
> delete_coupon_reservation(coupon_value, body)
|
141
144
|
|
142
145
|
Delete coupon reservations
|
@@ -144,6 +147,7 @@ Delete coupon reservations
|
|
144
147
|
Removes all passed customer profiles reservation from this coupon
|
145
148
|
|
146
149
|
### Example
|
150
|
+
|
147
151
|
```ruby
|
148
152
|
# load the gem
|
149
153
|
require 'talon_one'
|
@@ -161,12 +165,9 @@ TalonOne.configure do |config|
|
|
161
165
|
end
|
162
166
|
|
163
167
|
api_instance = TalonOne::IntegrationApi.new
|
164
|
-
|
165
168
|
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
166
|
-
|
167
169
|
body = TalonOne::CouponReservations.new # CouponReservations |
|
168
170
|
|
169
|
-
|
170
171
|
begin
|
171
172
|
#Delete coupon reservations
|
172
173
|
api_instance.delete_coupon_reservation(coupon_value, body)
|
@@ -177,6 +178,7 @@ end
|
|
177
178
|
|
178
179
|
### Parameters
|
179
180
|
|
181
|
+
|
180
182
|
Name | Type | Description | Notes
|
181
183
|
------------- | ------------- | ------------- | -------------
|
182
184
|
**coupon_value** | **String**| The value of a coupon |
|
@@ -192,12 +194,12 @@ nil (empty response body)
|
|
192
194
|
|
193
195
|
### HTTP request headers
|
194
196
|
|
195
|
-
|
196
|
-
|
197
|
+
- **Content-Type**: application/json
|
198
|
+
- **Accept**: Not defined
|
197
199
|
|
198
200
|
|
201
|
+
## delete_customer_data
|
199
202
|
|
200
|
-
# **delete_customer_data**
|
201
203
|
> delete_customer_data(integration_id)
|
202
204
|
|
203
205
|
Delete the personal data of a customer.
|
@@ -205,6 +207,7 @@ Delete the personal data of a customer.
|
|
205
207
|
Delete all attributes on the customer profile and on entities that reference that customer profile.
|
206
208
|
|
207
209
|
### Example
|
210
|
+
|
208
211
|
```ruby
|
209
212
|
# load the gem
|
210
213
|
require 'talon_one'
|
@@ -222,10 +225,8 @@ TalonOne.configure do |config|
|
|
222
225
|
end
|
223
226
|
|
224
227
|
api_instance = TalonOne::IntegrationApi.new
|
225
|
-
|
226
228
|
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
227
229
|
|
228
|
-
|
229
230
|
begin
|
230
231
|
#Delete the personal data of a customer.
|
231
232
|
api_instance.delete_customer_data(integration_id)
|
@@ -236,6 +237,7 @@ end
|
|
236
237
|
|
237
238
|
### Parameters
|
238
239
|
|
240
|
+
|
239
241
|
Name | Type | Description | Notes
|
240
242
|
------------- | ------------- | ------------- | -------------
|
241
243
|
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
@@ -250,19 +252,20 @@ nil (empty response body)
|
|
250
252
|
|
251
253
|
### HTTP request headers
|
252
254
|
|
253
|
-
|
254
|
-
|
255
|
+
- **Content-Type**: Not defined
|
256
|
+
- **Accept**: Not defined
|
255
257
|
|
256
258
|
|
259
|
+
## get_customer_inventory
|
257
260
|
|
258
|
-
|
259
|
-
> InlineResponse2001 get_reserved_coupons(integration_id)
|
261
|
+
> CustomerInventory get_customer_inventory(integration_id, opts)
|
260
262
|
|
261
|
-
Get all
|
263
|
+
Get an inventory of all data associated with a specific customer profile.
|
262
264
|
|
263
|
-
|
265
|
+
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
266
|
|
265
267
|
### Example
|
268
|
+
|
266
269
|
```ruby
|
267
270
|
# load the gem
|
268
271
|
require 'talon_one'
|
@@ -280,28 +283,35 @@ TalonOne.configure do |config|
|
|
280
283
|
end
|
281
284
|
|
282
285
|
api_instance = TalonOne::IntegrationApi.new
|
283
|
-
|
284
286
|
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
285
|
-
|
287
|
+
opts = {
|
288
|
+
profile: true, # Boolean | optional flag to decide if you would like customer profile information in the response
|
289
|
+
referrals: true, # Boolean | optional flag to decide if you would like referral information in the response
|
290
|
+
coupons: true # Boolean | optional flag to decide if you would like coupon information in the response
|
291
|
+
}
|
286
292
|
|
287
293
|
begin
|
288
|
-
#Get all
|
289
|
-
result = api_instance.
|
294
|
+
#Get an inventory of all data associated with a specific customer profile.
|
295
|
+
result = api_instance.get_customer_inventory(integration_id, opts)
|
290
296
|
p result
|
291
297
|
rescue TalonOne::ApiError => e
|
292
|
-
puts "Exception when calling IntegrationApi->
|
298
|
+
puts "Exception when calling IntegrationApi->get_customer_inventory: #{e}"
|
293
299
|
end
|
294
300
|
```
|
295
301
|
|
296
302
|
### Parameters
|
297
303
|
|
304
|
+
|
298
305
|
Name | Type | Description | Notes
|
299
306
|
------------- | ------------- | ------------- | -------------
|
300
307
|
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
308
|
+
**profile** | **Boolean**| optional flag to decide if you would like customer profile information in the response | [optional]
|
309
|
+
**referrals** | **Boolean**| optional flag to decide if you would like referral information in the response | [optional]
|
310
|
+
**coupons** | **Boolean**| optional flag to decide if you would like coupon information in the response | [optional]
|
301
311
|
|
302
312
|
### Return type
|
303
313
|
|
304
|
-
[**
|
314
|
+
[**CustomerInventory**](CustomerInventory.md)
|
305
315
|
|
306
316
|
### Authorization
|
307
317
|
|
@@ -309,12 +319,12 @@ Name | Type | Description | Notes
|
|
309
319
|
|
310
320
|
### HTTP request headers
|
311
321
|
|
312
|
-
|
313
|
-
|
322
|
+
- **Content-Type**: Not defined
|
323
|
+
- **Accept**: application/json
|
314
324
|
|
315
325
|
|
326
|
+
## get_reserved_customers
|
316
327
|
|
317
|
-
# **get_reserved_customers**
|
318
328
|
> InlineResponse200 get_reserved_customers(coupon_value)
|
319
329
|
|
320
330
|
Get the users that have this coupon reserved
|
@@ -322,6 +332,7 @@ Get the users that have this coupon reserved
|
|
322
332
|
Returns all users that have this coupon marked as reserved
|
323
333
|
|
324
334
|
### Example
|
335
|
+
|
325
336
|
```ruby
|
326
337
|
# load the gem
|
327
338
|
require 'talon_one'
|
@@ -339,10 +350,8 @@ TalonOne.configure do |config|
|
|
339
350
|
end
|
340
351
|
|
341
352
|
api_instance = TalonOne::IntegrationApi.new
|
342
|
-
|
343
353
|
coupon_value = 'coupon_value_example' # String | The value of a coupon
|
344
354
|
|
345
|
-
|
346
355
|
begin
|
347
356
|
#Get the users that have this coupon reserved
|
348
357
|
result = api_instance.get_reserved_customers(coupon_value)
|
@@ -354,6 +363,7 @@ end
|
|
354
363
|
|
355
364
|
### Parameters
|
356
365
|
|
366
|
+
|
357
367
|
Name | Type | Description | Notes
|
358
368
|
------------- | ------------- | ------------- | -------------
|
359
369
|
**coupon_value** | **String**| The value of a coupon |
|
@@ -368,19 +378,20 @@ Name | Type | Description | Notes
|
|
368
378
|
|
369
379
|
### HTTP request headers
|
370
380
|
|
371
|
-
|
372
|
-
|
381
|
+
- **Content-Type**: Not defined
|
382
|
+
- **Accept**: application/json
|
373
383
|
|
374
384
|
|
385
|
+
## track_event
|
375
386
|
|
376
|
-
|
377
|
-
> IntegrationState track_event(body)
|
387
|
+
> IntegrationState track_event(body, opts)
|
378
388
|
|
379
389
|
Track an Event
|
380
390
|
|
381
391
|
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
392
|
|
383
393
|
### Example
|
394
|
+
|
384
395
|
```ruby
|
385
396
|
# load the gem
|
386
397
|
require 'talon_one'
|
@@ -398,13 +409,14 @@ TalonOne.configure do |config|
|
|
398
409
|
end
|
399
410
|
|
400
411
|
api_instance = TalonOne::IntegrationApi.new
|
401
|
-
|
402
412
|
body = TalonOne::NewEvent.new # NewEvent |
|
403
|
-
|
413
|
+
opts = {
|
414
|
+
dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
415
|
+
}
|
404
416
|
|
405
417
|
begin
|
406
418
|
#Track an Event
|
407
|
-
result = api_instance.track_event(body)
|
419
|
+
result = api_instance.track_event(body, opts)
|
408
420
|
p result
|
409
421
|
rescue TalonOne::ApiError => e
|
410
422
|
puts "Exception when calling IntegrationApi->track_event: #{e}"
|
@@ -413,9 +425,11 @@ end
|
|
413
425
|
|
414
426
|
### Parameters
|
415
427
|
|
428
|
+
|
416
429
|
Name | Type | Description | Notes
|
417
430
|
------------- | ------------- | ------------- | -------------
|
418
431
|
**body** | [**NewEvent**](NewEvent.md)| |
|
432
|
+
**dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
419
433
|
|
420
434
|
### Return type
|
421
435
|
|
@@ -427,19 +441,20 @@ Name | Type | Description | Notes
|
|
427
441
|
|
428
442
|
### HTTP request headers
|
429
443
|
|
430
|
-
|
431
|
-
|
444
|
+
- **Content-Type**: application/json
|
445
|
+
- **Accept**: application/json
|
432
446
|
|
433
447
|
|
448
|
+
## update_customer_profile
|
434
449
|
|
435
|
-
|
436
|
-
> IntegrationState update_customer_profile(integration_id, body)
|
450
|
+
> IntegrationState update_customer_profile(integration_id, body, opts)
|
437
451
|
|
438
452
|
Update a Customer Profile
|
439
453
|
|
440
454
|
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
455
|
|
442
456
|
### Example
|
457
|
+
|
443
458
|
```ruby
|
444
459
|
# load the gem
|
445
460
|
require 'talon_one'
|
@@ -457,15 +472,15 @@ TalonOne.configure do |config|
|
|
457
472
|
end
|
458
473
|
|
459
474
|
api_instance = TalonOne::IntegrationApi.new
|
460
|
-
|
461
475
|
integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
462
|
-
|
463
476
|
body = TalonOne::NewCustomerProfile.new # NewCustomerProfile |
|
464
|
-
|
477
|
+
opts = {
|
478
|
+
dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
479
|
+
}
|
465
480
|
|
466
481
|
begin
|
467
482
|
#Update a Customer Profile
|
468
|
-
result = api_instance.update_customer_profile(integration_id, body)
|
483
|
+
result = api_instance.update_customer_profile(integration_id, body, opts)
|
469
484
|
p result
|
470
485
|
rescue TalonOne::ApiError => e
|
471
486
|
puts "Exception when calling IntegrationApi->update_customer_profile: #{e}"
|
@@ -474,10 +489,12 @@ end
|
|
474
489
|
|
475
490
|
### Parameters
|
476
491
|
|
492
|
+
|
477
493
|
Name | Type | Description | Notes
|
478
494
|
------------- | ------------- | ------------- | -------------
|
479
495
|
**integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
480
496
|
**body** | [**NewCustomerProfile**](NewCustomerProfile.md)| |
|
497
|
+
**dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
481
498
|
|
482
499
|
### Return type
|
483
500
|
|
@@ -489,19 +506,76 @@ Name | Type | Description | Notes
|
|
489
506
|
|
490
507
|
### HTTP request headers
|
491
508
|
|
492
|
-
|
493
|
-
|
509
|
+
- **Content-Type**: application/json
|
510
|
+
- **Accept**: application/json
|
511
|
+
|
512
|
+
|
513
|
+
## update_customer_profile_v2
|
514
|
+
|
515
|
+
> CustomerProfileUpdate update_customer_profile_v2(customer_profile_id, body)
|
516
|
+
|
517
|
+
Update a Customer Profile
|
518
|
+
|
519
|
+
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
|
520
|
+
|
521
|
+
### Example
|
522
|
+
|
523
|
+
```ruby
|
524
|
+
# load the gem
|
525
|
+
require 'talon_one'
|
526
|
+
# setup authorization
|
527
|
+
TalonOne.configure do |config|
|
528
|
+
# Configure API key authorization: api_key_v1
|
529
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
530
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
531
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
532
|
+
end
|
533
|
+
|
534
|
+
api_instance = TalonOne::IntegrationApi.new
|
535
|
+
customer_profile_id = 'customer_profile_id_example' # String | The custom identifier for this profile, must be unique within the account.
|
536
|
+
body = TalonOne::NewCustomerProfile.new # NewCustomerProfile |
|
537
|
+
|
538
|
+
begin
|
539
|
+
#Update a Customer Profile
|
540
|
+
result = api_instance.update_customer_profile_v2(customer_profile_id, body)
|
541
|
+
p result
|
542
|
+
rescue TalonOne::ApiError => e
|
543
|
+
puts "Exception when calling IntegrationApi->update_customer_profile_v2: #{e}"
|
544
|
+
end
|
545
|
+
```
|
546
|
+
|
547
|
+
### Parameters
|
548
|
+
|
549
|
+
|
550
|
+
Name | Type | Description | Notes
|
551
|
+
------------- | ------------- | ------------- | -------------
|
552
|
+
**customer_profile_id** | **String**| The custom identifier for this profile, must be unique within the account. |
|
553
|
+
**body** | [**NewCustomerProfile**](NewCustomerProfile.md)| |
|
554
|
+
|
555
|
+
### Return type
|
556
|
+
|
557
|
+
[**CustomerProfileUpdate**](CustomerProfileUpdate.md)
|
558
|
+
|
559
|
+
### Authorization
|
560
|
+
|
561
|
+
[api_key_v1](../README.md#api_key_v1)
|
562
|
+
|
563
|
+
### HTTP request headers
|
564
|
+
|
565
|
+
- **Content-Type**: application/json
|
566
|
+
- **Accept**: application/json
|
494
567
|
|
495
568
|
|
569
|
+
## update_customer_session
|
496
570
|
|
497
|
-
|
498
|
-
> IntegrationState update_customer_session(customer_session_id, body)
|
571
|
+
> IntegrationState update_customer_session(customer_session_id, body, opts)
|
499
572
|
|
500
573
|
Update a Customer Session
|
501
574
|
|
502
575
|
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
576
|
|
504
577
|
### Example
|
578
|
+
|
505
579
|
```ruby
|
506
580
|
# load the gem
|
507
581
|
require 'talon_one'
|
@@ -519,15 +593,15 @@ TalonOne.configure do |config|
|
|
519
593
|
end
|
520
594
|
|
521
595
|
api_instance = TalonOne::IntegrationApi.new
|
522
|
-
|
523
596
|
customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
|
524
|
-
|
525
597
|
body = TalonOne::NewCustomerSession.new # NewCustomerSession |
|
526
|
-
|
598
|
+
opts = {
|
599
|
+
dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
600
|
+
}
|
527
601
|
|
528
602
|
begin
|
529
603
|
#Update a Customer Session
|
530
|
-
result = api_instance.update_customer_session(customer_session_id, body)
|
604
|
+
result = api_instance.update_customer_session(customer_session_id, body, opts)
|
531
605
|
p result
|
532
606
|
rescue TalonOne::ApiError => e
|
533
607
|
puts "Exception when calling IntegrationApi->update_customer_session: #{e}"
|
@@ -536,10 +610,12 @@ end
|
|
536
610
|
|
537
611
|
### Parameters
|
538
612
|
|
613
|
+
|
539
614
|
Name | Type | Description | Notes
|
540
615
|
------------- | ------------- | ------------- | -------------
|
541
616
|
**customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
|
542
617
|
**body** | [**NewCustomerSession**](NewCustomerSession.md)| |
|
618
|
+
**dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
543
619
|
|
544
620
|
### Return type
|
545
621
|
|
@@ -551,8 +627,66 @@ Name | Type | Description | Notes
|
|
551
627
|
|
552
628
|
### HTTP request headers
|
553
629
|
|
554
|
-
|
555
|
-
|
630
|
+
- **Content-Type**: application/json
|
631
|
+
- **Accept**: application/json
|
632
|
+
|
633
|
+
|
634
|
+
## update_customer_session_v2
|
635
|
+
|
636
|
+
> IntegrationStateV2 update_customer_session_v2(customer_session_id, body, opts)
|
556
637
|
|
638
|
+
Update a Customer Session
|
639
|
+
|
640
|
+
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
|
641
|
+
|
642
|
+
### Example
|
643
|
+
|
644
|
+
```ruby
|
645
|
+
# load the gem
|
646
|
+
require 'talon_one'
|
647
|
+
# setup authorization
|
648
|
+
TalonOne.configure do |config|
|
649
|
+
# Configure API key authorization: api_key_v1
|
650
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
651
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
652
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
653
|
+
end
|
654
|
+
|
655
|
+
api_instance = TalonOne::IntegrationApi.new
|
656
|
+
customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
|
657
|
+
body = TalonOne::IntegrationRequest.new # IntegrationRequest |
|
658
|
+
opts = {
|
659
|
+
dry: true # Boolean | Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
660
|
+
}
|
661
|
+
|
662
|
+
begin
|
663
|
+
#Update a Customer Session
|
664
|
+
result = api_instance.update_customer_session_v2(customer_session_id, body, opts)
|
665
|
+
p result
|
666
|
+
rescue TalonOne::ApiError => e
|
667
|
+
puts "Exception when calling IntegrationApi->update_customer_session_v2: #{e}"
|
668
|
+
end
|
669
|
+
```
|
670
|
+
|
671
|
+
### Parameters
|
672
|
+
|
673
|
+
|
674
|
+
Name | Type | Description | Notes
|
675
|
+
------------- | ------------- | ------------- | -------------
|
676
|
+
**customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. |
|
677
|
+
**body** | [**IntegrationRequest**](IntegrationRequest.md)| |
|
678
|
+
**dry** | **Boolean**| Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true'). | [optional]
|
679
|
+
|
680
|
+
### Return type
|
681
|
+
|
682
|
+
[**IntegrationStateV2**](IntegrationStateV2.md)
|
683
|
+
|
684
|
+
### Authorization
|
685
|
+
|
686
|
+
[api_key_v1](../README.md#api_key_v1)
|
687
|
+
|
688
|
+
### HTTP request headers
|
557
689
|
|
690
|
+
- **Content-Type**: application/json
|
691
|
+
- **Accept**: application/json
|
558
692
|
|