Class: TalonOne::SetDiscountPerItemEffectProps

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/set_discount_per_item_effect_props.rb

Overview

The properties specific to the ‘setDiscountPerItem` effect, triggered whenever a validated rule contained a "set per item discount" effect. This is a discount that will be applied either on a specific item, on a specific item + additional cost or on all additional costs per item. This depends on the chosen scope.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SetDiscountPerItemEffectProps

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
114
115
116
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/set_discount_per_item_effect_props.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::SetDiscountPerItemEffectProps` 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::SetDiscountPerItemEffectProps`. 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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'value')
    self.value = attributes[:'value']
  end

  if attributes.key?(:'position')
    self.position = attributes[:'position']
  end

  if attributes.key?(:'sub_position')
    self.sub_position = attributes[:'sub_position']
  end

  if attributes.key?(:'desired_value')
    self.desired_value = attributes[:'desired_value']
  end

  if attributes.key?(:'scope')
    self.scope = attributes[:'scope']
  end

  if attributes.key?(:'total_discount')
    self.total_discount = attributes[:'total_discount']
  end

  if attributes.key?(:'desired_total_discount')
    self.desired_total_discount = attributes[:'desired_total_discount']
  end

  if attributes.key?(:'bundle_index')
    self.bundle_index = attributes[:'bundle_index']
  end

  if attributes.key?(:'bundle_name')
    self.bundle_name = attributes[:'bundle_name']
  end
end

Instance Attribute Details

#bundle_index ⇒ Object

The position of the bundle in a list of item bundles created from the same bundle definition.



43
44
45
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 43

def bundle_index
  @bundle_index
end

#bundle_name ⇒ Object

The name of the bundle definition.



46
47
48
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 46

def bundle_name
  @bundle_name
end

#desired_total_discount ⇒ Object

The original total discount to give if this effect is a result of a prorated discount.



40
41
42
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 40

def desired_total_discount
  @desired_total_discount
end

#desired_value ⇒ Object

The original value of the discount.



31
32
33
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 31

def desired_value
  @desired_value
end

#name ⇒ Object

The name of the discount. Contains a hashtag character indicating the index of the position of the item the discount applies to. It is identical to the value of the ‘position` property.



19
20
21
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 19

def name
  @name
end

#position ⇒ Object

The index of the item in the cart items list on which this discount should be applied.



25
26
27
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 25

def position
  @position
end

#scope ⇒ Object

The scope of the discount: - ‘additionalCosts`: The discount applies to all the additional costs of the item. - `itemTotal`: The discount applies to the price of the item + the additional costs of the item. - `price`: The discount applies to the price of the item.



34
35
36
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 34

def scope
  @scope
end

#sub_position ⇒ Object

Only used when [cart item flattening](docs.talon.one/docs/product/campaigns/campaign-evaluation#flattening) is enabled. Indicates which item the discount applies to for cart items with ‘quantity` > 1.



28
29
30
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 28

def sub_position
  @sub_position
end

#total_discount ⇒ Object

The total discount given if this effect is a result of a prorated discount.



37
38
39
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 37

def total_discount
  @total_discount
end

#value ⇒ Object

The total monetary value of the discount.



22
23
24
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 22

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 49

def self.attribute_map
  {
    :'name' => :'name',
    :'value' => :'value',
    :'position' => :'position',
    :'sub_position' => :'subPosition',
    :'desired_value' => :'desiredValue',
    :'scope' => :'scope',
    :'total_discount' => :'totalDiscount',
    :'desired_total_discount' => :'desiredTotalDiscount',
    :'bundle_index' => :'bundleIndex',
    :'bundle_name' => :'bundleName'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



202
203
204
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 202

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 81

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 65

def self.openapi_types
  {
    :'name' => :'String',
    :'value' => :'Float',
    :'position' => :'Float',
    :'sub_position' => :'Float',
    :'desired_value' => :'Float',
    :'scope' => :'String',
    :'total_discount' => :'Float',
    :'desired_total_discount' => :'Float',
    :'bundle_index' => :'Integer',
    :'bundle_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      value == o.value &&
      position == o.position &&
      sub_position == o.sub_position &&
      desired_value == o.desired_value &&
      scope == o.scope &&
      total_discount == o.total_discount &&
      desired_total_discount == o.desired_total_discount &&
      bundle_index == o.bundle_index &&
      bundle_name == o.bundle_name
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 230

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 299

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 209

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


189
190
191
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 195

def hash
  [name, value, position, sub_position, desired_value, scope, total_discount, desired_total_discount, bundle_index, bundle_name].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 144

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @value.nil?
    invalid_properties.push('invalid value for "value", value cannot be nil.')
  end

  if @position.nil?
    invalid_properties.push('invalid value for "position", position cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



275
276
277
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 275

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 281

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

Returns:

  • (String) —

    String presentation of the object



269
270
271
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 269

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



163
164
165
166
167
168
 
# File 'lib/talon_one/models/set_discount_per_item_effect_props.rb', line 163

def valid?
  return false if @name.nil?
  return false if @value.nil?
  return false if @position.nil?
  true
end