Class: TalonOne::EffectEntity
- Inherits:
-
Object
- Object
- TalonOne::EffectEntity
- Defined in:
- lib/talon_one/models/effect_entity.rb
Overview
Definition of all properties that are present on all effects, independent of their type.
Instance Attribute Summary collapse
-
#campaign_id ⇒ Object
The ID of the campaign that triggered this effect.
-
#effect_type ⇒ Object
The type of effect that was triggered.
-
#rule_index ⇒ Object
The position of the rule that triggered this effect within the ruleset.
-
#rule_name ⇒ Object
The name of the rule that triggered this effect.
-
#ruleset_id ⇒ Object
The ID of the ruleset that was active in the campaign when this effect was triggered.
-
#triggered_by_coupon ⇒ Object
The ID of the coupon that was being evaluated when this effect was triggered.
-
#triggered_for_catalog_item ⇒ Object
The ID of the catalog item that was being evaluated when this effect was triggered.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ EffectEntity
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ EffectEntity
Initializes the object
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/talon_one/models/effect_entity.rb', line 73 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::EffectEntity` 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::EffectEntity`. 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 end |
Instance Attribute Details
#campaign_id ⇒ Object
The ID of the campaign that triggered this effect.
19 20 21 |
# File 'lib/talon_one/models/effect_entity.rb', line 19 def campaign_id @campaign_id end |
#effect_type ⇒ Object
The type of effect that was triggered. See [API effects](docs.talon.one/docs/dev/integration-api/api-effects).
31 32 33 |
# File 'lib/talon_one/models/effect_entity.rb', line 31 def effect_type @effect_type end |
#rule_index ⇒ Object
The position of the rule that triggered this effect within the ruleset.
25 26 27 |
# File 'lib/talon_one/models/effect_entity.rb', line 25 def rule_index @rule_index end |
#rule_name ⇒ Object
The name of the rule that triggered this effect.
28 29 30 |
# File 'lib/talon_one/models/effect_entity.rb', line 28 def rule_name @rule_name end |
#ruleset_id ⇒ Object
The ID of the ruleset that was active in the campaign when this effect was triggered.
22 23 24 |
# File 'lib/talon_one/models/effect_entity.rb', line 22 def ruleset_id @ruleset_id end |
#triggered_by_coupon ⇒ Object
The ID of the coupon that was being evaluated when this effect was triggered.
34 35 36 |
# File 'lib/talon_one/models/effect_entity.rb', line 34 def triggered_by_coupon @triggered_by_coupon end |
#triggered_for_catalog_item ⇒ Object
The ID of the catalog item that was being evaluated when this effect was triggered.
37 38 39 |
# File 'lib/talon_one/models/effect_entity.rb', line 37 def triggered_for_catalog_item @triggered_for_catalog_item end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/talon_one/models/effect_entity.rb', line 40 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' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
182 183 184 |
# File 'lib/talon_one/models/effect_entity.rb', line 182 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
66 67 68 69 |
# File 'lib/talon_one/models/effect_entity.rb', line 66 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/talon_one/models/effect_entity.rb', line 53 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' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/talon_one/models/effect_entity.rb', line 155 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 end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/talon_one/models/effect_entity.rb', line 210 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<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/talon_one/models/effect_entity.rb', line 279 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/talon_one/models/effect_entity.rb', line 189 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 |
#eql?(o) ⇒ Boolean
169 170 171 |
# File 'lib/talon_one/models/effect_entity.rb', line 169 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
175 176 177 |
# File 'lib/talon_one/models/effect_entity.rb', line 175 def hash [campaign_id, ruleset_id, rule_index, rule_name, effect_type, triggered_by_coupon, triggered_for_catalog_item].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/talon_one/models/effect_entity.rb', line 117 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 invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
255 256 257 |
# File 'lib/talon_one/models/effect_entity.rb', line 255 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/talon_one/models/effect_entity.rb', line 261 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 |
#to_s ⇒ String
Returns the string representation of the object
249 250 251 |
# File 'lib/talon_one/models/effect_entity.rb', line 249 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
144 145 146 147 148 149 150 151 |
# File 'lib/talon_one/models/effect_entity.rb', line 144 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? true end |