Class: SquareConnect::V1PaymentItemization

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

Overview

Payment include an` itemizations` field that lists the items purchased, along with associated fees, modifiers, and discounts. Each itemization has an ‘itemization_type` field that indicates which of the following the itemization represents: <ul> <li>An item variation from the merchant’s item library</li> <li>A custom monetary amount</li> <li> An action performed on a Square gift card, such as activating or reloading it. </li> </ul> Note*: itemization information included in a ‘Payment` object reflects details collected **at the time of the payment**. Details such as the name or price of items might have changed since the payment was processed.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1PaymentItemization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 100

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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'taxes')
    if (value = attributes[:'taxes']).is_a?(Array)
      self.taxes = value
    end
  end

  if attributes.has_key?(:'discounts')
    if (value = attributes[:'discounts']).is_a?(Array)
      self.discounts = value
    end
  end

  if attributes.has_key?(:'modifiers')
    if (value = attributes[:'modifiers']).is_a?(Array)
      self.modifiers = value
    end
  end

end

Instance Attribute Details

#discount_money ⇒ Object

The total of all discounts applied to the itemization. This value is always negative or zero.



43
44
45
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 43

def discount_money
  @discount_money
end

#discounts ⇒ Object

All discounts applied to this itemization.



52
53
54
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 52

def discounts
  @discounts
end

#gross_sales_money ⇒ Object

The total cost of the itemization and its modifiers, not including taxes or discounts.



40
41
42
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 40

def gross_sales_money
  @gross_sales_money
end

#item_detail ⇒ Object

Details of the item, including its unique identifier and the identifier of the item variation purchased.



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

def item_detail
  @item_detail
end

#item_variation_name ⇒ Object

The name of the item variation purchased, if any.



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

def item_variation_name
  @item_variation_name
end

#itemization_type ⇒ Object

The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT See [V1PaymentItemizationItemizationType](#type-v1paymentitemizationitemizationtype) for possible values



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

def itemization_type
  @itemization_type
end

#modifiers ⇒ Object

All modifier options applied to this itemization.



55
56
57
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 55

def modifiers
  @modifiers
end

#name ⇒ Object

The item’s name.



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

def name
  @name
end

#net_sales_money ⇒ Object

The sum of gross_sales_money and discount_money.



46
47
48
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 46

def net_sales_money
  @net_sales_money
end

#notes ⇒ Object

Notes entered by the merchant about the item at the time of payment, if any.



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

def notes
  @notes
end

#quantity ⇒ Object

The quantity of the item purchased. This can be a decimal value.



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

def quantity
  @quantity
end

#single_quantity_money ⇒ Object

The cost of a single unit of this item.



37
38
39
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 37

def single_quantity_money
  @single_quantity_money
end

#taxes ⇒ Object

All taxes applied to this itemization.



49
50
51
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 49

def taxes
  @taxes
end

#total_money ⇒ Object

The total cost of the item, including all taxes and discounts.



34
35
36
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 34

def total_money
  @total_money
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 59

def self.attribute_map
  {
    :'name' => :'name',
    :'quantity' => :'quantity',
    :'itemization_type' => :'itemization_type',
    :'item_detail' => :'item_detail',
    :'notes' => :'notes',
    :'item_variation_name' => :'item_variation_name',
    :'total_money' => :'total_money',
    :'single_quantity_money' => :'single_quantity_money',
    :'gross_sales_money' => :'gross_sales_money',
    :'discount_money' => :'discount_money',
    :'net_sales_money' => :'net_sales_money',
    :'taxes' => :'taxes',
    :'discounts' => :'discounts',
    :'modifiers' => :'modifiers'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 79

def self.swagger_types
  {
    :'name' => :'String',
    :'quantity' => :'Float',
    :'itemization_type' => :'String',
    :'item_detail' => :'V1PaymentItemDetail',
    :'notes' => :'String',
    :'item_variation_name' => :'String',
    :'total_money' => :'V1Money',
    :'single_quantity_money' => :'V1Money',
    :'gross_sales_money' => :'V1Money',
    :'discount_money' => :'V1Money',
    :'net_sales_money' => :'V1Money',
    :'taxes' => :'Array<V1PaymentTax>',
    :'discounts' => :'Array<V1PaymentDiscount>',
    :'modifiers' => :'Array<V1PaymentModifier>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      quantity == o.quantity &&
      itemization_type == o.itemization_type &&
      item_detail == o.item_detail &&
      notes == o.notes &&
      item_variation_name == o.item_variation_name &&
      total_money == o.total_money &&
      single_quantity_money == o.single_quantity_money &&
      gross_sales_money == o.gross_sales_money &&
      discount_money == o.discount_money &&
      net_sales_money == o.net_sales_money &&
      taxes == o.taxes &&
      discounts == o.discounts &&
      modifiers == o.modifiers
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



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
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 240

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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 306

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 219

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


206
207
208
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



212
213
214
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 212

def hash
  [name, quantity, itemization_type, item_detail, notes, item_variation_name, total_money, single_quantity_money, gross_sales_money, discount_money, net_sales_money, taxes, discounts, modifiers].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



172
173
174
175
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 172

def list_invalid_properties
  invalid_properties = Array.new
  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



286
287
288
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 286

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



292
293
294
295
296
297
298
299
300
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 292

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



280
281
282
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 280

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



179
180
181
 
# File 'lib/square_connect/models/v1_payment_itemization.rb', line 179

def valid?
  return true
end