Class: Yapstone::CapturePaymentRequest
- Inherits:
-
Object
- Object
- Yapstone::CapturePaymentRequest
- Defined in:
- lib/yapstone-payments/models/capture_payment_request.rb
Overview
Payload for capture payment
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#amount ⇒ Object
Returns the value of attribute amount.
-
#authorization_type ⇒ Object
For capturing a payment there are two steps, pre-authorization (PRIORAUTH) and capture (FINALAUTH).
-
#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 = {}) ⇒ CapturePaymentRequest
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 = {}) ⇒ CapturePaymentRequest
Initializes the object
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 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 67 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::CapturePaymentRequest` 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::CapturePaymentRequest`. 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?(:'authorization_type') self. = attributes[:'authorization_type'] 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.
21 22 23 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 21 def amount @amount end |
#authorization_type ⇒ Object
For capturing a payment there are two steps, pre-authorization (PRIORAUTH) and capture (FINALAUTH). PRIORAUTH means that you are requesting pre-authorization. This is where you place a hold on your customer’s credit card for a specified dollar amount based on a projected sale amount. Say your customer’s card has $5000 on it and you want to reserve $250 for a payment so you put a $250 pre-authorization on their card. Now their credit limit is only $4750. Next, you must capture that money. The FINALAUTH enum is used to indicate that you are ready to authorize collection of the funds from the customer credit card.
19 20 21 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 19 def @authorization_type end |
#transactions ⇒ Object
Returns the value of attribute transactions.
23 24 25 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 23 def transactions @transactions end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
48 49 50 51 52 53 54 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 48 def self.attribute_map { :'authorization_type' => :'authorizationType', :'amount' => :'amount', :'transactions' => :'transactions' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
145 146 147 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 145 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
57 58 59 60 61 62 63 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 57 def self.openapi_types { :'authorization_type' => :'String', :'amount' => :'Amount', :'transactions' => :'Array<Transaction>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
122 123 124 125 126 127 128 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 122 def ==(o) return true if self.equal?(o) self.class == o.class && == o. && amount == o.amount && transactions == o.transactions end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 205 206 207 208 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 173 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
238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 238 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
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 152 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
132 133 134 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 132 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
138 139 140 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 138 def hash [, amount, transactions].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
97 98 99 100 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 97 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
218 219 220 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 218 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
224 225 226 227 228 229 230 231 232 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 224 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
212 213 214 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 212 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
104 105 106 107 108 |
# File 'lib/yapstone-payments/models/capture_payment_request.rb', line 104 def valid? = EnumAttributeValidator.new('String', ["FINALAUTH", "PRIORAUTH"]) return false unless .valid?(@authorization_type) true end |