Class: SquareConnect::Refund
- Inherits:
-
Object
- Object
- SquareConnect::Refund
- Defined in:
- lib/square_connect/models/refund.rb
Overview
Represents a refund processed for a Square transaction.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#additional_recipients ⇒ Object
Additional recipients (other than the merchant) receiving a portion of this refund.
-
#amount_money ⇒ Object
The amount of money refunded to the buyer.
-
#created_at ⇒ Object
The time when the refund was created, in RFC 3339 format.
-
#id ⇒ Object
The refund’s unique ID.
-
#location_id ⇒ Object
The ID of the refund’s associated location.
-
#processing_fee_money ⇒ Object
The amount of Square processing fee money refunded to the merchant.
-
#reason ⇒ Object
The reason for the refund being issued.
-
#status ⇒ Object
The current status of the refund (‘PENDING`, `APPROVED`, `REJECTED`, or `FAILED`).
-
#tender_id ⇒ Object
The ID of the refunded tender.
-
#transaction_id ⇒ Object
The ID of the transaction that the refunded tender is part of.
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 = {}) ⇒ Refund
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 = {}) ⇒ Refund
Initializes the object
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 |
# File 'lib/square_connect/models/refund.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?(:'location_id') self.location_id = attributes[:'location_id'] end if attributes.has_key?(:'transaction_id') self.transaction_id = attributes[:'transaction_id'] end if attributes.has_key?(:'tender_id') self.tender_id = attributes[:'tender_id'] end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'reason') self.reason = attributes[:'reason'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'processing_fee_money') self.processing_fee_money = attributes[:'processing_fee_money'] end if attributes.has_key?(:'additional_recipients') if (value = attributes[:'additional_recipients']).is_a?(Array) self.additional_recipients = value end end end |
Instance Attribute Details
#additional_recipients ⇒ Object
Additional recipients (other than the merchant) receiving a portion of this refund. For example, fees assessed on a refund of a purchase by a third party integration.
43 44 45 |
# File 'lib/square_connect/models/refund.rb', line 43 def additional_recipients @additional_recipients end |
#amount_money ⇒ Object
The amount of money refunded to the buyer.
34 35 36 |
# File 'lib/square_connect/models/refund.rb', line 34 def amount_money @amount_money end |
#created_at ⇒ Object
The time when the refund was created, in RFC 3339 format.
28 29 30 |
# File 'lib/square_connect/models/refund.rb', line 28 def created_at @created_at end |
#id ⇒ Object
The refund’s unique ID.
16 17 18 |
# File 'lib/square_connect/models/refund.rb', line 16 def id @id end |
#location_id ⇒ Object
The ID of the refund’s associated location.
19 20 21 |
# File 'lib/square_connect/models/refund.rb', line 19 def location_id @location_id end |
#processing_fee_money ⇒ Object
The amount of Square processing fee money refunded to the merchant.
40 41 42 |
# File 'lib/square_connect/models/refund.rb', line 40 def processing_fee_money @processing_fee_money end |
#reason ⇒ Object
The reason for the refund being issued.
31 32 33 |
# File 'lib/square_connect/models/refund.rb', line 31 def reason @reason end |
#status ⇒ Object
The current status of the refund (‘PENDING`, `APPROVED`, `REJECTED`, or `FAILED`).
37 38 39 |
# File 'lib/square_connect/models/refund.rb', line 37 def status @status end |
#tender_id ⇒ Object
The ID of the refunded tender.
25 26 27 |
# File 'lib/square_connect/models/refund.rb', line 25 def tender_id @tender_id end |
#transaction_id ⇒ Object
The ID of the transaction that the refunded tender is part of.
22 23 24 |
# File 'lib/square_connect/models/refund.rb', line 22 def transaction_id @transaction_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/refund.rb', line 68 def self.attribute_map { :'id' => :'id', :'location_id' => :'location_id', :'transaction_id' => :'transaction_id', :'tender_id' => :'tender_id', :'created_at' => :'created_at', :'reason' => :'reason', :'amount_money' => :'amount_money', :'status' => :'status', :'processing_fee_money' => :'processing_fee_money', :'additional_recipients' => :'additional_recipients' } 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/refund.rb', line 84 def self.swagger_types { :'id' => :'String', :'location_id' => :'String', :'transaction_id' => :'String', :'tender_id' => :'String', :'created_at' => :'String', :'reason' => :'String', :'amount_money' => :'Money', :'status' => :'String', :'processing_fee_money' => :'Money', :'additional_recipients' => :'Array<AdditionalRecipient>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/square_connect/models/refund.rb', line 213 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && location_id == o.location_id && transaction_id == o.transaction_id && tender_id == o.tender_id && created_at == o.created_at && reason == o.reason && amount_money == o.amount_money && status == o.status && processing_fee_money == o.processing_fee_money && additional_recipients == o.additional_recipients end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 300 |
# File 'lib/square_connect/models/refund.rb', line 264 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
330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/square_connect/models/refund.rb', line 330 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
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/square_connect/models/refund.rb', line 243 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
230 231 232 |
# File 'lib/square_connect/models/refund.rb', line 230 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
236 237 238 |
# File 'lib/square_connect/models/refund.rb', line 236 def hash [id, location_id, transaction_id, tender_id, created_at, reason, amount_money, status, processing_fee_money, additional_recipients].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/square_connect/models/refund.rb', line 153 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push("invalid value for 'id', id cannot be nil.") end if @location_id.nil? invalid_properties.push("invalid value for 'location_id', location_id cannot be nil.") end if @transaction_id.nil? invalid_properties.push("invalid value for 'transaction_id', transaction_id cannot be nil.") end if @tender_id.nil? invalid_properties.push("invalid value for 'tender_id', tender_id cannot be nil.") end if @reason.nil? invalid_properties.push("invalid value for 'reason', reason cannot be nil.") end if @amount_money.nil? invalid_properties.push("invalid value for 'amount_money', amount_money cannot be nil.") end if @status.nil? invalid_properties.push("invalid value for 'status', status cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
310 311 312 |
# File 'lib/square_connect/models/refund.rb', line 310 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
316 317 318 319 320 321 322 323 324 |
# File 'lib/square_connect/models/refund.rb', line 316 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
304 305 306 |
# File 'lib/square_connect/models/refund.rb', line 304 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/square_connect/models/refund.rb', line 188 def valid? return false if @id.nil? return false if @location_id.nil? return false if @transaction_id.nil? return false if @tender_id.nil? return false if @reason.nil? return false if @amount_money.nil? return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ["PENDING", "APPROVED", "REJECTED", "FAILED"]) return false unless status_validator.valid?(@status) return true end |