Class: OpenapiClient::SecondaryTransaction

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/secondary_transaction.rb

Overview

Model for secondary financial transactions. Abstract class, do not use this class directly, use one of its children.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecondaryTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
89
90
91
92
93
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 61

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

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

Instance Attribute Details

#comments ⇒ Object

Comment for the secondary transaction.



28
29
30
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 28

def comments
  @comments
end

#merchant_transaction_id ⇒ Object

The unique merchant transaction ID from the request, if supplied.



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

def merchant_transaction_id
  @merchant_transaction_id
end

#order ⇒ Object

Returns the value of attribute order.



30
31
32
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 30

def order
  @order
end

#request_type ⇒ Object

Object name of the secondary transaction request.



19
20
21
 
# File 'lib/openapi_client/models/secondary_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 developer app.



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

def store_id
  @store_id
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 33

def self.attribute_map
  {
    :'request_type' => :'requestType',
    :'store_id' => :'storeId',
    :'merchant_transaction_id' => :'merchantTransactionId',
    :'comments' => :'comments',
    :'order' => :'order'
  }
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



170
171
172
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 170

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



55
56
57
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 55

def self.openapi_discriminator_name
  :'request_type'
end

.openapi_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 44

def self.openapi_types
  {
    :'request_type' => :'String',
    :'store_id' => :'String',
    :'merchant_transaction_id' => :'String',
    :'comments' => :'String',
    :'order' => :'Order'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 145

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



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
236
237
238
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 198

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/openapi_client/models/secondary_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, 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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 177

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 163

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 97

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 !@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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



248
249
250
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 248

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 254

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

Returns:

  • (String) —

    String presentation of the object



242
243
244
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 242

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



116
117
118
119
120
121
 
# File 'lib/openapi_client/models/secondary_transaction.rb', line 116

def valid?
  return false if @request_type.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