Class: Plaid::CraIncomeInsights

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

Overview

The Check Income Insights Report for an end user.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CraIncomeInsights

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/plaid/models/cra_income_insights.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CraIncomeInsights` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::CraIncomeInsights`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'report_id')
    self.report_id = attributes[:'report_id']
  end

  if attributes.key?(:'generated_time')
    self.generated_time = attributes[:'generated_time']
  end

  if attributes.key?(:'days_requested')
    self.days_requested = attributes[:'days_requested']
  end

  if attributes.key?(:'client_report_id')
    self.client_report_id = attributes[:'client_report_id']
  end

  if attributes.key?(:'items')
    if (value = attributes[:'items']).is_a?(Array)
      self.items = value
    end
  end

  if attributes.key?(:'bank_income_summary')
    self.bank_income_summary = attributes[:'bank_income_summary']
  end

  if attributes.key?(:'warnings')
    if (value = attributes[:'warnings']).is_a?(Array)
      self.warnings = value
    end
  end
end

Instance Attribute Details

#bank_income_summary ⇒ Object

Returns the value of attribute bank_income_summary.



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

def bank_income_summary
  @bank_income_summary
end

#client_report_id ⇒ Object

Client-generated identifier, which can be used by lenders to track loan applications.



29
30
31
 
# File 'lib/plaid/models/cra_income_insights.rb', line 29

def client_report_id
  @client_report_id
end

#days_requested ⇒ Object

The number of days requested by the customer for the Check Income Insights Report.



26
27
28
 
# File 'lib/plaid/models/cra_income_insights.rb', line 26

def days_requested
  @days_requested
end

#generated_time ⇒ Object

The time when the Check Income Insights Report was generated.



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

def generated_time
  @generated_time
end

#items ⇒ Object

The list of Items in the report along with the associated metadata about the Item.



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

def items
  @items
end

#report_id ⇒ Object

The unique identifier associated with the Check Income Insights Report.



20
21
22
 
# File 'lib/plaid/models/cra_income_insights.rb', line 20

def report_id
  @report_id
end

#warnings ⇒ Object

If data from the report was unable to be retrieved, the warnings object will contain information about the error that caused the data to be incomplete.



37
38
39
 
# File 'lib/plaid/models/cra_income_insights.rb', line 37

def warnings
  @warnings
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/plaid/models/cra_income_insights.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/plaid/models/cra_income_insights.rb', line 40

def self.attribute_map
  {
    :'report_id' => :'report_id',
    :'generated_time' => :'generated_time',
    :'days_requested' => :'days_requested',
    :'client_report_id' => :'client_report_id',
    :'items' => :'items',
    :'bank_income_summary' => :'bank_income_summary',
    :'warnings' => :'warnings'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



167
168
169
 
# File 'lib/plaid/models/cra_income_insights.rb', line 167

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
75
 
# File 'lib/plaid/models/cra_income_insights.rb', line 71

def self.openapi_nullable
  Set.new([
    :'client_report_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'report_id' => :'String',
    :'generated_time' => :'Time',
    :'days_requested' => :'Integer',
    :'client_report_id' => :'String',
    :'items' => :'Array<CraBankIncomeItem>',
    :'bank_income_summary' => :'CraBankIncomeSummary',
    :'warnings' => :'Array<CraBankIncomeWarning>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/plaid/models/cra_income_insights.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      report_id == o.report_id &&
      generated_time == o.generated_time &&
      days_requested == o.days_requested &&
      client_report_id == o.client_report_id &&
      items == o.items &&
      bank_income_summary == o.bank_income_summary &&
      warnings == o.warnings
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/plaid/models/cra_income_insights.rb', line 198

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/plaid/models/cra_income_insights.rb', line 269

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/plaid/models/cra_income_insights.rb', line 174

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


154
155
156
 
# File 'lib/plaid/models/cra_income_insights.rb', line 154

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



160
161
162
 
# File 'lib/plaid/models/cra_income_insights.rb', line 160

def hash
  [report_id, generated_time, days_requested, client_report_id, items, bank_income_summary, warnings].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



127
128
129
130
 
# File 'lib/plaid/models/cra_income_insights.rb', line 127

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
 
# File 'lib/plaid/models/cra_income_insights.rb', line 245

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/plaid/models/cra_income_insights.rb', line 251

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



239
240
241
 
# File 'lib/plaid/models/cra_income_insights.rb', line 239

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



134
135
136
 
# File 'lib/plaid/models/cra_income_insights.rb', line 134

def valid?
  true
end