Class: Trulioo::TransactionStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/trulioo_sdk/models/transaction_status.rb

Overview

Transaction Status

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
94
95
96
97
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 65

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

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

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

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

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

Instance Attribute Details

#is_timed_out ⇒ Object

Set to true when transaction has timed out



28
29
30
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 28

def is_timed_out
  @is_timed_out
end

#status ⇒ Object

Status of the transaction. Possible Values: Uploading, Processing, Completed, InProgress, Failed, WaitAsync, ToBeResumed, Canceled, TimeoutCanceled. Call GetTransactionRecord when status changes to Completed, Failed, Canceled or TimeoutCanceled to get the verification results.



22
23
24
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 22

def status
  @status
end

#transaction_id ⇒ Object

Transaction ID of the transaction



16
17
18
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 16

def transaction_id
  @transaction_id
end

#transaction_record_id ⇒ Object

Transaction Record ID of the transaction available once the transaction has finished processing



19
20
21
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 19

def transaction_record_id
  @transaction_record_id
end

#uploaded_dt ⇒ Object

Uploaded date for transaction



25
26
27
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 25

def uploaded_dt
  @uploaded_dt
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 31

def self.attribute_map
  {
    :'transaction_id' => :'TransactionId',
    :'transaction_record_id' => :'TransactionRecordId',
    :'status' => :'Status',
    :'uploaded_dt' => :'UploadedDt',
    :'is_timed_out' => :'IsTimedOut'
  }
end

.build_from_hash(attributes) ⇒ Object

:nocov: 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/trulioo_sdk/models/transaction_status.rb', line 212

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



58
59
60
61
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 58

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 47

def self.openapi_types
  {
    :'transaction_id' => :'String',
    :'transaction_record_id' => :'String',
    :'status' => :'String',
    :'uploaded_dt' => :'Time',
    :'is_timed_out' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      transaction_id == o.transaction_id &&
      transaction_record_id == o.transaction_record_id &&
      status == o.status &&
      uploaded_dt == o.uploaded_dt &&
      is_timed_out == o.is_timed_out
end

#_deserialize(type, value) ⇒ Object

:nocov: Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
281
282
283
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 246

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 = Trulioo.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

:nocov: 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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 325

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

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 221

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


198
199
200
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 204

def hash
  [transaction_id, transaction_record_id, status, uploaded_dt, is_timed_out].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



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
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 101

def list_invalid_properties
  invalid_properties = Array.new
  if !@transaction_id.nil? && @transaction_id.to_s.length > 36
    invalid_properties.push('invalid value for "transaction_id", the character length must be smaller than or equal to 36.')
  end

  if !@transaction_id.nil? && @transaction_id.to_s.length < 0
    invalid_properties.push('invalid value for "transaction_id", the character length must be great than or equal to 0.')
  end

  if !@transaction_record_id.nil? && @transaction_record_id.to_s.length > 36
    invalid_properties.push('invalid value for "transaction_record_id", the character length must be smaller than or equal to 36.')
  end

  if !@transaction_record_id.nil? && @transaction_record_id.to_s.length < 0
    invalid_properties.push('invalid value for "transaction_record_id", the character length must be great than or equal to 0.')
  end

  if !@status.nil? && @status.to_s.length > 25
    invalid_properties.push('invalid value for "status", the character length must be smaller than or equal to 25.')
  end

  if !@status.nil? && @status.to_s.length < 0
    invalid_properties.push('invalid value for "status", the character length must be great than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

:nocov: to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



297
298
299
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 297

def to_body
  to_hash
end

#to_hash ⇒ Hash

:nocov: Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 305

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

:nocov: Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



289
290
291
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 289

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
136
137
138
139
140
 
# File 'lib/trulioo_sdk/models/transaction_status.rb', line 132

def valid?
  return false if !@transaction_id.nil? && @transaction_id.to_s.length > 36
  return false if !@transaction_id.nil? && @transaction_id.to_s.length < 0
  return false if !@transaction_record_id.nil? && @transaction_record_id.to_s.length > 36
  return false if !@transaction_record_id.nil? && @transaction_record_id.to_s.length < 0
  return false if !@status.nil? && @status.to_s.length > 25
  return false if !@status.nil? && @status.to_s.length < 0
  true
end