talon_one 2.1.1 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +29 -9
- data/docs/AccountAnalytics.md +25 -19
- data/docs/AccountLimits.md +13 -13
- data/docs/AddLoyaltyPointsEffectProps.md +4 -2
- data/docs/Application.md +9 -1
- data/docs/ApplicationAPIKey.md +8 -6
- data/docs/ApplicationCustomer.md +3 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/Audience.md +27 -0
- data/docs/AudienceMembership.md +19 -0
- data/docs/Campaign.md +2 -0
- data/docs/CampaignAnalytics.md +9 -1
- data/docs/CampaignCopy.md +1 -1
- data/docs/CampaignGroup.md +31 -0
- data/docs/CampaignGroupEntity.md +17 -0
- data/docs/CreateApplicationAPIKey.md +3 -1
- data/docs/CustomerActivityReport.md +1 -1
- data/docs/CustomerInventory.md +2 -0
- data/docs/CustomerProfile.md +3 -1
- data/docs/CustomerProfileAudienceRequest.md +17 -0
- data/docs/CustomerProfileAudienceRequestItem.md +21 -0
- data/docs/CustomerProfileIntegrationRequestV2.md +19 -0
- data/docs/CustomerSession.md +1 -1
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/EntityWithTalangVisibleID.md +19 -0
- data/docs/FeedNotification.md +27 -0
- data/docs/InlineResponse20012.md +3 -1
- data/docs/IntegrationApi.md +139 -18
- data/docs/IntegrationEntity.md +1 -1
- data/docs/LoyaltyLedgerEntry.md +2 -0
- data/docs/LoyaltyPoints.md +4 -2
- data/docs/LoyaltyProgram.md +3 -1
- data/docs/LoyaltyStatistics.md +23 -0
- data/docs/LoyaltySubLedger.md +18 -4
- data/docs/ManagementApi.md +75 -10
- data/docs/Meta.md +1 -1
- data/docs/MultipleCustomerProfileIntegrationRequest.md +17 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +19 -0
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +17 -0
- data/docs/NewApplication.md +9 -1
- data/docs/NewApplicationAPIKey.md +7 -5
- data/docs/NewAudience.md +21 -0
- data/docs/NewCampaign.md +3 -1
- data/docs/NewCampaignGroup.md +23 -0
- data/docs/NewLoyaltyProgram.md +3 -1
- data/docs/Role.md +3 -1
- data/docs/SetDiscountEffectProps.md +3 -1
- data/docs/SetDiscountPerItemEffectProps.md +3 -1
- data/docs/UpdateApplication.md +10 -2
- data/docs/UpdateAudience.md +17 -0
- data/docs/UpdateCampaign.md +3 -1
- data/docs/UpdateCampaignGroup.md +23 -0
- data/docs/UpdateLoyaltyProgram.md +3 -1
- data/docs/UpdateUser.md +0 -4
- data/docs/UpdateUserLatestFeedTimestamp.md +17 -0
- data/docs/User.md +3 -5
- data/docs/UserFeedNotifications.md +19 -0
- data/lib/talon_one.rb +20 -3
- data/lib/talon_one/api/integration_api.rb +163 -25
- data/lib/talon_one/api/management_api.rb +86 -14
- data/lib/talon_one/api_client.rb +8 -6
- data/lib/talon_one/api_error.rb +1 -1
- data/lib/talon_one/configuration.rb +1 -1
- data/lib/talon_one/models/accept_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/accept_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/access_log_entry.rb +1 -1
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +1 -1
- data/lib/talon_one/models/account_analytics.rb +102 -57
- data/lib/talon_one/models/account_entity.rb +1 -1
- data/lib/talon_one/models/account_limits.rb +28 -23
- data/lib/talon_one/models/add_free_item_effect_props.rb +1 -1
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +19 -14
- data/lib/talon_one/models/additional_cost.rb +1 -1
- data/lib/talon_one/models/api_error.rb +1 -1
- data/lib/talon_one/models/application.rb +55 -3
- data/lib/talon_one/models/application_api_health.rb +1 -1
- data/lib/talon_one/models/application_api_key.rb +79 -34
- data/lib/talon_one/models/application_customer.rb +15 -3
- data/lib/talon_one/models/application_customer_entity.rb +1 -1
- data/lib/talon_one/models/application_customer_search.rb +1 -1
- data/lib/talon_one/models/application_entity.rb +1 -1
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_session.rb +2 -2
- data/lib/talon_one/models/application_session_entity.rb +1 -1
- data/lib/talon_one/models/attribute.rb +1 -1
- data/lib/talon_one/models/attributes_mandatory.rb +1 -1
- data/lib/talon_one/models/attributes_settings.rb +1 -1
- data/lib/talon_one/models/audience.rb +360 -0
- data/lib/talon_one/models/audience_membership.rb +227 -0
- data/lib/talon_one/models/base_saml_connection.rb +1 -1
- data/lib/talon_one/models/binding.rb +1 -1
- data/lib/talon_one/models/campaign.rb +14 -2
- data/lib/talon_one/models/campaign_analytics.rb +65 -5
- data/lib/talon_one/models/campaign_copy.rb +2 -2
- data/lib/talon_one/models/campaign_entity.rb +1 -1
- 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 +1 -1
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_set_branch_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_leaf_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_node.rb +1 -1
- data/lib/talon_one/models/cart_item.rb +1 -1
- data/lib/talon_one/models/cart_item_adjustment.rb +1 -1
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/change_profile_password.rb +1 -1
- data/lib/talon_one/models/code_generator_settings.rb +1 -1
- data/lib/talon_one/models/coupon.rb +1 -1
- data/lib/talon_one/models/coupon_constraints.rb +1 -1
- data/lib/talon_one/models/coupon_created_effect_props.rb +1 -1
- data/lib/talon_one/models/coupon_rejection_reason.rb +3 -3
- data/lib/talon_one/models/coupon_reservations.rb +1 -1
- data/lib/talon_one/models/coupon_search.rb +1 -1
- data/lib/talon_one/models/coupon_value.rb +1 -1
- data/lib/talon_one/models/create_application_api_key.rb +49 -5
- data/lib/talon_one/models/customer_activity_report.rb +2 -2
- data/lib/talon_one/models/customer_analytics.rb +1 -1
- data/lib/talon_one/models/customer_inventory.rb +11 -2
- data/lib/talon_one/models/customer_profile.rb +15 -3
- data/lib/talon_one/models/{misc_update_user_latest_feature.rb → customer_profile_audience_request.rb} +13 -11
- 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 +1 -1
- data/lib/talon_one/models/customer_session.rb +2 -2
- data/lib/talon_one/models/customer_session_v2.rb +2 -2
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +1 -1
- data/lib/talon_one/models/effect.rb +1 -1
- data/lib/talon_one/models/effect_entity.rb +1 -1
- data/lib/talon_one/models/email_entity.rb +1 -1
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +227 -0
- data/lib/talon_one/models/environment.rb +1 -1
- data/lib/talon_one/models/error_effect_props.rb +1 -1
- data/lib/talon_one/models/error_response.rb +1 -1
- data/lib/talon_one/models/error_source.rb +1 -1
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/event_type.rb +1 -1
- data/lib/talon_one/models/export.rb +1 -1
- data/lib/talon_one/models/feature_flag.rb +1 -1
- data/lib/talon_one/models/feature_flags.rb +1 -1
- data/lib/talon_one/models/features_feed.rb +1 -1
- data/lib/talon_one/models/feed_notification.rb +322 -0
- data/lib/talon_one/models/func_arg_def.rb +1 -1
- data/lib/talon_one/models/function_def.rb +1 -1
- data/lib/talon_one/models/import.rb +1 -1
- data/lib/talon_one/models/import_coupons.rb +1 -1
- data/lib/talon_one/models/inline_response200.rb +1 -1
- data/lib/talon_one/models/inline_response2001.rb +1 -1
- data/lib/talon_one/models/inline_response20010.rb +1 -1
- data/lib/talon_one/models/inline_response20011.rb +1 -1
- data/lib/talon_one/models/inline_response20012.rb +11 -7
- data/lib/talon_one/models/inline_response20013.rb +1 -1
- data/lib/talon_one/models/inline_response20014.rb +1 -1
- data/lib/talon_one/models/inline_response20015.rb +1 -1
- data/lib/talon_one/models/inline_response20016.rb +1 -1
- data/lib/talon_one/models/inline_response20017.rb +1 -1
- data/lib/talon_one/models/inline_response20018.rb +1 -1
- data/lib/talon_one/models/inline_response20019.rb +1 -1
- data/lib/talon_one/models/inline_response2002.rb +1 -1
- data/lib/talon_one/models/inline_response20020.rb +1 -1
- data/lib/talon_one/models/inline_response20021.rb +1 -1
- data/lib/talon_one/models/inline_response20022.rb +1 -1
- data/lib/talon_one/models/inline_response20023.rb +1 -1
- data/lib/talon_one/models/inline_response20024.rb +1 -1
- data/lib/talon_one/models/inline_response20025.rb +1 -1
- data/lib/talon_one/models/inline_response20026.rb +1 -1
- data/lib/talon_one/models/inline_response20027.rb +1 -1
- data/lib/talon_one/models/inline_response20028.rb +1 -1
- data/lib/talon_one/models/inline_response20029.rb +1 -1
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- data/lib/talon_one/models/inline_response20030.rb +1 -1
- data/lib/talon_one/models/inline_response2004.rb +1 -1
- data/lib/talon_one/models/inline_response2005.rb +1 -1
- data/lib/talon_one/models/inline_response2006.rb +1 -1
- data/lib/talon_one/models/inline_response2007.rb +1 -1
- data/lib/talon_one/models/inline_response2008.rb +1 -1
- data/lib/talon_one/models/inline_response2009.rb +1 -1
- data/lib/talon_one/models/integration_entity.rb +2 -2
- data/lib/talon_one/models/integration_event.rb +1 -1
- data/lib/talon_one/models/integration_profile_entity.rb +1 -1
- data/lib/talon_one/models/integration_request.rb +1 -1
- data/lib/talon_one/models/integration_state.rb +1 -1
- data/lib/talon_one/models/integration_state_v2.rb +1 -1
- data/lib/talon_one/models/ledger_entry.rb +1 -1
- data/lib/talon_one/models/library_attribute.rb +1 -1
- data/lib/talon_one/models/limit_config.rb +1 -1
- data/lib/talon_one/models/login_params.rb +1 -1
- data/lib/talon_one/models/loyalty.rb +1 -1
- data/lib/talon_one/models/loyalty_ledger.rb +1 -1
- data/lib/talon_one/models/loyalty_ledger_entry.rb +11 -2
- data/lib/talon_one/models/loyalty_membership.rb +1 -1
- data/lib/talon_one/models/loyalty_points.rb +19 -9
- data/lib/talon_one/models/loyalty_program.rb +18 -3
- data/lib/talon_one/models/loyalty_program_balance.rb +1 -1
- data/lib/talon_one/models/loyalty_program_ledgers.rb +1 -1
- data/lib/talon_one/models/loyalty_statistics.rb +258 -0
- data/lib/talon_one/models/loyalty_sub_ledger.rb +104 -7
- data/lib/talon_one/models/manager_config.rb +1 -1
- data/lib/talon_one/models/meta.rb +2 -1
- data/lib/talon_one/models/multi_application_entity.rb +1 -1
- 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/{customer_profile_update.rb → multiple_customer_profile_integration_response_v2.rb} +13 -16
- data/lib/talon_one/models/mutable_entity.rb +1 -1
- data/lib/talon_one/models/new_account.rb +1 -1
- data/lib/talon_one/models/new_account_sign_up.rb +1 -1
- data/lib/talon_one/models/new_additional_cost.rb +1 -1
- data/lib/talon_one/models/new_application.rb +55 -3
- data/lib/talon_one/models/new_application_api_key.rb +76 -32
- data/lib/talon_one/models/new_attribute.rb +1 -1
- data/lib/talon_one/models/new_audience.rb +314 -0
- data/lib/talon_one/models/new_campaign.rb +17 -5
- data/lib/talon_one/models/new_campaign_group.rb +265 -0
- data/lib/talon_one/models/new_campaign_set.rb +1 -1
- data/lib/talon_one/models/new_coupons.rb +1 -1
- data/lib/talon_one/models/new_customer_profile.rb +1 -1
- data/lib/talon_one/models/new_customer_session.rb +1 -1
- data/lib/talon_one/models/new_customer_session_v2.rb +1 -1
- data/lib/talon_one/models/new_event.rb +1 -1
- data/lib/talon_one/models/new_event_type.rb +1 -1
- data/lib/talon_one/models/new_feature_flags.rb +1 -1
- data/lib/talon_one/models/new_import.rb +1 -1
- data/lib/talon_one/models/new_invitation.rb +1 -1
- data/lib/talon_one/models/new_invite_email.rb +1 -1
- data/lib/talon_one/models/new_loyalty_program.rb +18 -3
- data/lib/talon_one/models/new_password.rb +1 -1
- data/lib/talon_one/models/new_password_email.rb +1 -1
- data/lib/talon_one/models/new_referral.rb +1 -1
- data/lib/talon_one/models/new_role.rb +1 -1
- data/lib/talon_one/models/new_ruleset.rb +1 -1
- data/lib/talon_one/models/new_saml_connection.rb +1 -1
- data/lib/talon_one/models/new_template_def.rb +1 -1
- data/lib/talon_one/models/new_user.rb +1 -1
- data/lib/talon_one/models/new_webhook.rb +1 -1
- data/lib/talon_one/models/notification.rb +1 -1
- data/lib/talon_one/models/redeem_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/referral.rb +1 -1
- data/lib/talon_one/models/referral_created_effect_props.rb +1 -1
- data/lib/talon_one/models/referral_rejection_reason.rb +3 -3
- data/lib/talon_one/models/reject_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/reject_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/role.rb +14 -4
- data/lib/talon_one/models/role_assign.rb +1 -1
- data/lib/talon_one/models/role_membership.rb +1 -1
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/rollback_discount_effect_props.rb +1 -1
- data/lib/talon_one/models/rule.rb +1 -1
- data/lib/talon_one/models/ruleset.rb +1 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/saml_connection_metadata.rb +1 -1
- data/lib/talon_one/models/saml_login_endpoint.rb +1 -1
- data/lib/talon_one/models/session.rb +1 -1
- data/lib/talon_one/models/set_discount_effect_props.rb +16 -6
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +15 -5
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +1 -1
- data/lib/talon_one/models/show_notification_effect_props.rb +1 -1
- data/lib/talon_one/models/slot_def.rb +1 -1
- data/lib/talon_one/models/template_arg_def.rb +1 -1
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +1 -1
- data/lib/talon_one/models/update_account.rb +1 -1
- data/lib/talon_one/models/update_application.rb +58 -6
- data/lib/talon_one/models/update_attribute_effect_props.rb +1 -1
- data/lib/talon_one/models/update_audience.rb +231 -0
- data/lib/talon_one/models/update_campaign.rb +17 -5
- data/lib/talon_one/models/update_campaign_group.rb +266 -0
- data/lib/talon_one/models/update_coupon.rb +1 -1
- data/lib/talon_one/models/update_coupon_batch.rb +1 -1
- data/lib/talon_one/models/update_loyalty_program.rb +13 -3
- data/lib/talon_one/models/update_role.rb +1 -1
- data/lib/talon_one/models/update_user.rb +2 -22
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +213 -0
- data/lib/talon_one/models/user.rb +11 -26
- data/lib/talon_one/models/user_entity.rb +1 -1
- data/lib/talon_one/models/user_feed_notifications.rb +230 -0
- data/lib/talon_one/models/webhook.rb +1 -1
- data/lib/talon_one/models/webhook_activation_log_entry.rb +1 -1
- data/lib/talon_one/models/webhook_log_entry.rb +1 -1
- data/lib/talon_one/version.rb +2 -2
- data/spec/api/integration_api_spec.rb +36 -8
- data/spec/api/management_api_spec.rb +19 -3
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/accept_coupon_effect_props_spec.rb +1 -1
- data/spec/models/accept_referral_effect_props_spec.rb +1 -1
- data/spec/models/access_log_entry_spec.rb +1 -1
- data/spec/models/account_additional_cost_spec.rb +1 -1
- data/spec/models/account_analytics_spec.rb +27 -9
- data/spec/models/account_entity_spec.rb +1 -1
- data/spec/models/account_limits_spec.rb +7 -7
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/add_free_item_effect_props_spec.rb +1 -1
- data/spec/models/add_loyalty_points_effect_props_spec.rb +8 -2
- data/spec/models/additional_cost_spec.rb +1 -1
- data/spec/models/api_error_spec.rb +1 -1
- data/spec/models/application_api_health_spec.rb +1 -1
- data/spec/models/application_api_key_spec.rb +18 -8
- data/spec/models/application_customer_entity_spec.rb +1 -1
- data/spec/models/application_customer_search_spec.rb +1 -1
- data/spec/models/application_customer_spec.rb +7 -1
- data/spec/models/application_entity_spec.rb +1 -1
- data/spec/models/application_event_spec.rb +1 -1
- data/spec/models/application_session_entity_spec.rb +1 -1
- data/spec/models/application_session_spec.rb +1 -1
- data/spec/models/application_spec.rb +29 -1
- data/spec/models/attribute_spec.rb +1 -1
- data/spec/models/attributes_mandatory_spec.rb +1 -1
- data/spec/models/attributes_settings_spec.rb +1 -1
- data/spec/models/audience_membership_spec.rb +47 -0
- data/spec/models/audience_spec.rb +75 -0
- data/spec/models/base_saml_connection_spec.rb +1 -1
- data/spec/models/binding_spec.rb +1 -1
- data/spec/models/campaign_analytics_spec.rb +25 -1
- data/spec/models/campaign_copy_spec.rb +1 -1
- data/spec/models/campaign_entity_spec.rb +1 -1
- data/spec/models/{misc_update_user_latest_feature_spec.rb → campaign_group_entity_spec.rb} +8 -8
- data/spec/models/campaign_group_spec.rb +83 -0
- data/spec/models/campaign_search_spec.rb +1 -1
- data/spec/models/campaign_set_branch_node_spec.rb +1 -1
- data/spec/models/campaign_set_leaf_node_spec.rb +1 -1
- data/spec/models/campaign_set_node_spec.rb +1 -1
- data/spec/models/campaign_set_spec.rb +1 -1
- data/spec/models/campaign_spec.rb +7 -1
- data/spec/models/cart_item_adjustment_spec.rb +1 -1
- data/spec/models/cart_item_spec.rb +1 -1
- data/spec/models/change_profile_password_spec.rb +1 -1
- data/spec/models/change_spec.rb +1 -1
- data/spec/models/code_generator_settings_spec.rb +1 -1
- data/spec/models/coupon_constraints_spec.rb +1 -1
- data/spec/models/coupon_created_effect_props_spec.rb +1 -1
- data/spec/models/coupon_rejection_reason_spec.rb +2 -2
- data/spec/models/coupon_reservations_spec.rb +1 -1
- data/spec/models/coupon_search_spec.rb +1 -1
- data/spec/models/coupon_spec.rb +1 -1
- data/spec/models/coupon_value_spec.rb +1 -1
- data/spec/models/create_application_api_key_spec.rb +11 -1
- data/spec/models/customer_activity_report_spec.rb +1 -1
- data/spec/models/customer_analytics_spec.rb +1 -1
- data/spec/models/customer_inventory_spec.rb +7 -1
- data/spec/models/customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/{customer_profile_update_spec.rb → customer_profile_audience_request_spec.rb} +8 -8
- data/spec/models/customer_profile_integration_request_v2_spec.rb +51 -0
- data/spec/models/customer_profile_search_query_spec.rb +1 -1
- data/spec/models/customer_profile_spec.rb +7 -1
- data/spec/models/customer_session_spec.rb +1 -1
- data/spec/models/customer_session_v2_spec.rb +1 -1
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +1 -1
- data/spec/models/effect_entity_spec.rb +1 -1
- data/spec/models/effect_spec.rb +1 -1
- data/spec/models/email_entity_spec.rb +1 -1
- data/spec/models/entity_spec.rb +1 -1
- data/spec/models/entity_with_talang_visible_id_spec.rb +47 -0
- data/spec/models/environment_spec.rb +1 -1
- data/spec/models/error_effect_props_spec.rb +1 -1
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/event_spec.rb +1 -1
- data/spec/models/event_type_spec.rb +1 -1
- data/spec/models/export_spec.rb +1 -1
- data/spec/models/feature_flag_spec.rb +1 -1
- data/spec/models/feature_flags_spec.rb +1 -1
- data/spec/models/features_feed_spec.rb +1 -1
- data/spec/models/feed_notification_spec.rb +75 -0
- data/spec/models/func_arg_def_spec.rb +1 -1
- data/spec/models/function_def_spec.rb +1 -1
- data/spec/models/import_coupons_spec.rb +1 -1
- data/spec/models/import_spec.rb +1 -1
- data/spec/models/inline_response20010_spec.rb +1 -1
- data/spec/models/inline_response20011_spec.rb +1 -1
- data/spec/models/inline_response20012_spec.rb +7 -1
- data/spec/models/inline_response20013_spec.rb +1 -1
- data/spec/models/inline_response20014_spec.rb +1 -1
- data/spec/models/inline_response20015_spec.rb +1 -1
- data/spec/models/inline_response20016_spec.rb +1 -1
- data/spec/models/inline_response20017_spec.rb +1 -1
- data/spec/models/inline_response20018_spec.rb +1 -1
- data/spec/models/inline_response20019_spec.rb +1 -1
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +1 -1
- data/spec/models/inline_response20021_spec.rb +1 -1
- data/spec/models/inline_response20022_spec.rb +1 -1
- data/spec/models/inline_response20023_spec.rb +1 -1
- data/spec/models/inline_response20024_spec.rb +1 -1
- data/spec/models/inline_response20025_spec.rb +1 -1
- data/spec/models/inline_response20026_spec.rb +1 -1
- data/spec/models/inline_response20027_spec.rb +1 -1
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +1 -1
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response20030_spec.rb +1 -1
- data/spec/models/inline_response2003_spec.rb +1 -1
- data/spec/models/inline_response2004_spec.rb +1 -1
- data/spec/models/inline_response2005_spec.rb +1 -1
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2007_spec.rb +1 -1
- data/spec/models/inline_response2008_spec.rb +1 -1
- data/spec/models/inline_response2009_spec.rb +1 -1
- data/spec/models/inline_response200_spec.rb +1 -1
- data/spec/models/integration_entity_spec.rb +1 -1
- data/spec/models/integration_event_spec.rb +1 -1
- data/spec/models/integration_profile_entity_spec.rb +1 -1
- data/spec/models/integration_request_spec.rb +1 -1
- data/spec/models/integration_state_spec.rb +1 -1
- data/spec/models/integration_state_v2_spec.rb +1 -1
- data/spec/models/ledger_entry_spec.rb +1 -1
- data/spec/models/library_attribute_spec.rb +1 -1
- data/spec/models/limit_config_spec.rb +1 -1
- data/spec/models/login_params_spec.rb +1 -1
- data/spec/models/loyalty_ledger_entry_spec.rb +7 -1
- data/spec/models/loyalty_ledger_spec.rb +1 -1
- data/spec/models/loyalty_membership_spec.rb +1 -1
- data/spec/models/loyalty_points_spec.rb +8 -2
- data/spec/models/loyalty_program_balance_spec.rb +1 -1
- data/spec/models/loyalty_program_ledgers_spec.rb +1 -1
- data/spec/models/loyalty_program_spec.rb +7 -1
- data/spec/models/loyalty_spec.rb +1 -1
- data/spec/models/loyalty_statistics_spec.rb +59 -0
- data/spec/models/loyalty_sub_ledger_spec.rb +43 -1
- data/spec/models/manager_config_spec.rb +1 -1
- data/spec/models/meta_spec.rb +1 -1
- data/spec/models/multi_application_entity_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/new_account_sign_up_spec.rb +1 -1
- data/spec/models/new_account_spec.rb +1 -1
- data/spec/models/new_additional_cost_spec.rb +1 -1
- data/spec/models/new_application_api_key_spec.rb +18 -8
- data/spec/models/new_application_spec.rb +29 -1
- data/spec/models/new_attribute_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/new_campaign_spec.rb +7 -1
- data/spec/models/new_coupons_spec.rb +1 -1
- data/spec/models/new_customer_profile_spec.rb +1 -1
- data/spec/models/new_customer_session_spec.rb +1 -1
- data/spec/models/new_customer_session_v2_spec.rb +1 -1
- data/spec/models/new_event_spec.rb +1 -1
- data/spec/models/new_event_type_spec.rb +1 -1
- data/spec/models/new_feature_flags_spec.rb +1 -1
- data/spec/models/new_import_spec.rb +1 -1
- data/spec/models/new_invitation_spec.rb +1 -1
- data/spec/models/new_invite_email_spec.rb +1 -1
- data/spec/models/new_loyalty_program_spec.rb +7 -1
- data/spec/models/new_password_email_spec.rb +1 -1
- data/spec/models/new_password_spec.rb +1 -1
- data/spec/models/new_referral_spec.rb +1 -1
- data/spec/models/new_role_spec.rb +1 -1
- data/spec/models/new_ruleset_spec.rb +1 -1
- data/spec/models/new_saml_connection_spec.rb +1 -1
- data/spec/models/new_template_def_spec.rb +1 -1
- data/spec/models/new_user_spec.rb +1 -1
- data/spec/models/new_webhook_spec.rb +1 -1
- data/spec/models/notification_spec.rb +1 -1
- data/spec/models/redeem_referral_effect_props_spec.rb +1 -1
- data/spec/models/referral_created_effect_props_spec.rb +1 -1
- data/spec/models/referral_rejection_reason_spec.rb +2 -2
- data/spec/models/referral_spec.rb +1 -1
- data/spec/models/reject_coupon_effect_props_spec.rb +1 -1
- data/spec/models/reject_referral_effect_props_spec.rb +1 -1
- data/spec/models/role_assign_spec.rb +1 -1
- data/spec/models/role_membership_spec.rb +1 -1
- data/spec/models/role_spec.rb +7 -1
- data/spec/models/rollback_coupon_effect_props_spec.rb +1 -1
- data/spec/models/rollback_discount_effect_props_spec.rb +1 -1
- data/spec/models/rule_spec.rb +1 -1
- data/spec/models/ruleset_spec.rb +1 -1
- data/spec/models/saml_connection_metadata_spec.rb +1 -1
- data/spec/models/saml_connection_spec.rb +1 -1
- data/spec/models/saml_login_endpoint_spec.rb +1 -1
- data/spec/models/session_spec.rb +1 -1
- data/spec/models/set_discount_effect_props_spec.rb +7 -1
- data/spec/models/set_discount_per_item_effect_props_spec.rb +7 -1
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +1 -1
- data/spec/models/show_notification_effect_props_spec.rb +1 -1
- data/spec/models/slot_def_spec.rb +1 -1
- data/spec/models/template_arg_def_spec.rb +1 -1
- data/spec/models/template_def_spec.rb +1 -1
- data/spec/models/trigger_webhook_effect_props_spec.rb +1 -1
- data/spec/models/update_account_spec.rb +1 -1
- data/spec/models/update_application_spec.rb +29 -1
- data/spec/models/update_attribute_effect_props_spec.rb +1 -1
- 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 +7 -1
- data/spec/models/update_coupon_batch_spec.rb +1 -1
- data/spec/models/update_coupon_spec.rb +1 -1
- data/spec/models/update_loyalty_program_spec.rb +7 -1
- data/spec/models/update_role_spec.rb +1 -1
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +41 -0
- data/spec/models/update_user_spec.rb +1 -13
- data/spec/models/user_entity_spec.rb +1 -1
- data/spec/models/user_feed_notifications_spec.rb +47 -0
- data/spec/models/user_spec.rb +2 -8
- data/spec/models/webhook_activation_log_entry_spec.rb +1 -1
- data/spec/models/webhook_log_entry_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/talon_one.gemspec +1 -1
- metadata +78 -10
- data/docs/CustomerProfileUpdate.md +0 -17
- data/docs/MiscUpdateUserLatestFeature.md +0 -17
data/docs/CampaignAnalytics.md
CHANGED
@@ -25,6 +25,10 @@ Name | Type | Description | Notes
|
|
25
25
|
**total_coupons_created** | **Integer** | Number of coupons created in the campaign by the rule engine since it began. |
|
26
26
|
**referrals_created** | **Integer** | Number of referrals created in the campaign by the rule engine. |
|
27
27
|
**total_referrals_created** | **Integer** | Number of referrals created in the campaign by the rule engine since it began. |
|
28
|
+
**added_loyalty_points** | **Float** | Number of added loyalty points in the campaign in a specific interval. |
|
29
|
+
**total_added_loyalty_points** | **Float** | Number of added loyalty points in the campaign since it began. |
|
30
|
+
**deducted_loyalty_points** | **Float** | Number of deducted loyalty points in the campaign in a specific interval. |
|
31
|
+
**total_deducted_loyalty_points** | **Float** | Number of deducted loyalty points in the campaign since it began. |
|
28
32
|
|
29
33
|
## Code Sample
|
30
34
|
|
@@ -51,7 +55,11 @@ instance = TalonOne::CampaignAnalytics.new(date: null,
|
|
51
55
|
coupons_created: null,
|
52
56
|
total_coupons_created: null,
|
53
57
|
referrals_created: null,
|
54
|
-
total_referrals_created: null
|
58
|
+
total_referrals_created: null,
|
59
|
+
added_loyalty_points: null,
|
60
|
+
total_added_loyalty_points: null,
|
61
|
+
deducted_loyalty_points: null,
|
62
|
+
total_deducted_loyalty_points: null)
|
55
63
|
```
|
56
64
|
|
57
65
|
|
data/docs/CampaignCopy.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**name** | **String** | Name of the copied campaign (Defaults to \"Copy of original campaign name\") | [optional]
|
8
|
-
**application_ids** | **Array<
|
8
|
+
**application_ids** | **Array<Integer>** | Application IDs of the applications to which a campaign should be copied to |
|
9
9
|
**description** | **String** | A detailed description of the campaign. | [optional]
|
10
10
|
**start_time** | **DateTime** | Datetime when the campaign will become active. | [optional]
|
11
11
|
**end_time** | **DateTime** | Datetime when the campaign will become in-active. | [optional]
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# TalonOne::CampaignGroup
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | Unique ID for this entity. |
|
8
|
+
**created** | **DateTime** | The exact moment this entity was created. |
|
9
|
+
**modified** | **DateTime** | The exact moment this entity was last modified. |
|
10
|
+
**account_id** | **Integer** | The ID of the account that owns this entity. |
|
11
|
+
**name** | **String** | The name of this campaign group. |
|
12
|
+
**description** | **String** | A longer description of the campaign group. | [optional]
|
13
|
+
**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this campaign group is enabled for | [optional]
|
14
|
+
**campaign_ids** | **Array<Integer>** | A list of the IDs of the campaigns that this campaign group owns | [optional]
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'TalonOne'
|
20
|
+
|
21
|
+
instance = TalonOne::CampaignGroup.new(id: null,
|
22
|
+
created: null,
|
23
|
+
modified: null,
|
24
|
+
account_id: null,
|
25
|
+
name: null,
|
26
|
+
description: null,
|
27
|
+
subscribed_applications_ids: null,
|
28
|
+
campaign_ids: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TalonOne::CampaignGroupEntity
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**campaign_groups** | **Array<Integer>** | The IDs of the campaign groups that own this entity. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TalonOne'
|
13
|
+
|
14
|
+
instance = TalonOne::CampaignGroupEntity.new(campaign_groups: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**title** | **String** | Title for API Key |
|
8
8
|
**expires** | **DateTime** | The date the API key expired |
|
9
|
+
**platform** | **String** | Platform the API key is valid for. | [optional]
|
9
10
|
|
10
11
|
## Code Sample
|
11
12
|
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
13
14
|
require 'TalonOne'
|
14
15
|
|
15
16
|
instance = TalonOne::CreateApplicationAPIKey.new(title: null,
|
16
|
-
expires: null
|
17
|
+
expires: null,
|
18
|
+
platform: null)
|
17
19
|
```
|
18
20
|
|
19
21
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**integration_id** | **String** | The ID
|
7
|
+
**integration_id** | **String** | The integration ID for this entity sent to and used in the Talon.One system. |
|
8
8
|
**created** | **DateTime** | The exact moment this entity was created. |
|
9
9
|
**name** | **String** | The name for this customer profile. |
|
10
10
|
**customer_id** | **Integer** | The internal Talon.One ID of the customer. |
|
data/docs/CustomerInventory.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**profile** | [**CustomerProfile**](CustomerProfile.md) | | [optional]
|
8
|
+
**loyalty** | [**Loyalty**](Loyalty.md) | | [optional]
|
8
9
|
**referrals** | [**Array<Referral>**](Referral.md) | | [optional]
|
9
10
|
**coupons** | [**Array<Coupon>**](Coupon.md) | | [optional]
|
10
11
|
|
@@ -14,6 +15,7 @@ Name | Type | Description | Notes
|
|
14
15
|
require 'TalonOne'
|
15
16
|
|
16
17
|
instance = TalonOne::CustomerInventory.new(profile: null,
|
18
|
+
loyalty: null,
|
17
19
|
referrals: null,
|
18
20
|
coupons: null)
|
19
21
|
```
|
data/docs/CustomerProfile.md
CHANGED
@@ -4,13 +4,14 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**integration_id** | **String** | The ID
|
7
|
+
**integration_id** | **String** | The integration ID for this entity sent to and used in the Talon.One system. |
|
8
8
|
**created** | **DateTime** | The exact moment this entity was created. |
|
9
9
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item |
|
10
10
|
**account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |
|
11
11
|
**closed_sessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. |
|
12
12
|
**total_sales** | **Float** | Sum of all purchases made by this customer |
|
13
13
|
**loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional]
|
14
|
+
**audience_memberships** | [**Array<AudienceMembership>**](AudienceMembership.md) | A list of audiences the customer belongs to | [optional]
|
14
15
|
**last_activity** | **DateTime** | Timestamp of the most recent event received from this customer |
|
15
16
|
|
16
17
|
## Code Sample
|
@@ -25,6 +26,7 @@ instance = TalonOne::CustomerProfile.new(integration_id: null,
|
|
25
26
|
closed_sessions: null,
|
26
27
|
total_sales: null,
|
27
28
|
loyalty_memberships: null,
|
29
|
+
audience_memberships: null,
|
28
30
|
last_activity: null)
|
29
31
|
```
|
30
32
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TalonOne::CustomerProfileAudienceRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**data** | [**Array<CustomerProfileAudienceRequestItem>**](CustomerProfileAudienceRequestItem.md) | | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TalonOne'
|
13
|
+
|
14
|
+
instance = TalonOne::CustomerProfileAudienceRequest.new(data: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# TalonOne::CustomerProfileAudienceRequestItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**action** | **String** | |
|
8
|
+
**profile_integration_id** | **String** | |
|
9
|
+
**audience_id** | **Integer** | |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'TalonOne'
|
15
|
+
|
16
|
+
instance = TalonOne::CustomerProfileAudienceRequestItem.new(action: null,
|
17
|
+
profile_integration_id: null,
|
18
|
+
audience_id: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::CustomerProfileIntegrationRequestV2
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional]
|
8
|
+
**response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\" and \"event\". | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::CustomerProfileIntegrationRequestV2.new(attributes: null,
|
16
|
+
response_content: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
data/docs/CustomerSession.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**integration_id** | **String** | The ID
|
7
|
+
**integration_id** | **String** | The integration ID for this entity sent to and used in the Talon.One system. |
|
8
8
|
**created** | **DateTime** | The exact moment this entity was created. |
|
9
9
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
10
10
|
**profile_id** | **String** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. |
|
data/docs/CustomerSessionV2.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**integration_id** | **String** | The ID
|
7
|
+
**integration_id** | **String** | The integration ID for this entity sent to and used in the Talon.One system. |
|
8
8
|
**created** | **DateTime** | The exact moment this entity was created. |
|
9
9
|
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
10
10
|
**profile_id** | **String** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. |
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::EntityWithTalangVisibleID
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **Integer** | Unique ID for this entity. |
|
8
|
+
**created** | **DateTime** | The exact moment this entity was created. |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::EntityWithTalangVisibleID.new(id: null,
|
16
|
+
created: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# TalonOne::FeedNotification
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**title** | **String** | Title of the feed notification |
|
8
|
+
**created** | **DateTime** | Timestamp of the moment this feed notification was created |
|
9
|
+
**updated** | **DateTime** | Timestamp of the moment this feed notification was last updated |
|
10
|
+
**article_url** | **String** | URL to the feed notification in the help center |
|
11
|
+
**type** | **String** | The type of the feed notification |
|
12
|
+
**body** | **String** | Body of the feed notification |
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'TalonOne'
|
18
|
+
|
19
|
+
instance = TalonOne::FeedNotification.new(title: null,
|
20
|
+
created: null,
|
21
|
+
updated: null,
|
22
|
+
article_url: null,
|
23
|
+
type: null,
|
24
|
+
body: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
data/docs/InlineResponse20012.md
CHANGED
@@ -4,7 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**total_result_size** | **Integer** | |
|
7
|
+
**total_result_size** | **Integer** | | [optional]
|
8
|
+
**has_more** | **Boolean** | | [optional]
|
8
9
|
**data** | [**Array<ApplicationCustomer>**](ApplicationCustomer.md) | |
|
9
10
|
|
10
11
|
## Code Sample
|
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
|
|
13
14
|
require 'TalonOne'
|
14
15
|
|
15
16
|
instance = TalonOne::InlineResponse20012.new(total_result_size: null,
|
17
|
+
has_more: null,
|
16
18
|
data: null)
|
17
19
|
```
|
18
20
|
|
data/docs/IntegrationApi.md
CHANGED
@@ -11,9 +11,11 @@ Method | HTTP request | Description
|
|
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
|
-
[**
|
16
|
-
[**
|
14
|
+
[**update_customer_profile**](IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1
|
15
|
+
[**update_customer_profile_audiences**](IntegrationApi.md#update_customer_profile_audiences) | **POST** /v2/customer_audiences | Update a Customer Profile Audiences
|
16
|
+
[**update_customer_profile_v2**](IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{integrationId} | Update a Customer Profile
|
17
|
+
[**update_customer_profiles_v2**](IntegrationApi.md#update_customer_profiles_v2) | **PUT** /v2/customer_profiles | Update multiple Customer Profiles
|
18
|
+
[**update_customer_session**](IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session V1
|
17
19
|
[**update_customer_session_v2**](IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update a Customer Session
|
18
20
|
|
19
21
|
|
@@ -287,7 +289,8 @@ integration_id = 'integration_id_example' # String | The custom identifier for t
|
|
287
289
|
opts = {
|
288
290
|
profile: true, # Boolean | optional flag to decide if you would like customer profile information in the response
|
289
291
|
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
|
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
|
291
294
|
}
|
292
295
|
|
293
296
|
begin
|
@@ -308,6 +311,7 @@ Name | Type | Description | Notes
|
|
308
311
|
**profile** | **Boolean**| optional flag to decide if you would like customer profile information in the response | [optional]
|
309
312
|
**referrals** | **Boolean**| optional flag to decide if you would like referral information in the response | [optional]
|
310
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]
|
311
315
|
|
312
316
|
### Return type
|
313
317
|
|
@@ -449,9 +453,9 @@ Name | Type | Description | Notes
|
|
449
453
|
|
450
454
|
> IntegrationState update_customer_profile(integration_id, body, opts)
|
451
455
|
|
452
|
-
Update a Customer Profile
|
456
|
+
Update a Customer Profile V1
|
453
457
|
|
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
|
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
|
455
459
|
|
456
460
|
### Example
|
457
461
|
|
@@ -479,7 +483,7 @@ opts = {
|
|
479
483
|
}
|
480
484
|
|
481
485
|
begin
|
482
|
-
#Update a Customer Profile
|
486
|
+
#Update a Customer Profile V1
|
483
487
|
result = api_instance.update_customer_profile(integration_id, body, opts)
|
484
488
|
p result
|
485
489
|
rescue TalonOne::ApiError => e
|
@@ -510,13 +514,66 @@ Name | Type | Description | Notes
|
|
510
514
|
- **Accept**: application/json
|
511
515
|
|
512
516
|
|
517
|
+
## update_customer_profile_audiences
|
518
|
+
|
519
|
+
> update_customer_profile_audiences(body)
|
520
|
+
|
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
|
+
|
513
570
|
## update_customer_profile_v2
|
514
571
|
|
515
|
-
>
|
572
|
+
> IntegrationStateV2 update_customer_profile_v2(integration_id, body, opts)
|
516
573
|
|
517
574
|
Update a Customer Profile
|
518
575
|
|
519
|
-
Update (or create) a [Customer Profile][].
|
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
|
520
577
|
|
521
578
|
### Example
|
522
579
|
|
@@ -532,12 +589,16 @@ TalonOne.configure do |config|
|
|
532
589
|
end
|
533
590
|
|
534
591
|
api_instance = TalonOne::IntegrationApi.new
|
535
|
-
|
536
|
-
body = TalonOne::
|
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
|
+
}
|
537
598
|
|
538
599
|
begin
|
539
600
|
#Update a Customer Profile
|
540
|
-
result = api_instance.update_customer_profile_v2(
|
601
|
+
result = api_instance.update_customer_profile_v2(integration_id, body, opts)
|
541
602
|
p result
|
542
603
|
rescue TalonOne::ApiError => e
|
543
604
|
puts "Exception when calling IntegrationApi->update_customer_profile_v2: #{e}"
|
@@ -549,12 +610,72 @@ end
|
|
549
610
|
|
550
611
|
Name | Type | Description | Notes
|
551
612
|
------------- | ------------- | ------------- | -------------
|
552
|
-
**
|
553
|
-
**body** | [**
|
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]
|
554
675
|
|
555
676
|
### Return type
|
556
677
|
|
557
|
-
[**
|
678
|
+
[**MultipleCustomerProfileIntegrationResponseV2**](MultipleCustomerProfileIntegrationResponseV2.md)
|
558
679
|
|
559
680
|
### Authorization
|
560
681
|
|
@@ -570,9 +691,9 @@ Name | Type | Description | Notes
|
|
570
691
|
|
571
692
|
> IntegrationState update_customer_session(customer_session_id, body, opts)
|
572
693
|
|
573
|
-
Update a Customer Session
|
694
|
+
Update a Customer Session V1
|
574
695
|
|
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
|
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
|
576
697
|
|
577
698
|
### Example
|
578
699
|
|
@@ -600,7 +721,7 @@ opts = {
|
|
600
721
|
}
|
601
722
|
|
602
723
|
begin
|
603
|
-
#Update a Customer Session
|
724
|
+
#Update a Customer Session V1
|
604
725
|
result = api_instance.update_customer_session(customer_session_id, body, opts)
|
605
726
|
p result
|
606
727
|
rescue TalonOne::ApiError => e
|