=begin #Talon.One API #Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` The version of the OpenAPI document: Generated by: https://openapi-generator.tech OpenAPI Generator version: 4.3.1 =end require 'date' module TalonOne # class Effect # The ID of the campaign that triggered this effect. attr_accessor :campaign_id # The ID of the ruleset that was active in the campaign when this effect was triggered. attr_accessor :ruleset_id # The position of the rule that triggered this effect within the ruleset. attr_accessor :rule_index # The name of the rule that triggered this effect. attr_accessor :rule_name # The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). attr_accessor :effect_type # The ID of the coupon that was being evaluated when this effect was triggered. attr_accessor :triggered_by_coupon # The ID of the catalog item that was being evaluated when this effect was triggered. attr_accessor :triggered_for_catalog_item # The index of the condition that was triggered. attr_accessor :condition_index # The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). attr_accessor :evaluation_group_id # The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). attr_accessor :evaluation_group_mode # The revision ID of the campaign that was used when triggering the effect. attr_accessor :campaign_revision_id # The revision version ID of the campaign that was used when triggering the effect. attr_accessor :campaign_revision_version_id # The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). attr_accessor :props # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'campaign_id' => :'campaignId', :'ruleset_id' => :'rulesetId', :'rule_index' => :'ruleIndex', :'rule_name' => :'ruleName', :'effect_type' => :'effectType', :'triggered_by_coupon' => :'triggeredByCoupon', :'triggered_for_catalog_item' => :'triggeredForCatalogItem', :'condition_index' => :'conditionIndex', :'evaluation_group_id' => :'evaluationGroupID', :'evaluation_group_mode' => :'evaluationGroupMode', :'campaign_revision_id' => :'campaignRevisionId', :'campaign_revision_version_id' => :'campaignRevisionVersionId', :'props' => :'props' } end # Attribute type mapping. def self.openapi_types { :'campaign_id' => :'Integer', :'ruleset_id' => :'Integer', :'rule_index' => :'Integer', :'rule_name' => :'String', :'effect_type' => :'String', :'triggered_by_coupon' => :'Integer', :'triggered_for_catalog_item' => :'Integer', :'condition_index' => :'Integer', :'evaluation_group_id' => :'Integer', :'evaluation_group_mode' => :'String', :'campaign_revision_id' => :'Integer', :'campaign_revision_version_id' => :'Integer', :'props' => :'Object' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ ]) end # Initializes the object # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::Effect` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::Effect`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'campaign_id') self.campaign_id = attributes[:'campaign_id'] end if attributes.key?(:'ruleset_id') self.ruleset_id = attributes[:'ruleset_id'] end if attributes.key?(:'rule_index') self.rule_index = attributes[:'rule_index'] end if attributes.key?(:'rule_name') self.rule_name = attributes[:'rule_name'] end if attributes.key?(:'effect_type') self.effect_type = attributes[:'effect_type'] end if attributes.key?(:'triggered_by_coupon') self.triggered_by_coupon = attributes[:'triggered_by_coupon'] end if attributes.key?(:'triggered_for_catalog_item') self.triggered_for_catalog_item = attributes[:'triggered_for_catalog_item'] end if attributes.key?(:'condition_index') self.condition_index = attributes[:'condition_index'] end if attributes.key?(:'evaluation_group_id') self.evaluation_group_id = attributes[:'evaluation_group_id'] end if attributes.key?(:'evaluation_group_mode') self.evaluation_group_mode = attributes[:'evaluation_group_mode'] end if attributes.key?(:'campaign_revision_id') self.campaign_revision_id = attributes[:'campaign_revision_id'] end if attributes.key?(:'campaign_revision_version_id') self.campaign_revision_version_id = attributes[:'campaign_revision_version_id'] end if attributes.key?(:'props') self.props = attributes[:'props'] end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new if @campaign_id.nil? invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.') end if @ruleset_id.nil? invalid_properties.push('invalid value for "ruleset_id", ruleset_id cannot be nil.') end if @rule_index.nil? invalid_properties.push('invalid value for "rule_index", rule_index cannot be nil.') end if @rule_name.nil? invalid_properties.push('invalid value for "rule_name", rule_name cannot be nil.') end if @effect_type.nil? invalid_properties.push('invalid value for "effect_type", effect_type cannot be nil.') end if @props.nil? invalid_properties.push('invalid value for "props", props cannot be nil.') end invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? return false if @campaign_id.nil? return false if @ruleset_id.nil? return false if @rule_index.nil? return false if @rule_name.nil? return false if @effect_type.nil? return false if @props.nil? true end # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(o) return true if self.equal?(o) self.class == o.class && campaign_id == o.campaign_id && ruleset_id == o.ruleset_id && rule_index == o.rule_index && rule_name == o.rule_name && effect_type == o.effect_type && triggered_by_coupon == o.triggered_by_coupon && triggered_for_catalog_item == o.triggered_for_catalog_item && condition_index == o.condition_index && evaluation_group_id == o.evaluation_group_id && evaluation_group_mode == o.evaluation_group_mode && campaign_revision_id == o.campaign_revision_id && campaign_revision_version_id == o.campaign_revision_version_id && props == o.props end # @see the `==` method # @param [Object] Object to be compared def eql?(o) self == o end # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash [campaign_id, ruleset_id, rule_index, rule_name, effect_type, triggered_by_coupon, triggered_for_catalog_item, condition_index, evaluation_group_id, evaluation_group_mode, campaign_revision_id, campaign_revision_version_id, props].hash end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself def self.build_from_hash(attributes) new.build_from_hash(attributes) end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end # Deserializes the data based on type # @param string type Data type # @param string value Value to be deserialized # @return [Object] Deserialized data def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model TalonOne.const_get(type).build_from_hash(value) end end # Returns the string representation of the object # @return [String] String presentation of the object def to_s to_hash.to_s end # to_body is an alias to to_hash (backward compatibility) # @return [Hash] Returns the object in the form of hash def to_body to_hash end # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end # Outputs non-array value in the form of hash # For object, use to_hash. Otherwise, just return the value # @param [Object] value Any valid value # @return [Hash] Returns the value in the form of hash def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end end end