Class: ThePlaidApi::CraPartnerInsightsUltraFicoScoreRequest

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

Overview

Configuration required to generate a single UltraFICO score.

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(base_fico_score:, fico_scoring_request_id: SKIP, request_correlation_id: SKIP, additional_properties: nil) ⇒ CraPartnerInsightsUltraFicoScoreRequest

Returns a new instance of CraPartnerInsightsUltraFicoScoreRequest.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_request.rb', line 54

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

  @ultrafico_score_version = '1.0'
  @fico_scoring_request_id = fico_scoring_request_id unless fico_scoring_request_id == SKIP
  @request_correlation_id = request_correlation_id unless request_correlation_id == SKIP
  @base_fico_score = base_fico_score
  @additional_properties = additional_properties
end

Instance Attribute Details

#base_fico_score ⇒ CraPartnerInsightsBaseFicoScore

Details about the base FICO score associated with an UltraFICO scoring request.

Returns:



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

def base_fico_score
  @base_fico_score
end

#fico_scoring_request_id ⇒ String

FICO identifier for a particular scoring request. Should only be provided by UltraFICO as part of the FICO-led Flow.

Returns:

  • (String) 


19
20
21
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_request.rb', line 19

def fico_scoring_request_id
  @fico_scoring_request_id
end

#request_correlation_id ⇒ String

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

Returns:

  • (String) 


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

def request_correlation_id
  @request_correlation_id
end

#ultrafico_score_version ⇒ String (readonly)

The version of the UltraFICO score.

Returns:

  • (String) 


14
15
16
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_request.rb', line 14

def ultrafico_score_version
  @ultrafico_score_version
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_request.rb', line 67

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  base_fico_score = CraPartnerInsightsBaseFicoScore.from_hash(hash['base_fico_score']) if
    hash['base_fico_score']
  fico_scoring_request_id =
    hash.key?('fico_scoring_request_id') ? hash['fico_scoring_request_id'] : SKIP
  request_correlation_id =
    hash.key?('request_correlation_id') ? hash['request_correlation_id'] : 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.
  CraPartnerInsightsUltraFicoScoreRequest.new(base_fico_score: base_fico_score,
                                              fico_scoring_request_id: fico_scoring_request_id,
                                              request_correlation_id: request_correlation_id,
                                              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_request.rb', line 32

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

.nullables ⇒ Object

An array for nullable fields



50
51
52
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_request.rb', line 50

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    fico_scoring_request_id
    request_correlation_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



102
103
104
105
106
107
108
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_request.rb', line 102

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



93
94
95
96
97
98
99
 
# File 'lib/the_plaid_api/models/cra_partner_insights_ultra_fico_score_request.rb', line 93

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