Class: OpenapiClient::PrimaryTransaction
- Inherits:
-
Object
- Object
- OpenapiClient::PrimaryTransaction
- Defined in:
- lib/openapi_client/models/primary_transaction.rb
Overview
Provides shared fields for all PrimaryTransaction request types. Abstract class, do not use this class directly, use one of its children.
Direct Known Subclasses
AchCreditTransaction, AchPreAuthTransaction, AchSaleTransaction, AliPaySaleTransaction, ApmSaleTransaction, ChinaPnRSaleTransaction, PaymentCardCreditTransaction, PaymentCardDisbursementTransaction, PaymentCardForcedTicketTransaction, PaymentCardPayerAuthTransaction, PaymentCardPreAuthTransaction, PaymentCardSaleTransaction, PaymentDeviceCreditTransaction, PaymentDeviceDisbursementTransaction, PaymentDevicePreAuthTransaction, PaymentDeviceSaleTransaction, PaymentTokenCreditTransaction, PaymentTokenDisbursementTransaction, PaymentTokenPreAuthTransaction, PaymentTokenSaleTransaction, PaypalCreditTransaction, SepaCreditTransaction, SepaSaleTransaction, WalletPreAuthTransaction, WalletSaleTransaction
Instance Attribute Summary collapse
-
#allow_partial_approval ⇒ Object
Indicates if the particular transaction is a partial approval transaction, if supplied.
-
#ipg_transaction_id ⇒ Object
The IPG transactionId to reference a payerauth for example.
-
#merchant_transaction_id ⇒ Object
The unique merchant transaction ID from the request header, if supplied.
-
#order ⇒ Object
Returns the value of attribute order.
-
#request_type ⇒ Object
Object name of the primary transaction request.
-
#store_id ⇒ Object
An optional outlet ID for clients that support multiple stores in the same app.
-
#transaction_amount ⇒ Object
Returns the value of attribute transaction_amount.
-
#transaction_origin ⇒ Object
Returns the value of attribute transaction_origin.
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_discriminator_name ⇒ Object
discriminator’s property name in OpenAPI v3.
-
.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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PrimaryTransaction
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(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ 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 = {}) ⇒ PrimaryTransaction
Initializes the object
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 74 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PrimaryTransaction` 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 `OpenapiClient::PrimaryTransaction`. 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?(:'request_type') self.request_type = attributes[:'request_type'] end if attributes.key?(:'transaction_amount') self.transaction_amount = attributes[:'transaction_amount'] end if attributes.key?(:'store_id') self.store_id = attributes[:'store_id'] end if attributes.key?(:'merchant_transaction_id') self.merchant_transaction_id = attributes[:'merchant_transaction_id'] end if attributes.key?(:'transaction_origin') self.transaction_origin = attributes[:'transaction_origin'] end if attributes.key?(:'order') self.order = attributes[:'order'] end if attributes.key?(:'ipg_transaction_id') self.ipg_transaction_id = attributes[:'ipg_transaction_id'] end if attributes.key?(:'allow_partial_approval') self.allow_partial_approval = attributes[:'allow_partial_approval'] end end |
Instance Attribute Details
#allow_partial_approval ⇒ Object
Indicates if the particular transaction is a partial approval transaction, if supplied.
37 38 39 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 37 def allow_partial_approval @allow_partial_approval end |
#ipg_transaction_id ⇒ Object
The IPG transactionId to reference a payerauth for example.
34 35 36 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 34 def ipg_transaction_id @ipg_transaction_id end |
#merchant_transaction_id ⇒ Object
The unique merchant transaction ID from the request header, if supplied.
27 28 29 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 27 def merchant_transaction_id @merchant_transaction_id end |
#order ⇒ Object
Returns the value of attribute order.
31 32 33 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 31 def order @order end |
#request_type ⇒ Object
Object name of the primary transaction request.
19 20 21 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 19 def request_type @request_type end |
#store_id ⇒ Object
An optional outlet ID for clients that support multiple stores in the same app.
24 25 26 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 24 def store_id @store_id end |
#transaction_amount ⇒ Object
Returns the value of attribute transaction_amount.
21 22 23 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 21 def transaction_amount @transaction_amount end |
#transaction_origin ⇒ Object
Returns the value of attribute transaction_origin.
29 30 31 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 29 def transaction_origin @transaction_origin end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 40 def self.attribute_map { :'request_type' => :'requestType', :'transaction_amount' => :'transactionAmount', :'store_id' => :'storeId', :'merchant_transaction_id' => :'merchantTransactionId', :'transaction_origin' => :'transactionOrigin', :'order' => :'order', :'ipg_transaction_id' => :'ipgTransactionId', :'allow_partial_approval' => :'allowPartialApproval' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
203 204 205 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 203 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_discriminator_name ⇒ Object
discriminator’s property name in OpenAPI v3
68 69 70 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 68 def self.openapi_discriminator_name :'request_type' end |
.openapi_types ⇒ Object
Attribute type mapping.
54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 54 def self.openapi_types { :'request_type' => :'String', :'transaction_amount' => :'Amount', :'store_id' => :'String', :'merchant_transaction_id' => :'String', :'transaction_origin' => :'TransactionOrigin', :'order' => :'Order', :'ipg_transaction_id' => :'Integer', :'allow_partial_approval' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 175 def ==(o) return true if self.equal?(o) self.class == o.class && request_type == o.request_type && transaction_amount == o.transaction_amount && store_id == o.store_id && merchant_transaction_id == o.merchant_transaction_id && transaction_origin == o.transaction_origin && order == o.order && ipg_transaction_id == o.ipg_transaction_id && allow_partial_approval == o.allow_partial_approval end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
231 232 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 270 271 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 231 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 klass = OpenapiClient.const_get(type) if klass.respond_to?(:openapi_discriminator_name) klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]]) end klass.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
305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 305 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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object
Builds the object from hash
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 210 def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) return nil unless attributes.is_a?(Hash) 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[attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[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
190 191 192 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 190 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
196 197 198 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 196 def hash [request_type, transaction_amount, store_id, merchant_transaction_id, transaction_origin, order, ipg_transaction_id, allow_partial_approval].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 122 def list_invalid_properties invalid_properties = Array.new if @request_type.nil? invalid_properties.push('invalid value for "request_type", request_type cannot be nil.') end if @transaction_amount.nil? invalid_properties.push('invalid value for "transaction_amount", transaction_amount cannot be nil.') end if !@store_id.nil? && @store_id.to_s.length > 20 invalid_properties.push('invalid value for "store_id", the character length must be smaller than or equal to 20.') end if !@merchant_transaction_id.nil? && @merchant_transaction_id.to_s.length > 40 invalid_properties.push('invalid value for "merchant_transaction_id", the character length must be smaller than or equal to 40.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
281 282 283 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 281 def to_body to_hash end |
#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash
Returns the object in the form of hash
287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 287 def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) hash = {} attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
275 276 277 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 275 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
145 146 147 148 149 150 151 |
# File 'lib/openapi_client/models/primary_transaction.rb', line 145 def valid? return false if @request_type.nil? return false if @transaction_amount.nil? return false if !@store_id.nil? && @store_id.to_s.length > 20 return false if !@merchant_transaction_id.nil? && @merchant_transaction_id.to_s.length > 40 true end |