Class: ThePlaidApi::LinkDeliveryOptions

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

Overview

Optional metadata related to the Hosted Link session

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(recipient: SKIP, additional_properties: nil) ⇒ LinkDeliveryOptions

Returns a new instance of LinkDeliveryOptions.



36
37
38
39
40
41
42
 
# File 'lib/the_plaid_api/models/link_delivery_options.rb', line 36

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

  @recipient = recipient unless recipient == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#recipient ⇒ LinkDeliveryRecipient

Metadata related to the recipient. If the information required to populate this field is not available, leave it blank.

Returns:



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

def recipient
  @recipient
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/the_plaid_api/models/link_delivery_options.rb', line 45

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  recipient = LinkDeliveryRecipient.from_hash(hash['recipient']) if hash['recipient']

  # 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.
  LinkDeliveryOptions.new(recipient: recipient,
                          additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
 
# File 'lib/the_plaid_api/models/link_delivery_options.rb', line 18

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

.nullables ⇒ Object

An array for nullable fields



32
33
34
 
# File 'lib/the_plaid_api/models/link_delivery_options.rb', line 32

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    recipient
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



71
72
73
74
75
 
# File 'lib/the_plaid_api/models/link_delivery_options.rb', line 71

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



64
65
66
67
68
 
# File 'lib/the_plaid_api/models/link_delivery_options.rb', line 64

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