Class: Plaid::IncomeVerificationPrecheckResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/plaid/models/income_verification_precheck_response.rb

Overview

IncomeVerificationPrecheckResponse defines the response schema for ‘/income/verification/precheck`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(precheck_id:, request_id:, confidence:, additional_properties: nil) ⇒ IncomeVerificationPrecheckResponse

Returns a new instance of IncomeVerificationPrecheckResponse.



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 53

def initialize(precheck_id:, request_id:, confidence:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @precheck_id = precheck_id
  @request_id = request_id
  @confidence = confidence
  @additional_properties = additional_properties
end

Instance Attribute Details

#confidence ⇒ Confidence

The confidence that Plaid can support the user in the income verification flow. One of the following: ‘“HIGH”`: This precheck information submitted is definitively tied to a Plaid-supported integration. “`LOW`”: This precheck information submitted is known not to be supported by Plaid. `“UNKNOWN”`: It was not possible to determine if the user is supportable with the information passed.

Returns:



32
33
34
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 32

def confidence
  @confidence
end

#precheck_id ⇒ String

ID of the precheck.

Returns:

  • (String) 


15
16
17
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 15

def precheck_id
  @precheck_id
end

#request_id ⇒ String

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Returns:

  • (String) 


21
22
23
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 21

def request_id
  @request_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 65

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  precheck_id = hash.key?('precheck_id') ? hash['precheck_id'] : nil
  request_id = hash.key?('request_id') ? hash['request_id'] : nil
  confidence = hash.key?('confidence') ? hash['confidence'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  IncomeVerificationPrecheckResponse.new(precheck_id: precheck_id,
                                         request_id: request_id,
                                         confidence: confidence,
                                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



35
36
37
38
39
40
41
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 35

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['precheck_id'] = 'precheck_id'
  @_hash['request_id'] = 'request_id'
  @_hash['confidence'] = 'confidence'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



44
45
46
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 44

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



95
96
97
98
99
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 95

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} precheck_id: #{@precheck_id.inspect}, request_id: #{@request_id.inspect},"\
  " confidence: #{@confidence.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



88
89
90
91
92
 
# File 'lib/plaid/models/income_verification_precheck_response.rb', line 88

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} precheck_id: #{@precheck_id}, request_id: #{@request_id}, confidence:"\
  " #{@confidence}, additional_properties: #{@additional_properties}>"
end