Class: ThePlaidApi::CreditRelayCreateResponse

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

Overview

CreditRelayCreateResponse defines the response schema for ‘/credit/relay/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(relay_token:, request_id:, additional_properties: nil) ⇒ CreditRelayCreateResponse

Returns a new instance of CreditRelayCreateResponse.



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

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

  @relay_token = relay_token
  @request_id = request_id
  @additional_properties = additional_properties
end

Instance Attribute Details

#relay_token ⇒ String

A token that can be shared with a third party to allow them to access the Asset Report. This token should be stored securely.

Returns:

  • (String) 


16
17
18
 
# File 'lib/the_plaid_api/models/credit_relay_create_response.rb', line 16

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


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

def request_id
  @request_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/the_plaid_api/models/credit_relay_create_response.rb', line 52

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  relay_token = hash.key?('relay_token') ? hash['relay_token'] : 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.
  CreditRelayCreateResponse.new(relay_token: relay_token,
                                request_id: request_id,
                                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



38
39
40
 
# File 'lib/the_plaid_api/models/credit_relay_create_response.rb', line 38

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



33
34
35
 
# File 'lib/the_plaid_api/models/credit_relay_create_response.rb', line 33

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



80
81
82
83
84
 
# File 'lib/the_plaid_api/models/credit_relay_create_response.rb', line 80

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



73
74
75
76
77
 
# File 'lib/the_plaid_api/models/credit_relay_create_response.rb', line 73

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