Class: SquareConnect::V1Fee

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

Overview

V1Fee

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1Fee

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/square_connect/models/v1_fee.rb', line 101

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#adjustment_type ⇒ Object

The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values



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

def adjustment_type
  @adjustment_type
end

#applies_to_custom_amounts ⇒ Object

If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item.



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

def applies_to_custom_amounts
  @applies_to_custom_amounts
end

#calculation_phase ⇒ Object

Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values



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

def calculation_phase
  @calculation_phase
end

#enabled ⇒ Object

If true, the fee is applied to all appropriate items. If false, the fee is not applied at all.



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

def enabled
  @enabled
end

#id ⇒ Object

The fee’s unique ID.



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

def id
  @id
end

#inclusion_type ⇒ Object

Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values



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

def inclusion_type
  @inclusion_type
end

#name ⇒ Object

The fee’s name.



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

def name
  @name
end

#rate ⇒ Object

The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%.



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

def rate
  @rate
end

#type ⇒ Object

In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values



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

def type
  @type
end

#v2_id ⇒ Object

The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.



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

def v2_id
  @v2_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'rate' => :'rate',
    :'calculation_phase' => :'calculation_phase',
    :'adjustment_type' => :'adjustment_type',
    :'applies_to_custom_amounts' => :'applies_to_custom_amounts',
    :'enabled' => :'enabled',
    :'inclusion_type' => :'inclusion_type',
    :'type' => :'type',
    :'v2_id' => :'v2_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/square_connect/models/v1_fee.rb', line 84

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'rate' => :'String',
    :'calculation_phase' => :'String',
    :'adjustment_type' => :'String',
    :'applies_to_custom_amounts' => :'BOOLEAN',
    :'enabled' => :'BOOLEAN',
    :'inclusion_type' => :'String',
    :'type' => :'String',
    :'v2_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/square_connect/models/v1_fee.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      rate == o.rate &&
      calculation_phase == o.calculation_phase &&
      adjustment_type == o.adjustment_type &&
      applies_to_custom_amounts == o.applies_to_custom_amounts &&
      enabled == o.enabled &&
      inclusion_type == o.inclusion_type &&
      type == o.type &&
      v2_id == o.v2_id
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



263
264
265
266
267
268
269
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
 
# File 'lib/square_connect/models/v1_fee.rb', line 263

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/square_connect/models/v1_fee.rb', line 329

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/square_connect/models/v1_fee.rb', line 242

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


229
230
231
 
# File 'lib/square_connect/models/v1_fee.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



235
236
237
 
# File 'lib/square_connect/models/v1_fee.rb', line 235

def hash
  [id, name, rate, calculation_phase, adjustment_type, applies_to_custom_amounts, enabled, inclusion_type, type, v2_id].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



151
152
153
154
 
# File 'lib/square_connect/models/v1_fee.rb', line 151

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



309
310
311
 
# File 'lib/square_connect/models/v1_fee.rb', line 309

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



315
316
317
318
319
320
321
322
323
 
# File 'lib/square_connect/models/v1_fee.rb', line 315

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



303
304
305
 
# File 'lib/square_connect/models/v1_fee.rb', line 303

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



158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/square_connect/models/v1_fee.rb', line 158

def valid?
  calculation_phase_validator = EnumAttributeValidator.new('String', ["FEE_SUBTOTAL_PHASE", "OTHER", "FEE_TOTAL_PHASE"])
  return false unless calculation_phase_validator.valid?(@calculation_phase)
  adjustment_type_validator = EnumAttributeValidator.new('String', ["TAX"])
  return false unless adjustment_type_validator.valid?(@adjustment_type)
  inclusion_type_validator = EnumAttributeValidator.new('String', ["ADDITIVE", "INCLUSIVE"])
  return false unless inclusion_type_validator.valid?(@inclusion_type)
  type_validator = EnumAttributeValidator.new('String', ["CA_GST", "CA_HST", "CA_PST", "CA_QST", "JP_CONSUMPTION_TAX", "CA_PEI_PST", "US_SALES_TAX", "OTHER"])
  return false unless type_validator.valid?(@type)
  return true
end