Class: ThePlaidApi::CraPartnerInsightsUltraFicoScoreResult

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb

Overview

The result of a single UltraFICO score generation request.

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_correlation_id: SKIP, fico_scoring_request_id: SKIP, ultrafico_score: SKIP, error_reason: SKIP, additional_properties: nil) ⇒ CraPartnerInsightsUltraFicoScoreResult

Returns a new instance of CraPartnerInsightsUltraFicoScoreResult.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 58

def initialize(request_correlation_id: SKIP, fico_scoring_request_id: SKIP,
               ultrafico_score: SKIP, error_reason: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @request_correlation_id = request_correlation_id unless request_correlation_id == SKIP
  @fico_scoring_request_id = fico_scoring_request_id unless fico_scoring_request_id == SKIP
  @ultrafico_score = ultrafico_score unless ultrafico_score == SKIP
  @error_reason = error_reason unless error_reason == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#error_reason ⇒ String

Human-readable description of why the UltraFICO score could not be computed.

Returns:

  • (String) 


29
30
31
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 29

def error_reason
  @error_reason
end

#fico_scoring_request_id ⇒ String

FICO-provided identifier that uniquely identifies this score generation request.

Returns:

  • (String) 


20
21
22
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 20

def fico_scoring_request_id
  @fico_scoring_request_id
end

#request_correlation_id ⇒ String

Client-generated identifier that can be used to correlate between scoring requests and scoring results.

Returns:

  • (String) 


15
16
17
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 15

def request_correlation_id
  @request_correlation_id
end

#ultrafico_score ⇒ CraPartnerInsightsUltraFicoScore

The calculated UltraFICO score.

Returns:



24
25
26
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 24

def ultrafico_score
  @ultrafico_score
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 72

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  request_correlation_id =
    hash.key?('request_correlation_id') ? hash['request_correlation_id'] : SKIP
  fico_scoring_request_id =
    hash.key?('fico_scoring_request_id') ? hash['fico_scoring_request_id'] : SKIP
  ultrafico_score = CraPartnerInsightsUltraFicoScore.from_hash(hash['ultrafico_score']) if
    hash['ultrafico_score']
  error_reason = hash.key?('error_reason') ? hash['error_reason'] : SKIP

  # 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.
  CraPartnerInsightsUltraFicoScoreResult.new(request_correlation_id: request_correlation_id,
                                             fico_scoring_request_id: fico_scoring_request_id,
                                             ultrafico_score: ultrafico_score,
                                             error_reason: error_reason,
                                             additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



32
33
34
35
36
37
38
39
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 32

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['request_correlation_id'] = 'request_correlation_id'
  @_hash['fico_scoring_request_id'] = 'fico_scoring_request_id'
  @_hash['ultrafico_score'] = 'ultrafico_score'
  @_hash['error_reason'] = 'error_reason'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



52
53
54
55
56
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 52

def self.nullables
  %w[
    ultrafico_score
  ]
end

.optionals ⇒ Object

An array for optional fields



42
43
44
45
46
47
48
49
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 42

def self.optionals
  %w[
    request_correlation_id
    fico_scoring_request_id
    ultrafico_score
    error_reason
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



109
110
111
112
113
114
115
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 109

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



100
101
102
103
104
105
106
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_result.rb', line 100

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