Class: ThePlaidApi::TransferAuthorizationUserInRequest

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

Overview

The legal name and other information for the account holder. If the account has multiple account holders, provide the information for the account holder on whose behalf the authorization is being requested. The ‘user.legal_name` field is required. Other fields are not currently used and are present to support planned future functionality.

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(legal_name:, phone_number: SKIP, email_address: SKIP, address: SKIP, additional_properties: nil) ⇒ TransferAuthorizationUserInRequest

Returns a new instance of TransferAuthorizationUserInRequest.



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

def initialize(legal_name:, phone_number: SKIP, email_address: SKIP,
               address: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @legal_name = legal_name
  @phone_number = phone_number unless phone_number == SKIP
  @email_address = email_address unless email_address == SKIP
  @address = address unless address == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#address ⇒ TransferUserAddressInRequest

The address associated with the account holder.

Returns:



31
32
33
 
# File 'lib/the_plaid_api/models/transfer_authorization_user_in_request.rb', line 31

def address
  @address
end

#email_address ⇒ String

The user’s email address.

Returns:

  • (String) 


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

def email_address
  @email_address
end

#legal_name ⇒ String

The user’s legal name. If the user is a business, provide the business name.

Returns:

  • (String) 


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

def legal_name
  @legal_name
end

#phone_number ⇒ String

The user’s phone number.

Returns:

  • (String) 


23
24
25
 
# File 'lib/the_plaid_api/models/transfer_authorization_user_in_request.rb', line 23

def phone_number
  @phone_number
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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/transfer_authorization_user_in_request.rb', line 70

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  legal_name = hash.key?('legal_name') ? hash['legal_name'] : nil
  phone_number = hash.key?('phone_number') ? hash['phone_number'] : SKIP
  email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
  address = TransferUserAddressInRequest.from_hash(hash['address']) if hash['address']

  # 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.
  TransferAuthorizationUserInRequest.new(legal_name: legal_name,
                                         phone_number: phone_number,
                                         email_address: email_address,
                                         address: address,
                                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['legal_name'] = 'legal_name'
  @_hash['phone_number'] = 'phone_number'
  @_hash['email_address'] = 'email_address'
  @_hash['address'] = 'address'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



53
54
55
 
# File 'lib/the_plaid_api/models/transfer_authorization_user_in_request.rb', line 53

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    phone_number
    email_address
    address
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



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

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} legal_name: #{@legal_name.inspect}, phone_number: #{@phone_number.inspect},"\
  " email_address: #{@email_address.inspect}, address: #{@address.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



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

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} legal_name: #{@legal_name}, phone_number: #{@phone_number}, email_address:"\
  " #{@email_address}, address: #{@address}, additional_properties:"\
  " #{@additional_properties}>"
end