Class: OpenapiClient::PaymentTokenPreAuthTransaction

Inherits:
PrimaryTransaction show all
Defined in:
lib/openapi_client/models/payment_token_pre_auth_transaction.rb

Overview

Request to create pre-auth transaction using payment token.

Instance Attribute Summary collapse

Attributes inherited from PrimaryTransaction

#merchant_transaction_id, #order, #request_type, #store_id, #transaction_amount, #transaction_origin

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PrimaryTransaction

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ PaymentTokenPreAuthTransaction

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



70
71
72
73
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
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 70

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PaymentTokenPreAuthTransaction` 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::PaymentTokenPreAuthTransaction`. 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
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'payment_method')
    self.payment_method = attributes[:'payment_method']
  end

  if attributes.key?(:'stored_credentials')
    self.stored_credentials = attributes[:'stored_credentials']
  end

  if attributes.key?(:'split_shipment')
    self.split_shipment = attributes[:'split_shipment']
  end

  if attributes.key?(:'settlement_split')
    if (value = attributes[:'settlement_split']).is_a?(Array)
      self.settlement_split = value
    end
  end

  if attributes.key?(:'authentication_request')
    self.authentication_request = attributes[:'authentication_request']
  end

  if attributes.key?(:'authentication_result')
    self.authentication_result = attributes[:'authentication_result']
  end

  if attributes.key?(:'decremental_flag')
    self.decremental_flag = attributes[:'decremental_flag']
  else
    self.decremental_flag = false
  end
end

Instance Attribute Details

#authentication_request ⇒ Object

Returns the value of attribute authentication_request.



27
28
29
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 27

def authentication_request
  @authentication_request
end

#authentication_result ⇒ Object

Returns the value of attribute authentication_result.



29
30
31
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 29

def authentication_result
  @authentication_result
end

#decremental_flag ⇒ Object

This flag can only be used in a preAuth transaction that updates the amount of a previous preAuth transaction to either increase the preAuth amount (DecrementalPreAuthFlag = false) or decrease the preAuth amount (DecrementalPreAuthFlag = true).



32
33
34
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 32

def decremental_flag
  @decremental_flag
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



18
19
20
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 18

def payment_method
  @payment_method
end

#settlement_split ⇒ Object

Settle with multiple sub-merchants, sale and preAuth only.



25
26
27
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 25

def settlement_split
  @settlement_split
end

#split_shipment ⇒ Object

Returns the value of attribute split_shipment.



22
23
24
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 22

def split_shipment
  @split_shipment
end

#stored_credentials ⇒ Object

Returns the value of attribute stored_credentials.



20
21
22
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 20

def stored_credentials
  @stored_credentials
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 35

def self.attribute_map
  {
    :'payment_method' => :'paymentMethod',
    :'stored_credentials' => :'storedCredentials',
    :'split_shipment' => :'splitShipment',
    :'settlement_split' => :'settlementSplit',
    :'authentication_request' => :'authenticationRequest',
    :'authentication_result' => :'authenticationResult',
    :'decremental_flag' => :'decrementalFlag'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



166
167
168
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 166

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



61
62
63
64
65
66
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 61

def self.openapi_all_of
  [
  :'PaymentTokenPreAuthTransactionAllOf',
  :'PrimaryTransaction'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 48

def self.openapi_types
  {
    :'payment_method' => :'PaymentTokenPaymentMethod',
    :'stored_credentials' => :'StoredCredential',
    :'split_shipment' => :'SplitShipment',
    :'settlement_split' => :'Array<SubMerchantSplit>',
    :'authentication_request' => :'AuthenticationRequest',
    :'authentication_result' => :'AuthenticationResult',
    :'decremental_flag' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_method == o.payment_method &&
      stored_credentials == o.stored_credentials &&
      split_shipment == o.split_shipment &&
      settlement_split == o.settlement_split &&
      authentication_request == o.authentication_request &&
      authentication_result == o.authentication_result &&
      decremental_flag == o.decremental_flag && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



195
196
197
198
199
200
201
202
203
204
205
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
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 195

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 269

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 173

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  super(attributes, self.class.superclass.attribute_map, self.class.superclass.openapi_types)
  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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


153
154
155
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 153

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



159
160
161
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 159

def hash
  [payment_method, stored_credentials, split_shipment, settlement_split, authentication_request, authentication_result, decremental_flag].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



121
122
123
124
125
126
127
128
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 121

def list_invalid_properties
  invalid_properties = super
  if @payment_method.nil?
    invalid_properties.push('invalid value for "payment_method", payment_method cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 245

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

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 251

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = super(self.class.superclass.attribute_map, openapi_nullable)
  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

Returns:

  • (String) —

    String presentation of the object



239
240
241
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 239

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



132
133
134
135
 
# File 'lib/openapi_client/models/payment_token_pre_auth_transaction.rb', line 132

def valid?
  return false if @payment_method.nil?
  true && super
end