Class: SquareConnect::V1Refund
- Inherits:
-
Object
- Object
- SquareConnect::V1Refund
- Defined in:
- lib/square_connect/models/v1_refund.rb
Overview
V1Refund
Instance Attribute Summary collapse
-
#created_at ⇒ Object
The time when the merchant initiated the refund for Square to process, in ISO 8601 format.
-
#is_exchange ⇒ Object
Indicates whether or not the refund is associated with an exchange.
-
#merchant_id ⇒ Object
Returns the value of attribute merchant_id.
-
#payment_id ⇒ Object
A Square-issued ID associated with the refund.
-
#processed_at ⇒ Object
The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.
-
#reason ⇒ Object
The merchant-specified reason for the refund.
-
#refunded_additive_tax ⇒ Object
All of the additive taxes associated with the refund.
-
#refunded_additive_tax_money ⇒ Object
The amount of additive tax money refunded.
-
#refunded_discount_money ⇒ Object
The amount of discount money refunded.
-
#refunded_inclusive_tax ⇒ Object
All of the inclusive taxes associated with the refund.
-
#refunded_inclusive_tax_money ⇒ Object
The amount of inclusive tax money refunded.
-
#refunded_money ⇒ Object
The amount of money refunded.
-
#refunded_processing_fee_money ⇒ Object
The amount of processing fee money refunded.
-
#refunded_surcharge_money ⇒ Object
The amount of surcharge money refunded.
-
#refunded_surcharges ⇒ Object
A list of all surcharges associated with the refund.
-
#refunded_tax_money ⇒ Object
The total amount of tax money refunded.
-
#refunded_tip_money ⇒ Object
The amount of tip money refunded.
-
#type ⇒ Object
The type of refund See [V1RefundType](#type-v1refundtype) for possible values.
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 = {}) ⇒ V1Refund
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 = {}) ⇒ V1Refund
Initializes the object
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 150 151 152 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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/square_connect/models/v1_refund.rb', line 120 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?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'reason') self.reason = attributes[:'reason'] end if attributes.has_key?(:'refunded_money') self.refunded_money = attributes[:'refunded_money'] end if attributes.has_key?(:'refunded_processing_fee_money') self.refunded_processing_fee_money = attributes[:'refunded_processing_fee_money'] end if attributes.has_key?(:'refunded_tax_money') self.refunded_tax_money = attributes[:'refunded_tax_money'] end if attributes.has_key?(:'refunded_additive_tax_money') self.refunded_additive_tax_money = attributes[:'refunded_additive_tax_money'] end if attributes.has_key?(:'refunded_additive_tax') if (value = attributes[:'refunded_additive_tax']).is_a?(Array) self.refunded_additive_tax = value end end if attributes.has_key?(:'refunded_inclusive_tax_money') self.refunded_inclusive_tax_money = attributes[:'refunded_inclusive_tax_money'] end if attributes.has_key?(:'refunded_inclusive_tax') if (value = attributes[:'refunded_inclusive_tax']).is_a?(Array) self.refunded_inclusive_tax = value end end if attributes.has_key?(:'refunded_tip_money') self.refunded_tip_money = attributes[:'refunded_tip_money'] end if attributes.has_key?(:'refunded_discount_money') self.refunded_discount_money = attributes[:'refunded_discount_money'] end if attributes.has_key?(:'refunded_surcharge_money') self.refunded_surcharge_money = attributes[:'refunded_surcharge_money'] end if attributes.has_key?(:'refunded_surcharges') if (value = attributes[:'refunded_surcharges']).is_a?(Array) self.refunded_surcharges = value end end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'processed_at') self.processed_at = attributes[:'processed_at'] end if attributes.has_key?(:'payment_id') self.payment_id = attributes[:'payment_id'] end if attributes.has_key?(:'merchant_id') self.merchant_id = attributes[:'merchant_id'] end if attributes.has_key?(:'is_exchange') self.is_exchange = attributes[:'is_exchange'] end end |
Instance Attribute Details
#created_at ⇒ Object
The time when the merchant initiated the refund for Square to process, in ISO 8601 format.
55 56 57 |
# File 'lib/square_connect/models/v1_refund.rb', line 55 def created_at @created_at end |
#is_exchange ⇒ Object
Indicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.
67 68 69 |
# File 'lib/square_connect/models/v1_refund.rb', line 67 def is_exchange @is_exchange end |
#merchant_id ⇒ Object
Returns the value of attribute merchant_id.
64 65 66 |
# File 'lib/square_connect/models/v1_refund.rb', line 64 def merchant_id @merchant_id end |
#payment_id ⇒ Object
A Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.
61 62 63 |
# File 'lib/square_connect/models/v1_refund.rb', line 61 def payment_id @payment_id end |
#processed_at ⇒ Object
The time when Square processed the refund on behalf of the merchant, in ISO 8601 format.
58 59 60 |
# File 'lib/square_connect/models/v1_refund.rb', line 58 def processed_at @processed_at end |
#reason ⇒ Object
The merchant-specified reason for the refund.
19 20 21 |
# File 'lib/square_connect/models/v1_refund.rb', line 19 def reason @reason end |
#refunded_additive_tax ⇒ Object
All of the additive taxes associated with the refund.
34 35 36 |
# File 'lib/square_connect/models/v1_refund.rb', line 34 def refunded_additive_tax @refunded_additive_tax end |
#refunded_additive_tax_money ⇒ Object
The amount of additive tax money refunded. This amount is always negative.
31 32 33 |
# File 'lib/square_connect/models/v1_refund.rb', line 31 def refunded_additive_tax_money @refunded_additive_tax_money end |
#refunded_discount_money ⇒ Object
The amount of discount money refunded. This amount is always positive.
46 47 48 |
# File 'lib/square_connect/models/v1_refund.rb', line 46 def refunded_discount_money @refunded_discount_money end |
#refunded_inclusive_tax ⇒ Object
All of the inclusive taxes associated with the refund.
40 41 42 |
# File 'lib/square_connect/models/v1_refund.rb', line 40 def refunded_inclusive_tax @refunded_inclusive_tax end |
#refunded_inclusive_tax_money ⇒ Object
The amount of inclusive tax money refunded. This amount is always negative.
37 38 39 |
# File 'lib/square_connect/models/v1_refund.rb', line 37 def refunded_inclusive_tax_money @refunded_inclusive_tax_money end |
#refunded_money ⇒ Object
The amount of money refunded. This amount is always negative.
22 23 24 |
# File 'lib/square_connect/models/v1_refund.rb', line 22 def refunded_money @refunded_money end |
#refunded_processing_fee_money ⇒ Object
The amount of processing fee money refunded. This amount is always positive.
25 26 27 |
# File 'lib/square_connect/models/v1_refund.rb', line 25 def refunded_processing_fee_money @refunded_processing_fee_money end |
#refunded_surcharge_money ⇒ Object
The amount of surcharge money refunded. This amount is always negative.
49 50 51 |
# File 'lib/square_connect/models/v1_refund.rb', line 49 def refunded_surcharge_money @refunded_surcharge_money end |
#refunded_surcharges ⇒ Object
A list of all surcharges associated with the refund.
52 53 54 |
# File 'lib/square_connect/models/v1_refund.rb', line 52 def refunded_surcharges @refunded_surcharges end |
#refunded_tax_money ⇒ Object
The total amount of tax money refunded. This amount is always negative.
28 29 30 |
# File 'lib/square_connect/models/v1_refund.rb', line 28 def refunded_tax_money @refunded_tax_money end |
#refunded_tip_money ⇒ Object
The amount of tip money refunded. This amount is always negative.
43 44 45 |
# File 'lib/square_connect/models/v1_refund.rb', line 43 def refunded_tip_money @refunded_tip_money end |
#type ⇒ Object
The type of refund See [V1RefundType](#type-v1refundtype) for possible values
16 17 18 |
# File 'lib/square_connect/models/v1_refund.rb', line 16 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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/v1_refund.rb', line 71 def self.attribute_map { :'type' => :'type', :'reason' => :'reason', :'refunded_money' => :'refunded_money', :'refunded_processing_fee_money' => :'refunded_processing_fee_money', :'refunded_tax_money' => :'refunded_tax_money', :'refunded_additive_tax_money' => :'refunded_additive_tax_money', :'refunded_additive_tax' => :'refunded_additive_tax', :'refunded_inclusive_tax_money' => :'refunded_inclusive_tax_money', :'refunded_inclusive_tax' => :'refunded_inclusive_tax', :'refunded_tip_money' => :'refunded_tip_money', :'refunded_discount_money' => :'refunded_discount_money', :'refunded_surcharge_money' => :'refunded_surcharge_money', :'refunded_surcharges' => :'refunded_surcharges', :'created_at' => :'created_at', :'processed_at' => :'processed_at', :'payment_id' => :'payment_id', :'merchant_id' => :'merchant_id', :'is_exchange' => :'is_exchange' } end |
.swagger_types ⇒ Object
Attribute type mapping.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/square_connect/models/v1_refund.rb', line 95 def self.swagger_types { :'type' => :'String', :'reason' => :'String', :'refunded_money' => :'V1Money', :'refunded_processing_fee_money' => :'V1Money', :'refunded_tax_money' => :'V1Money', :'refunded_additive_tax_money' => :'V1Money', :'refunded_additive_tax' => :'Array<V1PaymentTax>', :'refunded_inclusive_tax_money' => :'V1Money', :'refunded_inclusive_tax' => :'Array<V1PaymentTax>', :'refunded_tip_money' => :'V1Money', :'refunded_discount_money' => :'V1Money', :'refunded_surcharge_money' => :'V1Money', :'refunded_surcharges' => :'Array<V1PaymentSurcharge>', :'created_at' => :'String', :'processed_at' => :'String', :'payment_id' => :'String', :'merchant_id' => :'String', :'is_exchange' => :'BOOLEAN' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/square_connect/models/v1_refund.rb', line 221 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && reason == o.reason && refunded_money == o.refunded_money && refunded_processing_fee_money == o.refunded_processing_fee_money && refunded_tax_money == o.refunded_tax_money && refunded_additive_tax_money == o.refunded_additive_tax_money && refunded_additive_tax == o.refunded_additive_tax && refunded_inclusive_tax_money == o.refunded_inclusive_tax_money && refunded_inclusive_tax == o.refunded_inclusive_tax && refunded_tip_money == o.refunded_tip_money && refunded_discount_money == o.refunded_discount_money && refunded_surcharge_money == o.refunded_surcharge_money && refunded_surcharges == o.refunded_surcharges && created_at == o.created_at && processed_at == o.processed_at && payment_id == o.payment_id && merchant_id == o.merchant_id && is_exchange == o.is_exchange end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/square_connect/models/v1_refund.rb', line 280 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
346 347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'lib/square_connect/models/v1_refund.rb', line 346 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
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/square_connect/models/v1_refund.rb', line 259 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
246 247 248 |
# File 'lib/square_connect/models/v1_refund.rb', line 246 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
252 253 254 |
# File 'lib/square_connect/models/v1_refund.rb', line 252 def hash [type, reason, refunded_money, refunded_processing_fee_money, refunded_tax_money, refunded_additive_tax_money, refunded_additive_tax, refunded_inclusive_tax_money, refunded_inclusive_tax, refunded_tip_money, refunded_discount_money, refunded_surcharge_money, refunded_surcharges, created_at, processed_at, payment_id, merchant_id, is_exchange].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
208 209 210 211 |
# File 'lib/square_connect/models/v1_refund.rb', line 208 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)
326 327 328 |
# File 'lib/square_connect/models/v1_refund.rb', line 326 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
332 333 334 335 336 337 338 339 340 |
# File 'lib/square_connect/models/v1_refund.rb', line 332 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
320 321 322 |
# File 'lib/square_connect/models/v1_refund.rb', line 320 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
215 216 217 |
# File 'lib/square_connect/models/v1_refund.rb', line 215 def valid? return true end |