Class: OpenapiClient::ReturnTransaction

Inherits:
SecondaryTransaction show all
Defined in:
lib/openapi_client/models/return_transaction.rb

Overview

Request to perform return transaction.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SecondaryTransaction

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ ReturnTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

Instance Attribute Details

#comments ⇒ Object

Comment for the secondary transaction.



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

def comments
  @comments
end

#currency_conversion ⇒ Object

Returns the value of attribute currency_conversion.



33
34
35
 
# File 'lib/openapi_client/models/return_transaction.rb', line 33

def currency_conversion
  @currency_conversion
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#request_type ⇒ Object

Object name of the secondary transaction request.



19
20
21
 
# File 'lib/openapi_client/models/return_transaction.rb', line 19

def request_type
  @request_type
end

#soft_descriptor ⇒ Object

Returns the value of attribute soft_descriptor.



31
32
33
 
# File 'lib/openapi_client/models/return_transaction.rb', line 31

def soft_descriptor
  @soft_descriptor
end

#store_id ⇒ Object

An optional outlet ID for clients that support multiple stores in the same developer app.



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

def store_id
  @store_id
end

#transaction_amount ⇒ Object

Returns the value of attribute transaction_amount.



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

def transaction_amount
  @transaction_amount
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'request_type' => :'requestType',
    :'store_id' => :'storeId',
    :'comments' => :'comments',
    :'order' => :'order',
    :'transaction_amount' => :'transactionAmount',
    :'soft_descriptor' => :'softDescriptor',
    :'currency_conversion' => :'currencyConversion'
  }
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



178
179
180
 
# File 'lib/openapi_client/models/return_transaction.rb', line 178

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'ReturnTransactionAllOf',
  :'SecondaryTransaction'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'request_type' => :'String',
    :'store_id' => :'String',
    :'comments' => :'String',
    :'order' => :'Order',
    :'transaction_amount' => :'Amount',
    :'soft_descriptor' => :'SoftDescriptor',
    :'currency_conversion' => :'CurrencyConversion'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/openapi_client/models/return_transaction.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      request_type == o.request_type &&
      store_id == o.store_id &&
      comments == o.comments &&
      order == o.order &&
      transaction_amount == o.transaction_amount &&
      soft_descriptor == o.soft_descriptor &&
      currency_conversion == o.currency_conversion && 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



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
242
 
# File 'lib/openapi_client/models/return_transaction.rb', line 207

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
    OpenapiClient.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/openapi_client/models/return_transaction.rb', line 272

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/openapi_client/models/return_transaction.rb', line 185

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
 
# File 'lib/openapi_client/models/return_transaction.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



171
172
173
 
# File 'lib/openapi_client/models/return_transaction.rb', line 171

def hash
  [request_type, store_id, comments, order, transaction_amount, soft_descriptor, currency_conversion].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



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/openapi_client/models/return_transaction.rb', line 118

def list_invalid_properties
  invalid_properties = super
  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 @transaction_amount.nil?
    invalid_properties.push('invalid value for "transaction_amount", transaction_amount 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



252
253
254
 
# File 'lib/openapi_client/models/return_transaction.rb', line 252

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



258
259
260
261
262
263
264
265
266
 
# File 'lib/openapi_client/models/return_transaction.rb', line 258

def to_hash
  hash = super
  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

Returns:

  • (String) —

    String presentation of the object



246
247
248
 
# File 'lib/openapi_client/models/return_transaction.rb', line 246

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



133
134
135
136
137
 
# File 'lib/openapi_client/models/return_transaction.rb', line 133

def valid?
  return false if !@store_id.nil? && @store_id.to_s.length > 20
  return false if @transaction_amount.nil?
  true && super
end