Class: SquareConnect::AdditionalRecipientReceivable
- Inherits:
-
Object
- Object
- SquareConnect::AdditionalRecipientReceivable
- Defined in:
- lib/square_connect/models/additional_recipient_receivable.rb
Overview
Represents a monetary distribution of part of a [Transaction](#type-transaction)‘s amount for Transactions which included additional recipients. The location of this receivable is that same as the one specified in the [AdditionalRecipient](#type-additionalrecipient).
Instance Attribute Summary collapse
-
#amount_money ⇒ Object
The amount of the receivable.
-
#created_at ⇒ Object
The time when the additional recipient receivable was created, in RFC 3339 format.
-
#id ⇒ Object
The additional recipient receivable’s unique ID, issued by Square payments servers.
-
#refunds ⇒ Object
Any refunds of the receivable that have been applied.
-
#transaction_id ⇒ Object
The ID of the transaction that the additional recipient receivable was applied to.
-
#transaction_location_id ⇒ Object
The ID of the location that created the receivable.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ AdditionalRecipientReceivable
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ AdditionalRecipientReceivable
Initializes the object
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 91 92 |
# File 'lib/square_connect/models/additional_recipient_receivable.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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'transaction_id') self.transaction_id = attributes[:'transaction_id'] end if attributes.has_key?(:'transaction_location_id') self.transaction_location_id = attributes[:'transaction_location_id'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'refunds') if (value = attributes[:'refunds']).is_a?(Array) self.refunds = value end end end |
Instance Attribute Details
#amount_money ⇒ Object
The amount of the receivable. This will always be non-negative.
25 26 27 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 25 def amount_money @amount_money end |
#created_at ⇒ Object
The time when the additional recipient receivable was created, in RFC 3339 format.
28 29 30 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 28 def created_at @created_at end |
#id ⇒ Object
The additional recipient receivable’s unique ID, issued by Square payments servers.
16 17 18 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 16 def id @id end |
#refunds ⇒ Object
Any refunds of the receivable that have been applied.
31 32 33 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 31 def refunds @refunds end |
#transaction_id ⇒ Object
The ID of the transaction that the additional recipient receivable was applied to.
19 20 21 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 19 def transaction_id @transaction_id end |
#transaction_location_id ⇒ Object
The ID of the location that created the receivable. This is the location ID on the associated transaction.
22 23 24 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 22 def transaction_location_id @transaction_location_id 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/additional_recipient_receivable.rb', line 35 def self.attribute_map { :'id' => :'id', :'transaction_id' => :'transaction_id', :'transaction_location_id' => :'transaction_location_id', :'amount_money' => :'amount_money', :'created_at' => :'created_at', :'refunds' => :'refunds' } end |
.swagger_types ⇒ Object
Attribute type mapping.
47 48 49 50 51 52 53 54 55 56 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 47 def self.swagger_types { :'id' => :'String', :'transaction_id' => :'String', :'transaction_location_id' => :'String', :'amount_money' => :'Money', :'created_at' => :'String', :'refunds' => :'Array<AdditionalRecipientReceivableRefund>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
186 187 188 189 190 191 192 193 194 195 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 186 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && transaction_id == o.transaction_id && transaction_location_id == o.transaction_location_id && amount_money == o.amount_money && created_at == o.created_at && refunds == o.refunds end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
233 234 235 236 237 238 239 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 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 233 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
299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 299 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
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 212 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
199 200 201 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 199 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
205 206 207 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 205 def hash [id, transaction_id, transaction_location_id, amount_money, created_at, refunds].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 96 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push("invalid value for 'id', id cannot be nil.") end if @id.to_s.length < 1 invalid_properties.push("invalid value for 'id', the character length must be great than or equal to 1.") end if @transaction_id.nil? invalid_properties.push("invalid value for 'transaction_id', transaction_id cannot be nil.") end if @transaction_id.to_s.length < 1 invalid_properties.push("invalid value for 'transaction_id', the character length must be great than or equal to 1.") end if @transaction_location_id.nil? invalid_properties.push("invalid value for 'transaction_location_id', transaction_location_id cannot be nil.") end if @transaction_location_id.to_s.length < 1 invalid_properties.push("invalid value for 'transaction_location_id', 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)
279 280 281 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 279 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
285 286 287 288 289 290 291 292 293 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 285 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
273 274 275 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 273 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
131 132 133 134 135 136 137 138 139 140 |
# File 'lib/square_connect/models/additional_recipient_receivable.rb', line 131 def valid? return false if @id.nil? return false if @id.to_s.length < 1 return false if @transaction_id.nil? return false if @transaction_id.to_s.length < 1 return false if @transaction_location_id.nil? return false if @transaction_location_id.to_s.length < 1 return false if @amount_money.nil? return true end |