Class: ThePlaidApi::TransferRecurringCreateResponse

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

Overview

Defines the response schema for ‘/transfer/recurring/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(decision:, request_id:, recurring_transfer: SKIP, decision_rationale: SKIP, additional_properties: nil) ⇒ TransferRecurringCreateResponse

Returns a new instance of TransferRecurringCreateResponse.



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 75

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

  @recurring_transfer = recurring_transfer unless recurring_transfer == SKIP
  @decision = decision
  @decision_rationale = decision_rationale unless decision_rationale == SKIP
  @request_id = request_id
  @additional_properties = additional_properties
end

Instance Attribute Details

#decision ⇒ TransferAuthorizationDecision

A decision regarding the proposed transfer. ‘approved` – The proposed transfer has received the end user’s consent and has been approved for processing by Plaid. The ‘decision_rationale` field is set if Plaid was unable to fetch the account information. You may proceed with the transfer, but further review is recommended. Refer to the `code` field in the `decision_rationale` object for details. `declined` – Plaid reviewed the proposed transfer and declined processing. Refer to the `code` field in the `decision_rationale` object for details. `user_action_required` – An action is required before Plaid can assess the transfer risk and make a decision. The most common scenario is to update authentication for an Item. To complete the required action, initialize Link by setting `transfer.authorization_id` in the request of `/link/token/create`. After Link flow is completed, you may re-attempt the authorization request. For `guarantee` requests, `approved` indicates the transfer is eligible for Plaid’s guarantee, and ‘declined` indicates Plaid will not provide guarantee coverage for the transfer. `user_action_required` indicates you should follow the above guidance before re-attempting.

Returns:



35
36
37
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 35

def decision
  @decision
end

#decision_rationale ⇒ TransferAuthorizationDecisionRationale

The rationale for Plaid’s decision regarding a proposed transfer. It is always set for ‘declined` decisions, and may or may not be null for `approved` decisions.

Returns:



41
42
43
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 41

def decision_rationale
  @decision_rationale
end

#recurring_transfer ⇒ RecurringTransferNullable

Represents a recurring transfer within the Transfers API.

Returns:



14
15
16
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 14

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


47
48
49
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 47

def request_id
  @request_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 88

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  decision = hash.key?('decision') ? hash['decision'] : nil
  request_id = hash.key?('request_id') ? hash['request_id'] : nil
  recurring_transfer = RecurringTransferNullable.from_hash(hash['recurring_transfer']) if
    hash['recurring_transfer']
  if hash['decision_rationale']
    decision_rationale = TransferAuthorizationDecisionRationale.from_hash(hash['decision_rationale'])
  end

  # 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.
  TransferRecurringCreateResponse.new(decision: decision,
                                      request_id: request_id,
                                      recurring_transfer: recurring_transfer,
                                      decision_rationale: decision_rationale,
                                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



50
51
52
53
54
55
56
57
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 50

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

.nullables ⇒ Object

An array for nullable fields



68
69
70
71
72
73
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 68

def self.nullables
  %w[
    recurring_transfer
    decision_rationale
  ]
end

.optionals ⇒ Object

An array for optional fields



60
61
62
63
64
65
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 60

def self.optionals
  %w[
    recurring_transfer
    decision_rationale
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



124
125
126
127
128
129
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 124

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



116
117
118
119
120
121
 
# File 'lib/the_plaid_api/models/transfer_recurring_create_response.rb', line 116

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