Class: Plaid::IncomeVerificationRefreshResponse

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

Overview

IncomeVerificationRequestResponse defines the response schema for ‘/income/verification/refresh`

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(request_id:, verification_refresh_status:, additional_properties: nil) ⇒ IncomeVerificationRefreshResponse

Returns a new instance of IncomeVerificationRefreshResponse.



43
44
45
46
47
48
49
50
51
 
# File 'lib/plaid/models/income_verification_refresh_response.rb', line 43

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

  @request_id = request_id
  @verification_refresh_status = verification_refresh_status
  @additional_properties = additional_properties
end

Instance Attribute Details

#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) 


17
18
19
 
# File 'lib/plaid/models/income_verification_refresh_response.rb', line 17

def request_id
  @request_id
end

#verification_refresh_status ⇒ String

The verification refresh status. One of the following: ‘“VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED”` User presence is required to refresh an income verification.

Returns:

  • (String) 


23
24
25
 
# File 'lib/plaid/models/income_verification_refresh_response.rb', line 23

def verification_refresh_status
  @verification_refresh_status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/plaid/models/income_verification_refresh_response.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  request_id = hash.key?('request_id') ? hash['request_id'] : nil
  verification_refresh_status =
    hash.key?('verification_refresh_status') ? hash['verification_refresh_status'] : 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.
  IncomeVerificationRefreshResponse.new(request_id: request_id,
                                        verification_refresh_status: verification_refresh_status,
                                        additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



26
27
28
29
30
31
 
# File 'lib/plaid/models/income_verification_refresh_response.rb', line 26

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

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/plaid/models/income_verification_refresh_response.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
 
# File 'lib/plaid/models/income_verification_refresh_response.rb', line 34

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



83
84
85
86
87
88
 
# File 'lib/plaid/models/income_verification_refresh_response.rb', line 83

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



76
77
78
79
80
 
# File 'lib/plaid/models/income_verification_refresh_response.rb', line 76

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