Class: ThePlaidApi::TransferPlatformRequirementSubmitRequest

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

Overview

Defines the request schema for ‘/transfer/platform/requirement/submit`

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:, requirement_submissions:, client_id: SKIP, secret: SKIP, additional_properties: nil) ⇒ TransferPlatformRequirementSubmitRequest

Returns a new instance of TransferPlatformRequirementSubmitRequest.



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

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

  @client_id = client_id unless client_id == SKIP
  @secret = secret unless secret == SKIP
  @originator_client_id = originator_client_id
  @requirement_submissions = requirement_submissions
  @additional_properties = additional_properties
end

Instance Attribute Details

#client_id ⇒ String

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

Returns:

  • (String) 


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

def client_id
  @client_id
end

#originator_client_id ⇒ String

The client ID of the originator

Returns:

  • (String) 


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

def originator_client_id
  @originator_client_id
end

#requirement_submissions ⇒ Array[RequirementSubmission]

Use the ‘/transfer/platform/requirement/submit` endpoint to submit a list of requirement submissions that all relate to the originator. Must contain between 1 and 50 requirement submissions. See [Requirement type schema documentation](docs.google.com/document/d/1NEQkTD0sVK50iAQi6xHigre xDUxZ4QxXqSEfV_FFTiU/) for a list of requirements and possible values.

Returns:



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

def requirement_submissions
  @requirement_submissions
end

#secret ⇒ String

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:

  • (String) 


21
22
23
 
# File 'lib/the_plaid_api/models/transfer_platform_requirement_submit_request.rb', line 21

def secret
  @secret
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/the_plaid_api/models/transfer_platform_requirement_submit_request.rb', line 71

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
  # Parameter is an array, so we need to iterate through it
  requirement_submissions = nil
  unless hash['requirement_submissions'].nil?
    requirement_submissions = []
    hash['requirement_submissions'].each do |structure|
      requirement_submissions << (RequirementSubmission.from_hash(structure) if structure)
    end
  end

  requirement_submissions = nil unless hash.key?('requirement_submissions')
  client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
  secret = hash.key?('secret') ? hash['secret'] : 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.
  TransferPlatformRequirementSubmitRequest.new(originator_client_id: originator_client_id,
                                               requirement_submissions: requirement_submissions,
                                               client_id: client_id,
                                               secret: secret,
                                               additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_id'] = 'client_id'
  @_hash['secret'] = 'secret'
  @_hash['originator_client_id'] = 'originator_client_id'
  @_hash['requirement_submissions'] = 'requirement_submissions'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



54
55
56
 
# File 'lib/the_plaid_api/models/transfer_platform_requirement_submit_request.rb', line 54

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



46
47
48
49
50
51
 
# File 'lib/the_plaid_api/models/transfer_platform_requirement_submit_request.rb', line 46

def self.optionals
  %w[
    client_id
    secret
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



114
115
116
117
118
119
 
# File 'lib/the_plaid_api/models/transfer_platform_requirement_submit_request.rb', line 114

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



106
107
108
109
110
111
 
# File 'lib/the_plaid_api/models/transfer_platform_requirement_submit_request.rb', line 106

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