Class: SyncteraRubySdk::PostedTransactionData

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/posted_transaction_data.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostedTransactionData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 96

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#external_data ⇒ Object

an unstructured json blob representing additional transaction information supplied by the integrator.



19
20
21
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 19

def external_data
  @external_data
end

#force_post ⇒ Object

Whether or not the hold was forced (spending controls ignored)



22
23
24
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 22

def force_post
  @force_post
end

#hold_id ⇒ Object

The uuid of the hold (pending transaction) that this transaction originated from, if any.



25
26
27
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 25

def hold_id
  @hold_id
end

#lines ⇒ Object

The set of accounting entries associated with this transaction. For example, a debit to a customer account will have a corresponding credit in a general ledger account.



28
29
30
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 28

def lines
  @lines
end

#memo ⇒ Object

A short note to the recipient



31
32
33
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 31

def memo
  @memo
end

#metadata ⇒ Object

Returns the value of attribute metadata.



33
34
35
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 33

def metadata
  @metadata
end

#original_trx ⇒ Object

The "original" transaction that this transaction is related to. This is only populated in the case of reversed transactions.



36
37
38
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 36

def original_trx
  @original_trx
end

#parent_trx ⇒ Object

The "parent" transaction that this transaction is related to. This is only populated in the case of scheduled transactions.



39
40
41
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 39

def parent_trx
  @parent_trx
end

#risk_info ⇒ Object

Information received by the transaction risk/fraud service related to this transaction



42
43
44
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 42

def risk_info
  @risk_info
end

#user_data ⇒ Object

An unstructured JSON blob representing additional transaction information specific to each payment rail.



45
46
47
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 45

def user_data
  @user_data
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 48

def self.attribute_map
  {
    :'external_data' => :'external_data',
    :'force_post' => :'force_post',
    :'hold_id' => :'hold_id',
    :'lines' => :'lines',
    :'memo' => :'memo',
    :'metadata' => :'metadata',
    :'original_trx' => :'original_trx',
    :'parent_trx' => :'parent_trx',
    :'risk_info' => :'risk_info',
    :'user_data' => :'user_data'
  }
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



212
213
214
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 212

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
88
89
90
91
92
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 85

def self.openapi_nullable
  Set.new([
    :'external_data',
    :'metadata',
    :'risk_info',
    :'user_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 69

def self.openapi_types
  {
    :'external_data' => :'Object',
    :'force_post' => :'Boolean',
    :'hold_id' => :'String',
    :'lines' => :'Array<TransactionLine1>',
    :'memo' => :'String',
    :'metadata' => :'Object',
    :'original_trx' => :'String',
    :'parent_trx' => :'String',
    :'risk_info' => :'Object',
    :'user_data' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_data == o.external_data &&
      force_post == o.force_post &&
      hold_id == o.hold_id &&
      lines == o.lines &&
      memo == o.memo &&
      metadata == o.metadata &&
      original_trx == o.original_trx &&
      parent_trx == o.parent_trx &&
      risk_info == o.risk_info &&
      user_data == o.user_data
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



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
272
273
274
275
276
277
278
279
280
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 243

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = SyncteraRubySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : 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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 314

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 219

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


199
200
201
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 205

def hash
  [external_data, force_post, hold_id, lines, memo, metadata, original_trx, parent_trx, risk_info, user_data].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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 154

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

  if @lines.nil?
    invalid_properties.push('invalid value for "lines", lines cannot be nil.')
  end

  if @memo.nil?
    invalid_properties.push('invalid value for "memo", memo 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



290
291
292
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 290

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 296

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.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



284
285
286
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 284

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



173
174
175
176
177
178
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction_data.rb', line 173

def valid?
  return false if @force_post.nil?
  return false if @lines.nil?
  return false if @memo.nil?
  true
end