Class: ThePlaidApi::TransferOriginatorCreateResponse

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

Overview

Defines the response schema for ‘/transfer/originator/create`

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(originator_client_id:, company_name:, request_id:, additional_properties: nil) ⇒ TransferOriginatorCreateResponse

Returns a new instance of TransferOriginatorCreateResponse.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/the_plaid_api/models/transfer_originator_create_response.rb', line 46

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

  @originator_client_id = originator_client_id
  @company_name = company_name
  @request_id = request_id
  @additional_properties = additional_properties
end

Instance Attribute Details

#company_name ⇒ String

The company name of the end customer.

Returns:

  • (String) 


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

def company_name
  @company_name
end

#originator_client_id ⇒ String

Client ID of the originator. This identifier will be used when creating transfers and should be stored associated with end user information.

Returns:

  • (String) 


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

def originator_client_id
  @originator_client_id
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) 


25
26
27
 
# File 'lib/the_plaid_api/models/transfer_originator_create_response.rb', line 25

def request_id
  @request_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/the_plaid_api/models/transfer_originator_create_response.rb', line 58

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  originator_client_id =
    hash.key?('originator_client_id') ? hash['originator_client_id'] : nil
  company_name = hash.key?('company_name') ? hash['company_name'] : nil
  request_id = hash.key?('request_id') ? hash['request_id'] : nil

  # 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.
  TransferOriginatorCreateResponse.new(originator_client_id: originator_client_id,
                                       company_name: company_name,
                                       request_id: request_id,
                                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



28
29
30
31
32
33
34
 
# File 'lib/the_plaid_api/models/transfer_originator_create_response.rb', line 28

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

.nullables ⇒ Object

An array for nullable fields



42
43
44
 
# File 'lib/the_plaid_api/models/transfer_originator_create_response.rb', line 42

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



37
38
39
 
# File 'lib/the_plaid_api/models/transfer_originator_create_response.rb', line 37

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



90
91
92
93
94
95
 
# File 'lib/the_plaid_api/models/transfer_originator_create_response.rb', line 90

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



82
83
84
85
86
87
 
# File 'lib/the_plaid_api/models/transfer_originator_create_response.rb', line 82

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