Class: SquareConnect::OrderServiceCharge

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

Overview

Represents a service charge applied to an order.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderServiceCharge

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/square_connect/models/order_service_charge.rb', line 85

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#amount_money ⇒ Object

The amount of a non-percentage based service charge. Exactly one of ‘percentage` or `amount_money` should be set.



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

def amount_money
  @amount_money
end

#applied_money ⇒ Object

The amount of money applied to the order by the service charge, as calculated by the server. For fixed-amount service charges, ‘applied_money` is equal to `amount_money`. For percentage-based service charges, `applied_money` is the money calculated using the percentage. The `applied_money` field will include any inclusive tax amounts as well. This field is read-only.



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

def applied_money
  @applied_money
end

#calculation_phase ⇒ Object

The calculation phase at which to apply the service charge. See [OrderServiceChargeCalculationPhase](#type-orderservicechargecalculationphase) for possible values



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

def calculation_phase
  @calculation_phase
end

#catalog_object_id ⇒ Object

The catalog object ID referencing the service charge [CatalogObject](#type-catalogobject).



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

def catalog_object_id
  @catalog_object_id
end

#name ⇒ Object

The name of the service charge.



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

def name
  @name
end

#percentage ⇒ Object

The service charge percentage, as a string representation of a decimal number. For example, ‘7.25` indicates 7.25% Exactly one of `percentage` or `amount_money` should be set.



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

def percentage
  @percentage
end

#taxable ⇒ Object

Indicates whether the service charge can be taxed. If set to ‘true`, any order-level taxes will automatically apply to this service charge. Note that service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.



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

def taxable
  @taxable
end

#taxes ⇒ Object

Taxes applied to the service charge. By default, order-level taxes apply to service charges calculated in the ‘SUBTOTAL_PHASE` if `taxable` is set to `true`.



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

def taxes
  @taxes
end

#total_money ⇒ Object

The total amount of money to collect for the service charge. Note that ‘total_money` does not equal `applied_money` plus `total_tax_money` if an inclusive tax is applied to the service charge since the inclusive tax amount will be included in both `applied_money` and `total_tax_money`. This field is read-only.



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

def total_money
  @total_money
end

#total_tax_money ⇒ Object

The total amount of tax money to collect for the service charge. This field is read-only.



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

def total_tax_money
  @total_tax_money
end

#uid ⇒ Object

Unique ID that identifies the service charge only within this order. This field is read-only.



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

def uid
  @uid
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/square_connect/models/order_service_charge.rb', line 50

def self.attribute_map
  {
    :'uid' => :'uid',
    :'name' => :'name',
    :'catalog_object_id' => :'catalog_object_id',
    :'percentage' => :'percentage',
    :'amount_money' => :'amount_money',
    :'applied_money' => :'applied_money',
    :'total_money' => :'total_money',
    :'total_tax_money' => :'total_tax_money',
    :'calculation_phase' => :'calculation_phase',
    :'taxable' => :'taxable',
    :'taxes' => :'taxes'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/square_connect/models/order_service_charge.rb', line 67

def self.swagger_types
  {
    :'uid' => :'String',
    :'name' => :'String',
    :'catalog_object_id' => :'String',
    :'percentage' => :'String',
    :'amount_money' => :'Money',
    :'applied_money' => :'Money',
    :'total_money' => :'Money',
    :'total_tax_money' => :'Money',
    :'calculation_phase' => :'String',
    :'taxable' => :'BOOLEAN',
    :'taxes' => :'Array<OrderLineItemTax>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.uid &&
      name == o.name &&
      catalog_object_id == o.catalog_object_id &&
      percentage == o.percentage &&
      amount_money == o.amount_money &&
      applied_money == o.applied_money &&
      total_money == o.total_money &&
      total_tax_money == o.total_tax_money &&
      calculation_phase == o.calculation_phase &&
      taxable == o.taxable &&
      taxes == o.taxes
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/square_connect/models/order_service_charge.rb', line 270

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/square_connect/models/order_service_charge.rb', line 336

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/square_connect/models/order_service_charge.rb', line 249

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


236
237
238
 
# File 'lib/square_connect/models/order_service_charge.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



242
243
244
 
# File 'lib/square_connect/models/order_service_charge.rb', line 242

def hash
  [uid, name, catalog_object_id, percentage, amount_money, applied_money, total_money, total_tax_money, calculation_phase, taxable, taxes].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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/square_connect/models/order_service_charge.rb', line 141

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 !@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

  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 !@percentage.nil? && @percentage.to_s.length > 10
    invalid_properties.push("invalid value for 'percentage', the character length must be smaller than or equal to 10.")
  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



316
317
318
 
# File 'lib/square_connect/models/order_service_charge.rb', line 316

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



322
323
324
325
326
327
328
329
330
 
# File 'lib/square_connect/models/order_service_charge.rb', line 322

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



310
311
312
 
# File 'lib/square_connect/models/order_service_charge.rb', line 310

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



164
165
166
167
168
169
170
 
# File 'lib/square_connect/models/order_service_charge.rb', line 164

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