Class: SquareConnect::ChargeRequestAdditionalRecipient

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

Overview

Represents an additional recipient (other than the merchant) entitled to a portion of the tender. Support is currently limited to USD, CAD and GBP currencies

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChargeRequestAdditionalRecipient

Initializes the object

Parameters:

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

    Model attributes in the form of hash



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 45

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

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

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

end

Instance Attribute Details

#amount_money ⇒ Object

The amount of money distributed to the recipient.



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

def amount_money
  @amount_money
end

#description ⇒ Object

The description of the additional recipient.



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

def description
  @description
end

#location_id ⇒ Object

The location ID for a recipient (other than the merchant) receiving a portion of the tender.



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

def location_id
  @location_id
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 26

def self.attribute_map
  {
    :'location_id' => :'location_id',
    :'description' => :'description',
    :'amount_money' => :'amount_money'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 35

def self.swagger_types
  {
    :'location_id' => :'String',
    :'description' => :'String',
    :'amount_money' => :'Money'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      location_id == o.location_id &&
      description == o.description &&
      amount_money == o.amount_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



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
231
 
# File 'lib/square_connect/models/charge_request_additional_recipient.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
    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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 261

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/square_connect/models/charge_request_additional_recipient.rb', line 174

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


161
162
163
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 167

def hash
  [location_id, description, amount_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



67
68
69
70
71
72
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
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 67

def list_invalid_properties
  invalid_properties = Array.new
  if @location_id.nil?
    invalid_properties.push("invalid value for 'location_id', location_id cannot be nil.")
  end

  if @location_id.to_s.length > 50
    invalid_properties.push("invalid value for 'location_id', the character length must be smaller than or equal to 50.")
  end

  if @location_id.to_s.length < 1
    invalid_properties.push("invalid value for 'location_id', the character length must be great than or equal to 1.")
  end

  if @description.nil?
    invalid_properties.push("invalid value for 'description', description cannot be nil.")
  end

  if @description.to_s.length > 100
    invalid_properties.push("invalid value for 'description', the character length must be smaller than or equal to 100.")
  end

  if @description.to_s.length < 1
    invalid_properties.push("invalid value for 'description', the character length must be great than or equal to 1.")
  end

  if @amount_money.nil?
    invalid_properties.push("invalid value for 'amount_money', amount_money cannot be nil.")
  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



241
242
243
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 241

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



247
248
249
250
251
252
253
254
255
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 247

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



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

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



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/square_connect/models/charge_request_additional_recipient.rb', line 102

def valid?
  return false if @location_id.nil?
  return false if @location_id.to_s.length > 50
  return false if @location_id.to_s.length < 1
  return false if @description.nil?
  return false if @description.to_s.length > 100
  return false if @description.to_s.length < 1
  return false if @amount_money.nil?
  return true
end