class Plaid::ProcessorSignalDecisionReportRequest

ProcessorSignalDecisionReportRequest defines the request schema for ‘/processor/signal/decision/report`

Attributes

amount_instantly_available[RW]

The amount (in USD) made available to your customers instantly following the debit transaction. It could be a partial amount of the requested transaction (example: 102.05).

client_id[RW]

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.

client_transaction_id[RW]

Must be the same as the ‘client_transaction_id` supplied when calling `/signal/evaluate`

days_funds_on_hold[RW]

The actual number of days (hold time) since the ACH debit transaction that you wait before making funds available to your customers. The holding time could affect the ACH return rate. For example, use 0 if you make funds available to your customers instantly or the same day following the debit transaction, or 1 if you make funds available the next day following the debit initialization.

decision_outcome[RW]
initiated[RW]

‘true` if the ACH transaction was initiated, `false` otherwise. This field must be returned as a boolean. If formatted incorrectly, this will result in an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error.

payment_method[RW]
processor_token[RW]

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: ‘processor-<environment>-<identifier>`

secret[RW]

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.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 82
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 67
def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'processor_token' => :'processor_token',
    :'client_transaction_id' => :'client_transaction_id',
    :'initiated' => :'initiated',
    :'days_funds_on_hold' => :'days_funds_on_hold',
    :'decision_outcome' => :'decision_outcome',
    :'payment_method' => :'payment_method',
    :'amount_instantly_available' => :'amount_instantly_available'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 269
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 113
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::ProcessorSignalDecisionReportRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::ProcessorSignalDecisionReportRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.key?(:'secret')
    self.secret = attributes[:'secret']
  end

  if attributes.key?(:'processor_token')
    self.processor_token = attributes[:'processor_token']
  end

  if attributes.key?(:'client_transaction_id')
    self.client_transaction_id = attributes[:'client_transaction_id']
  end

  if attributes.key?(:'initiated')
    self.initiated = attributes[:'initiated']
  end

  if attributes.key?(:'days_funds_on_hold')
    self.days_funds_on_hold = attributes[:'days_funds_on_hold']
  end

  if attributes.key?(:'decision_outcome')
    self.decision_outcome = attributes[:'decision_outcome']
  end

  if attributes.key?(:'payment_method')
    self.payment_method = attributes[:'payment_method']
  end

  if attributes.key?(:'amount_instantly_available')
    self.amount_instantly_available = attributes[:'amount_instantly_available']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 102
def self.openapi_nullable
  Set.new([
    :'days_funds_on_hold',
    :'decision_outcome',
    :'payment_method',
    :'amount_instantly_available'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 87
def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'processor_token' => :'String',
    :'client_transaction_id' => :'String',
    :'initiated' => :'Boolean',
    :'days_funds_on_hold' => :'Integer',
    :'decision_outcome' => :'SignalDecisionOutcome',
    :'payment_method' => :'SignalPaymentMethod',
    :'amount_instantly_available' => :'Float'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 240
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      processor_token == o.processor_token &&
      client_transaction_id == o.client_transaction_id &&
      initiated == o.initiated &&
      days_funds_on_hold == o.days_funds_on_hold &&
      decision_outcome == o.decision_outcome &&
      payment_method == o.payment_method &&
      amount_instantly_available == o.amount_instantly_available
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 300
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 371
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 276
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end
client_transaction_id=(client_transaction_id) click to toggle source

Custom attribute writer method with validation @param [Object] client_transaction_id Value to be assigned

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 210
def client_transaction_id=(client_transaction_id)
  if client_transaction_id.nil?
    fail ArgumentError, 'client_transaction_id cannot be nil'
  end

  if client_transaction_id.to_s.length > 36
    fail ArgumentError, 'invalid value for "client_transaction_id", the character length must be smaller than or equal to 36.'
  end

  if client_transaction_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "client_transaction_id", the character length must be great than or equal to 1.'
  end


  @client_transaction_id = client_transaction_id
end
days_funds_on_hold=(days_funds_on_hold) click to toggle source

Custom attribute writer method with validation @param [Object] days_funds_on_hold Value to be assigned

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 229
def days_funds_on_hold=(days_funds_on_hold)
  if !days_funds_on_hold.nil? && days_funds_on_hold < 0
    fail ArgumentError, 'invalid value for "days_funds_on_hold", must be greater than or equal to 0.'
  end


  @days_funds_on_hold = days_funds_on_hold
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 256
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 262
def hash
  [client_id, secret, processor_token, client_transaction_id, initiated, days_funds_on_hold, decision_outcome, payment_method, amount_instantly_available].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 165
def list_invalid_properties
  invalid_properties = Array.new
  if @processor_token.nil?
    invalid_properties.push('invalid value for "processor_token", processor_token cannot be nil.')
  end

  if @client_transaction_id.nil?
    invalid_properties.push('invalid value for "client_transaction_id", client_transaction_id cannot be nil.')
  end

  if @client_transaction_id.to_s.length > 36
    invalid_properties.push('invalid value for "client_transaction_id", the character length must be smaller than or equal to 36.')
  end

  if @client_transaction_id.to_s.length < 1
    invalid_properties.push('invalid value for "client_transaction_id", the character length must be great than or equal to 1.')
  end


  if @initiated.nil?
    invalid_properties.push('invalid value for "initiated", initiated cannot be nil.')
  end

  if !@days_funds_on_hold.nil? && @days_funds_on_hold < 0
    invalid_properties.push('invalid value for "days_funds_on_hold", must be greater than or equal to 0.')
  end


  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 347
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 353
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 341
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/plaid/models/processor_signal_decision_report_request.rb, line 198
def valid?
  return false if @processor_token.nil?
  return false if @client_transaction_id.nil?
  return false if @client_transaction_id.to_s.length > 36
  return false if @client_transaction_id.to_s.length < 1
  return false if @initiated.nil?
  return false if !@days_funds_on_hold.nil? && @days_funds_on_hold < 0
  true
end