Class: ThePlaidApi::TaxpayerId

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

Overview

Taxpayer ID of the individual receiving the paystub.

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(id_type: SKIP, id_mask: SKIP, last_4_digits: SKIP, additional_properties: nil) ⇒ TaxpayerId

Returns a new instance of TaxpayerId.



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

def initialize(id_type: SKIP, id_mask: SKIP, last_4_digits: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @id_type = id_type unless id_type == SKIP
  @id_mask = id_mask unless id_mask == SKIP
  @last_4_digits = last_4_digits unless last_4_digits == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#id_mask ⇒ String

ID mask; i.e. last 4 digits of the taxpayer ID

Returns:

  • (String) 


18
19
20
 
# File 'lib/the_plaid_api/models/taxpayer_id.rb', line 18

def id_mask
  @id_mask
end

#id_type ⇒ String

Type of ID, e.g. ‘SSN’

Returns:

  • (String) 


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

def id_type
  @id_type
end

#last_4_digits ⇒ String

Last 4 digits of unique number of ID.

Returns:

  • (String) 


22
23
24
 
# File 'lib/the_plaid_api/models/taxpayer_id.rb', line 22

def last_4_digits
  @last_4_digits
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
 
# File 'lib/the_plaid_api/models/taxpayer_id.rb', line 63

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id_type = hash.key?('id_type') ? hash['id_type'] : SKIP
  id_mask = hash.key?('id_mask') ? hash['id_mask'] : SKIP
  last_4_digits = hash.key?('last_4_digits') ? hash['last_4_digits'] : 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.
  TaxpayerId.new(id_type: id_type,
                 id_mask: id_mask,
                 last_4_digits: last_4_digits,
                 additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/the_plaid_api/models/taxpayer_id.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id_type'] = 'id_type'
  @_hash['id_mask'] = 'id_mask'
  @_hash['last_4_digits'] = 'last_4_digits'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  %w[
    id_type
    id_mask
    last_4_digits
  ]
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/the_plaid_api/models/taxpayer_id.rb', line 34

def self.optionals
  %w[
    id_type
    id_mask
    last_4_digits
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



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

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



86
87
88
89
90
 
# File 'lib/the_plaid_api/models/taxpayer_id.rb', line 86

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