Class: SquareConnect::OrderReturnLineItemModifier

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/order_return_line_item_modifier.rb

Overview

A line item modifier being returned.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderReturnLineItemModifier

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 60

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'uid')
    self.uid = attributes[:'uid']
  end

  if attributes.has_key?(:'source_modifier_uid')
    self.source_modifier_uid = attributes[:'source_modifier_uid']
  end

  if attributes.has_key?(:'catalog_object_id')
    self.catalog_object_id = attributes[:'catalog_object_id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'base_price_money')
    self.base_price_money = attributes[:'base_price_money']
  end

  if attributes.has_key?(:'total_price_money')
    self.total_price_money = attributes[:'total_price_money']
  end

end

Instance Attribute Details

#base_price_money ⇒ Object

The base price for the modifier. ‘base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price.



28
29
30
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 28

def base_price_money
  @base_price_money
end

#catalog_object_id ⇒ Object

The catalog object id referencing [CatalogModifier](#type-catalogmodifier).



22
23
24
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 22

def catalog_object_id
  @catalog_object_id
end

#name ⇒ Object

The name of the item modifier.



25
26
27
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 25

def name
  @name
end

#source_modifier_uid ⇒ Object

‘uid` of the Modifier from the LineItem from the Order which contains the original sale of this line item modifier.



19
20
21
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 19

def source_modifier_uid
  @source_modifier_uid
end

#total_price_money ⇒ Object

The total price of the item modifier for its line item. This is the modifier’s ‘base_price_money` multiplied by the line item’s quantity.



31
32
33
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 31

def total_price_money
  @total_price_money
end

#uid ⇒ Object

Unique ID that identifies the return modifier only within this order. This field is read-only.



16
17
18
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 16

def uid
  @uid
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 35

def self.attribute_map
  {
    :'uid' => :'uid',
    :'source_modifier_uid' => :'source_modifier_uid',
    :'catalog_object_id' => :'catalog_object_id',
    :'name' => :'name',
    :'base_price_money' => :'base_price_money',
    :'total_price_money' => :'total_price_money'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 47

def self.swagger_types
  {
    :'uid' => :'String',
    :'source_modifier_uid' => :'String',
    :'catalog_object_id' => :'String',
    :'name' => :'String',
    :'base_price_money' => :'Money',
    :'total_price_money' => :'Money'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 171

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.uid &&
      source_modifier_uid == o.source_modifier_uid &&
      catalog_object_id == o.catalog_object_id &&
      name == o.name &&
      base_price_money == o.base_price_money &&
      total_price_money == o.total_price_money
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



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
246
247
248
249
250
251
252
253
254
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 218

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
    temp_model = SquareConnect.const_get(type).new
    temp_model.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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 284

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 197

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


184
185
186
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 190

def hash
  [uid, source_modifier_uid, catalog_object_id, name, base_price_money, total_price_money].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 94

def list_invalid_properties
  invalid_properties = Array.new
  if !@uid.nil? && @uid.to_s.length > 60
    invalid_properties.push("invalid value for 'uid', the character length must be smaller than or equal to 60.")
  end

  if !@source_modifier_uid.nil? && @source_modifier_uid.to_s.length > 60
    invalid_properties.push("invalid value for 'source_modifier_uid', the character length must be smaller than or equal to 60.")
  end

  if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
    invalid_properties.push("invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192.")
  end

  if !@name.nil? && @name.to_s.length > 255
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 255.")
  end

  return 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



264
265
266
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 264

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



270
271
272
273
274
275
276
277
278
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 270

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



258
259
260
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 258

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



117
118
119
120
121
122
123
 
# File 'lib/square_connect/models/order_return_line_item_modifier.rb', line 117

def valid?
  return false if !@uid.nil? && @uid.to_s.length > 60
  return false if !@source_modifier_uid.nil? && @source_modifier_uid.to_s.length > 60
  return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
  return false if !@name.nil? && @name.to_s.length > 255
  return true
end