Module: TalonOne

Defined in:
lib/talon_one/version.rb,
lib/talon_one.rb,
lib/talon_one/api_error.rb,
lib/talon_one/api_client.rb,
lib/talon_one/models/meta.rb,
lib/talon_one/models/role.rb,
lib/talon_one/models/rule.rb,
lib/talon_one/models/user.rb,
lib/talon_one/models/event.rb,
lib/talon_one/configuration.rb,
lib/talon_one/models/change.rb,
lib/talon_one/models/coupon.rb,
lib/talon_one/models/effect.rb,
lib/talon_one/models/entity.rb,
lib/talon_one/models/export.rb,
lib/talon_one/models/import.rb,
lib/talon_one/models/account.rb,
lib/talon_one/models/binding.rb,
lib/talon_one/models/loyalty.rb,
lib/talon_one/models/ruleset.rb,
lib/talon_one/models/session.rb,
lib/talon_one/models/webhook.rb,
lib/talon_one/models/campaign.rb,
lib/talon_one/models/new_role.rb,
lib/talon_one/models/new_user.rb,
lib/talon_one/models/referral.rb,
lib/talon_one/models/slot_def.rb,
lib/talon_one/models/api_error.rb,
lib/talon_one/models/attribute.rb,
lib/talon_one/models/cart_item.rb,
lib/talon_one/models/new_event.rb,
lib/talon_one/models/event_type.rb,
lib/talon_one/models/new_import.rb,
lib/talon_one/api/management_api.rb,
lib/talon_one/models/application.rb,
lib/talon_one/models/environment.rb,
lib/talon_one/models/new_account.rb,
lib/talon_one/models/new_coupons.rb,
lib/talon_one/models/new_ruleset.rb,
lib/talon_one/models/new_webhook.rb,
lib/talon_one/models/role_assign.rb,
lib/talon_one/models/update_role.rb,
lib/talon_one/models/update_user.rb,
lib/talon_one/models/user_entity.rb,
lib/talon_one/api/integration_api.rb,
lib/talon_one/models/campaign_set.rb,
lib/talon_one/models/coupon_value.rb,
lib/talon_one/models/email_entity.rb,
lib/talon_one/models/error_source.rb,
lib/talon_one/models/feature_flag.rb,
lib/talon_one/models/func_arg_def.rb,
lib/talon_one/models/function_def.rb,
lib/talon_one/models/ledger_entry.rb,
lib/talon_one/models/limit_config.rb,
lib/talon_one/models/login_params.rb,
lib/talon_one/models/new_campaign.rb,
lib/talon_one/models/new_password.rb,
lib/talon_one/models/new_referral.rb,
lib/talon_one/models/notification.rb,
lib/talon_one/models/template_def.rb,
lib/talon_one/models/campaign_copy.rb,
lib/talon_one/models/coupon_search.rb,
lib/talon_one/models/effect_entity.rb,
lib/talon_one/models/feature_flags.rb,
lib/talon_one/models/features_feed.rb,
lib/talon_one/models/new_attribute.rb,
lib/talon_one/models/update_coupon.rb,
lib/talon_one/models/account_entity.rb,
lib/talon_one/models/account_limits.rb,
lib/talon_one/models/error_response.rb,
lib/talon_one/models/import_coupons.rb,
lib/talon_one/models/loyalty_ledger.rb,
lib/talon_one/models/loyalty_points.rb,
lib/talon_one/models/manager_config.rb,
lib/talon_one/models/mutable_entity.rb,
lib/talon_one/models/new_event_type.rb,
lib/talon_one/models/new_invitation.rb,
lib/talon_one/models/update_account.rb,
lib/talon_one/models/additional_cost.rb,
lib/talon_one/models/campaign_entity.rb,
lib/talon_one/models/campaign_search.rb,
lib/talon_one/models/loyalty_program.rb,
lib/talon_one/models/new_application.rb,
lib/talon_one/models/role_membership.rb,
lib/talon_one/models/saml_connection.rb,
lib/talon_one/models/update_campaign.rb,
lib/talon_one/models/access_log_entry.rb,
lib/talon_one/models/customer_profile.rb,
lib/talon_one/models/customer_session.rb,
lib/talon_one/models/new_campaign_set.rb,
lib/talon_one/models/new_invite_email.rb,
lib/talon_one/models/new_template_def.rb,
lib/talon_one/models/template_arg_def.rb,
lib/talon_one/models/account_analytics.rb,
lib/talon_one/models/application_event.rb,
lib/talon_one/models/campaign_set_node.rb,
lib/talon_one/models/integration_event.rb,
lib/talon_one/models/integration_state.rb,
lib/talon_one/models/library_attribute.rb,
lib/talon_one/models/new_feature_flags.rb,
lib/talon_one/models/webhook_log_entry.rb,
lib/talon_one/models/application_entity.rb,
lib/talon_one/models/campaign_analytics.rb,
lib/talon_one/models/coupon_constraints.rb,
lib/talon_one/models/customer_analytics.rb,
lib/talon_one/models/customer_inventory.rb,
lib/talon_one/models/error_effect_props.rb,
lib/talon_one/models/inline_response200.rb,
lib/talon_one/models/integration_entity.rb,
lib/talon_one/models/loyalty_membership.rb,
lib/talon_one/models/loyalty_sub_ledger.rb,
lib/talon_one/models/new_password_email.rb,
lib/talon_one/models/update_application.rb,
lib/talon_one/models/application_api_key.rb,
lib/talon_one/models/application_session.rb,
lib/talon_one/models/attributes_settings.rb,
lib/talon_one/models/coupon_reservations.rb,
lib/talon_one/models/customer_session_v2.rb,
lib/talon_one/models/inline_response2001.rb,
lib/talon_one/models/inline_response2002.rb,
lib/talon_one/models/inline_response2003.rb,
lib/talon_one/models/inline_response2004.rb,
lib/talon_one/models/inline_response2005.rb,
lib/talon_one/models/inline_response2006.rb,
lib/talon_one/models/inline_response2007.rb,
lib/talon_one/models/inline_response2008.rb,
lib/talon_one/models/inline_response2009.rb,
lib/talon_one/models/integration_request.rb,
lib/talon_one/models/new_account_sign_up.rb,
lib/talon_one/models/new_additional_cost.rb,
lib/talon_one/models/new_loyalty_program.rb,
lib/talon_one/models/new_saml_connection.rb,
lib/talon_one/models/saml_login_endpoint.rb,
lib/talon_one/models/update_coupon_batch.rb,
lib/talon_one/models/application_customer.rb,
lib/talon_one/models/attributes_mandatory.rb,
lib/talon_one/models/base_saml_connection.rb,
lib/talon_one/models/cart_item_adjustment.rb,
lib/talon_one/models/inline_response20010.rb,
lib/talon_one/models/inline_response20011.rb,
lib/talon_one/models/inline_response20012.rb,
lib/talon_one/models/inline_response20013.rb,
lib/talon_one/models/inline_response20014.rb,
lib/talon_one/models/inline_response20015.rb,
lib/talon_one/models/inline_response20016.rb,
lib/talon_one/models/inline_response20017.rb,
lib/talon_one/models/inline_response20018.rb,
lib/talon_one/models/inline_response20019.rb,
lib/talon_one/models/inline_response20020.rb,
lib/talon_one/models/inline_response20021.rb,
lib/talon_one/models/inline_response20022.rb,
lib/talon_one/models/inline_response20023.rb,
lib/talon_one/models/inline_response20024.rb,
lib/talon_one/models/inline_response20025.rb,
lib/talon_one/models/inline_response20026.rb,
lib/talon_one/models/inline_response20027.rb,
lib/talon_one/models/inline_response20028.rb,
lib/talon_one/models/inline_response20029.rb,
lib/talon_one/models/inline_response20030.rb,
lib/talon_one/models/integration_state_v2.rb,
lib/talon_one/models/loyalty_ledger_entry.rb,
lib/talon_one/models/new_customer_profile.rb,
lib/talon_one/models/new_customer_session.rb,
lib/talon_one/models/application_api_health.rb,
lib/talon_one/models/campaign_set_leaf_node.rb,
lib/talon_one/models/update_loyalty_program.rb,
lib/talon_one/models/account_additional_cost.rb,
lib/talon_one/models/change_profile_password.rb,
lib/talon_one/models/code_generator_settings.rb,
lib/talon_one/models/coupon_rejection_reason.rb,
lib/talon_one/models/customer_profile_update.rb,
lib/talon_one/models/loyalty_program_balance.rb,
lib/talon_one/models/loyalty_program_ledgers.rb,
lib/talon_one/models/new_application_api_key.rb,
lib/talon_one/models/new_customer_session_v2.rb,
lib/talon_one/models/campaign_set_branch_node.rb,
lib/talon_one/models/customer_activity_report.rb,
lib/talon_one/models/multi_application_entity.rb,
lib/talon_one/models/saml_connection_metadata.rb,
lib/talon_one/models/referral_rejection_reason.rb,
lib/talon_one/models/set_discount_effect_props.rb,
lib/talon_one/models/accept_coupon_effect_props.rb,
lib/talon_one/models/add_free_item_effect_props.rb,
lib/talon_one/models/application_session_entity.rb,
lib/talon_one/models/create_application_api_key.rb,
lib/talon_one/models/integration_profile_entity.rb,
lib/talon_one/models/reject_coupon_effect_props.rb,
lib/talon_one/models/application_customer_entity.rb,
lib/talon_one/models/application_customer_search.rb,
lib/talon_one/models/coupon_created_effect_props.rb,
lib/talon_one/models/accept_referral_effect_props.rb,
lib/talon_one/models/redeem_referral_effect_props.rb,
lib/talon_one/models/reject_referral_effect_props.rb,
lib/talon_one/models/rollback_coupon_effect_props.rb,
lib/talon_one/models/trigger_webhook_effect_props.rb,
lib/talon_one/models/webhook_activation_log_entry.rb,
lib/talon_one/models/customer_profile_search_query.rb,
lib/talon_one/models/referral_created_effect_props.rb,
lib/talon_one/models/update_attribute_effect_props.rb,
lib/talon_one/models/rollback_discount_effect_props.rb,
lib/talon_one/models/show_notification_effect_props.rb,
lib/talon_one/models/add_loyalty_points_effect_props.rb,
lib/talon_one/models/misc_update_user_latest_feature.rb,
lib/talon_one/models/show_bundle_metadata_effect_props.rb,
lib/talon_one/models/deduct_loyalty_points_effect_props.rb,
lib/talon_one/models/set_discount_per_item_effect_props.rb

