Class: Yapstone::RefundRequest
- Inherits:
-
Object
- Object
- Yapstone::RefundRequest
- Defined in:
- lib/yapstone-payments/models/refund_request.rb
Overview
Details for a refund request - the amount to be refunded and the identifier for the transaction you want to arrange a refund for.
Instance Attribute Summary collapse
-
#amount ⇒ Object
Returns the value of attribute amount.
-
#client_correlation_id ⇒ Object
client correlation id.
-
#client_unique_transaction_id ⇒ Object
clientUniqueTransactionId used to identify duplicate request.
-
#payment_id ⇒ Object
Returns the value of attribute payment_id.
-
#transactions ⇒ Object
Returns the value of attribute transactions.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_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 ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RefundRequest
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 = {}) ⇒ RefundRequest
Initializes the object
54 55 56 57 58 59 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 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 54 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::RefundRequest` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Yapstone::RefundRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'client_correlation_id') self.client_correlation_id = attributes[:'client_correlation_id'] end if attributes.key?(:'client_unique_transaction_id') self.client_unique_transaction_id = attributes[:'client_unique_transaction_id'] end if attributes.key?(:'payment_id') self.payment_id = attributes[:'payment_id'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'transactions') if (value = attributes[:'transactions']).is_a?(Array) self.transactions = value end end end |
Instance Attribute Details
#amount ⇒ Object
Returns the value of attribute amount.
26 27 28 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 26 def amount @amount end |
#client_correlation_id ⇒ Object
client correlation id
19 20 21 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 19 def client_correlation_id @client_correlation_id end |
#client_unique_transaction_id ⇒ Object
clientUniqueTransactionId used to identify duplicate request
22 23 24 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 22 def client_unique_transaction_id @client_unique_transaction_id end |
#payment_id ⇒ Object
Returns the value of attribute payment_id.
24 25 26 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 24 def payment_id @payment_id end |
#transactions ⇒ Object
Returns the value of attribute transactions.
28 29 30 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 28 def transactions @transactions end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
31 32 33 34 35 36 37 38 39 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 31 def self.attribute_map { :'client_correlation_id' => :'clientCorrelationId', :'client_unique_transaction_id' => :'clientUniqueTransactionId', :'payment_id' => :'paymentId', :'amount' => :'amount', :'transactions' => :'transactions' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
178 179 180 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 178 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
42 43 44 45 46 47 48 49 50 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 42 def self.openapi_types { :'client_correlation_id' => :'String', :'client_unique_transaction_id' => :'String', :'payment_id' => :'String', :'amount' => :'Amount', :'transactions' => :'Array<Transaction>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
153 154 155 156 157 158 159 160 161 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 153 def ==(o) return true if self.equal?(o) self.class == o.class && client_correlation_id == o.client_correlation_id && client_unique_transaction_id == o.client_unique_transaction_id && payment_id == o.payment_id && amount == o.amount && transactions == o.transactions end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 206 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 Yapstone.const_get(type).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
271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 271 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
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 185 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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
165 166 167 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 165 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
171 172 173 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 171 def hash [client_correlation_id, client_unique_transaction_id, payment_id, amount, transactions].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 92 def list_invalid_properties invalid_properties = Array.new if !@client_correlation_id.nil? && @client_correlation_id.to_s.length > 128 invalid_properties.push('invalid value for "client_correlation_id", the character length must be smaller than or equal to 128.') end if !@client_correlation_id.nil? && @client_correlation_id.to_s.length < 0 invalid_properties.push('invalid value for "client_correlation_id", the character length must be great than or equal to 0.') end if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length > 128 invalid_properties.push('invalid value for "client_unique_transaction_id", the character length must be smaller than or equal to 128.') end if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length < 0 invalid_properties.push('invalid value for "client_unique_transaction_id", the character length must be great than or equal to 0.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
251 252 253 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 251 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
257 258 259 260 261 262 263 264 265 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 257 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
245 246 247 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 245 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
115 116 117 118 119 120 121 |
# File 'lib/yapstone-payments/models/refund_request.rb', line 115 def valid? return false if !@client_correlation_id.nil? && @client_correlation_id.to_s.length > 128 return false if !@client_correlation_id.nil? && @client_correlation_id.to_s.length < 0 return false if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length > 128 return false if !@client_unique_transaction_id.nil? && @client_unique_transaction_id.to_s.length < 0 true end |