Class: ThePlaidApi::InstitutionsSearchPaymentInitiationOptions

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

Overview

Additional options that will be used to filter institutions by various Payment Initiation configurations.

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(payment_id: SKIP, consent_id: SKIP, additional_properties: nil) ⇒ InstitutionsSearchPaymentInitiationOptions

Returns a new instance of InstitutionsSearchPaymentInitiationOptions.



45
46
47
48
49
50
51
52
53
 
# File 'lib/the_plaid_api/models/institutions_search_payment_initiation_options.rb', line 45

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

  @payment_id = payment_id unless payment_id == SKIP
  @consent_id = consent_id unless consent_id == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

A unique ID identifying the payment consent

Returns:

  • (String) 


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

def consent_id
  @consent_id
end

#payment_id ⇒ String

A unique ID identifying the payment

Returns:

  • (String) 


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

def payment_id
  @payment_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/the_plaid_api/models/institutions_search_payment_initiation_options.rb', line 56

def self.from_hash(hash)
  return nil unless hash

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

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/the_plaid_api/models/institutions_search_payment_initiation_options.rb', line 22

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

.nullables ⇒ Object

An array for nullable fields



38
39
40
41
42
43
 
# File 'lib/the_plaid_api/models/institutions_search_payment_initiation_options.rb', line 38

def self.nullables
  %w[
    payment_id
    consent_id
  ]
end

.optionals ⇒ Object

An array for optional fields



30
31
32
33
34
35
 
# File 'lib/the_plaid_api/models/institutions_search_payment_initiation_options.rb', line 30

def self.optionals
  %w[
    payment_id
    consent_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



84
85
86
87
88
 
# File 'lib/the_plaid_api/models/institutions_search_payment_initiation_options.rb', line 84

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



77
78
79
80
81
 
# File 'lib/the_plaid_api/models/institutions_search_payment_initiation_options.rb', line 77

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