Class: TalonOne::RollbackDiscountEffectProps

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

Overview

The properties specific to the "rollbackDiscount" effect. This gets triggered whenever previously closed session is now cancelled or partially returned and a setDiscount effect was cancelled on our internal discount limit counters.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RollbackDiscountEffectProps

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/rollback_discount_effect_props.rb', line 73

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

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

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

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

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

Instance Attribute Details

#additional_cost ⇒ Object

The name of the additional cost that was rolled back.



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

def additional_cost
  @additional_cost
end

#additional_cost_id ⇒ Object

The ID of the additional cost that was rolled back.



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

def additional_cost_id
  @additional_cost_id
end

#cart_item_position ⇒ Object

The index of the item in the cart items for which the discount was rolled back.



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

def cart_item_position
  @cart_item_position
end

#cart_item_sub_position ⇒ Object

For cart items with ‘quantity` > 1, the subposition returns the index of the item unit in its line item.



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

def cart_item_sub_position
  @cart_item_sub_position
end

#name ⇒ Object

The name of the "setDiscount" effect that was rolled back.



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

def name
  @name
end

#scope ⇒ Object

The scope of the rolled back discount - For a discount per session, it can be one of ‘cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal`



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

def scope
  @scope
end

#value ⇒ Object

The value of the discount that was rolled back.



22
23
24
 
# File 'lib/talon_one/models/rollback_discount_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.



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 40

def self.attribute_map
  {
    :'name' => :'name',
    :'value' => :'value',
    :'cart_item_position' => :'cartItemPosition',
    :'cart_item_sub_position' => :'cartItemSubPosition',
    :'additional_cost_id' => :'additionalCostId',
    :'additional_cost' => :'additionalCost',
    :'scope' => :'scope'
  }
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



167
168
169
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 167

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/rollback_discount_effect_props.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/rollback_discount_effect_props.rb', line 53

def self.openapi_types
  {
    :'name' => :'String',
    :'value' => :'Float',
    :'cart_item_position' => :'Float',
    :'cart_item_sub_position' => :'Float',
    :'additional_cost_id' => :'Integer',
    :'additional_cost' => :'String',
    :'scope' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      value == o.value &&
      cart_item_position == o.cart_item_position &&
      cart_item_sub_position == o.cart_item_sub_position &&
      additional_cost_id == o.additional_cost_id &&
      additional_cost == o.additional_cost &&
      scope == o.scope
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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 195

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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 264

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 174

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


154
155
156
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 154

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



160
161
162
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 160

def hash
  [name, value, cart_item_position, cart_item_sub_position, additional_cost_id, additional_cost, scope].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



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 117

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

  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



240
241
242
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 240

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 246

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



234
235
236
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 234

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



132
133
134
135
136
 
# File 'lib/talon_one/models/rollback_discount_effect_props.rb', line 132

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