Overview

#Talon.One API

#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at ‘mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation–v1-customer_profiles–integrationId–put

The version of the OpenAPI document: 1.0.0

Generated by: openapi-generator.tech OpenAPI Generator version: 4.2.3

Defined Under Namespace

Classes: APIError, AcceptCouponEffectProps, AcceptReferralEffectProps, AccessLogEntry, Account, AccountAdditionalCost, AccountAnalytics, AccountEntity, AccountLimits, AddFreeItemEffectProps, AddLoyaltyPointsEffectProps, AdditionalCost, ApiClient, ApiError, Application, ApplicationAPIKey, ApplicationApiHealth, ApplicationCustomer, ApplicationCustomerEntity, ApplicationCustomerSearch, ApplicationEntity, ApplicationEvent, ApplicationSession, ApplicationSessionEntity, Attribute, AttributesMandatory, AttributesSettings, BaseSamlConnection, Binding, Campaign, CampaignAnalytics, CampaignCopy, CampaignEntity, CampaignSearch, CampaignSet, CampaignSetBranchNode, CampaignSetLeafNode, CampaignSetNode, CartItem, CartItemAdjustment, Change, ChangeProfilePassword, CodeGeneratorSettings, Configuration, Coupon, CouponConstraints, CouponCreatedEffectProps, CouponRejectionReason, CouponReservations, CouponSearch, CouponValue, CreateApplicationAPIKey, CustomerActivityReport, CustomerAnalytics, CustomerInventory, CustomerProfile, CustomerProfileSearchQuery, CustomerProfileUpdate, CustomerSession, CustomerSessionV2, DeductLoyaltyPointsEffectProps, Effect, EffectEntity, EmailEntity, Entity, Environment, ErrorEffectProps, ErrorResponse, ErrorSource, Event, EventType, Export, FeatureFlag, FeatureFlags, FeaturesFeed, FuncArgDef, FunctionDef, Import, ImportCoupons, InlineResponse200, InlineResponse2001, InlineResponse20010, InlineResponse20011, InlineResponse20012, InlineResponse20013, InlineResponse20014, InlineResponse20015, InlineResponse20016, InlineResponse20017, InlineResponse20018, InlineResponse20019, InlineResponse2002, InlineResponse20020, InlineResponse20021, InlineResponse20022, InlineResponse20023, InlineResponse20024, InlineResponse20025, InlineResponse20026, InlineResponse20027, InlineResponse20028, InlineResponse20029, InlineResponse2003, InlineResponse20030, InlineResponse2004, InlineResponse2005, InlineResponse2006, InlineResponse2007, InlineResponse2008, InlineResponse2009, IntegrationApi, IntegrationEntity, IntegrationEvent, IntegrationProfileEntity, IntegrationRequest, IntegrationState, IntegrationStateV2, LedgerEntry, LibraryAttribute, LimitConfig, LoginParams, Loyalty, LoyaltyLedger, LoyaltyLedgerEntry, LoyaltyMembership, LoyaltyPoints, LoyaltyProgram, LoyaltyProgramBalance, LoyaltyProgramLedgers, LoyaltySubLedger, ManagementApi, ManagerConfig, Meta, MiscUpdateUserLatestFeature, MultiApplicationEntity, MutableEntity, NewAccount, NewAccountSignUp, NewAdditionalCost, NewApplication, NewApplicationAPIKey, NewAttribute, NewCampaign, NewCampaignSet, NewCoupons, NewCustomerProfile, NewCustomerSession, NewCustomerSessionV2, NewEvent, NewEventType, NewFeatureFlags, NewImport, NewInvitation, NewInviteEmail, NewLoyaltyProgram, NewPassword, NewPasswordEmail, NewReferral, NewRole, NewRuleset, NewSamlConnection, NewTemplateDef, NewUser, NewWebhook, Notification, RedeemReferralEffectProps, Referral, ReferralCreatedEffectProps, ReferralRejectionReason, RejectCouponEffectProps, RejectReferralEffectProps, Role, RoleAssign, RoleMembership, RollbackCouponEffectProps, RollbackDiscountEffectProps, Rule, Ruleset, SamlConnection, SamlConnectionMetadata, SamlLoginEndpoint, Session, SetDiscountEffectProps, SetDiscountPerItemEffectProps, ShowBundleMetadataEffectProps, ShowNotificationEffectProps, SlotDef, TemplateArgDef, TemplateDef, TriggerWebhookEffectProps, UpdateAccount, UpdateApplication, UpdateAttributeEffectProps, UpdateCampaign, UpdateCoupon, UpdateCouponBatch, UpdateLoyaltyProgram, UpdateRole, UpdateUser, User, UserEntity, Webhook, WebhookActivationLogEntry, WebhookLogEntry

Constant Summary collapse

VERSION = 
'2.1.1'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

TalonOne.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



232
233
234
235
236
237
238
 
# File 'lib/talon_one.rb', line 232

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end