Class: ThePlaidApi::CraCheckReportPartnerInsightsGetResponse

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

Overview

CraPartnerInsightsGetResponse defines the response schema for ‘/cra/partner_insights/get`.

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:, report: SKIP, warnings: SKIP, additional_properties: nil) ⇒ CraCheckReportPartnerInsightsGetResponse

Returns a new instance of CraCheckReportPartnerInsightsGetResponse.



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/the_plaid_api/models/cra_check_report_partner_insights_get_response.rb', line 51

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

  @report = report unless report == SKIP
  @request_id = request_id
  @warnings = warnings unless warnings == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#report ⇒ CraPartnerInsights

The Partner Insights report of the bank data for an end user.

Returns:



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

def report
  @report
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/the_plaid_api/models/cra_check_report_partner_insights_get_response.rb', line 21

def request_id
  @request_id
end

#warnings ⇒ Array[CraReportWarning]

If the Partner Insights generation was successful but a subset of data could not be retrieved, this array will contain information about the errors causing information to be missing

Returns:



27
28
29
 
# File 'lib/the_plaid_api/models/cra_check_report_partner_insights_get_response.rb', line 27

def warnings
  @warnings
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



63
64
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
 
# File 'lib/the_plaid_api/models/cra_check_report_partner_insights_get_response.rb', line 63

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  request_id = hash.key?('request_id') ? hash['request_id'] : nil
  report = CraPartnerInsights.from_hash(hash['report']) if hash['report']
  # Parameter is an array, so we need to iterate through it
  warnings = nil
  unless hash['warnings'].nil?
    warnings = []
    hash['warnings'].each do |structure|
      warnings << (CraReportWarning.from_hash(structure) if structure)
    end
  end

  warnings = SKIP unless hash.key?('warnings')

  # 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.
  CraCheckReportPartnerInsightsGetResponse.new(request_id: request_id,
                                               report: report,
                                               warnings: warnings,
                                               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



30
31
32
33
34
35
36
 
# File 'lib/the_plaid_api/models/cra_check_report_partner_insights_get_response.rb', line 30

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

.nullables ⇒ Object

An array for nullable fields



47
48
49
 
# File 'lib/the_plaid_api/models/cra_check_report_partner_insights_get_response.rb', line 47

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
 
# File 'lib/the_plaid_api/models/cra_check_report_partner_insights_get_response.rb', line 39

def self.optionals
  %w[
    report
    warnings
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



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

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

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