class Plaid::RecurringTransferSkippedWebhook

Fired when Plaid is unable to originate a new ACH transaction of the recurring transfer on the planned date.

Attributes

authorization_decision[RW]
authorization_decision_rationale_code[RW]
environment[RW]
recurring_transfer_id[RW]

Plaid’s unique identifier for a recurring transfer.

skipped_origination_date[RW]

The planned date on which Plaid is unable to originate a new ACH transaction of the recurring transfer. This will be of the form YYYY-MM-DD.

webhook_code[RW]

‘RECURRING_TRANSFER_SKIPPED`

webhook_type[RW]

‘TRANSFER`

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/recurring_transfer_skipped_webhook.rb, line 73
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/recurring_transfer_skipped_webhook.rb, line 60
def self.attribute_map
  {
    :'webhook_type' => :'webhook_type',
    :'webhook_code' => :'webhook_code',
    :'recurring_transfer_id' => :'recurring_transfer_id',
    :'authorization_decision' => :'authorization_decision',
    :'authorization_decision_rationale_code' => :'authorization_decision_rationale_code',
    :'skipped_origination_date' => :'skipped_origination_date',
    :'environment' => :'environment'
  }
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/recurring_transfer_skipped_webhook.rb, line 212
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/recurring_transfer_skipped_webhook.rb, line 98
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::RecurringTransferSkippedWebhook` 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::RecurringTransferSkippedWebhook`. 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?(:'webhook_type')
    self.webhook_type = attributes[:'webhook_type']
  end

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/plaid/models/recurring_transfer_skipped_webhook.rb, line 91
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/recurring_transfer_skipped_webhook.rb, line 78
def self.openapi_types
  {
    :'webhook_type' => :'String',
    :'webhook_code' => :'String',
    :'recurring_transfer_id' => :'String',
    :'authorization_decision' => :'TransferAuthorizationDecision',
    :'authorization_decision_rationale_code' => :'TransferAuthorizationDecisionRationaleCode',
    :'skipped_origination_date' => :'Date',
    :'environment' => :'WebhookEnvironmentValues'
  }
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/recurring_transfer_skipped_webhook.rb, line 185
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      webhook_type == o.webhook_type &&
      webhook_code == o.webhook_code &&
      recurring_transfer_id == o.recurring_transfer_id &&
      authorization_decision == o.authorization_decision &&
      authorization_decision_rationale_code == o.authorization_decision_rationale_code &&
      skipped_origination_date == o.skipped_origination_date &&
      environment == o.environment
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/recurring_transfer_skipped_webhook.rb, line 243
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/recurring_transfer_skipped_webhook.rb, line 314
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/recurring_transfer_skipped_webhook.rb, line 219
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
eql?(o) click to toggle source

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

# File lib/plaid/models/recurring_transfer_skipped_webhook.rb, line 199
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/recurring_transfer_skipped_webhook.rb, line 205
def hash
  [webhook_type, webhook_code, recurring_transfer_id, authorization_decision, authorization_decision_rationale_code, skipped_origination_date, environment].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/recurring_transfer_skipped_webhook.rb, line 142
def list_invalid_properties
  invalid_properties = Array.new
  if @webhook_type.nil?
    invalid_properties.push('invalid value for "webhook_type", webhook_type cannot be nil.')
  end

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

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

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

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

  if @environment.nil?
    invalid_properties.push('invalid value for "environment", environment cannot be nil.')
  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/recurring_transfer_skipped_webhook.rb, line 290
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/recurring_transfer_skipped_webhook.rb, line 296
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/recurring_transfer_skipped_webhook.rb, line 284
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/recurring_transfer_skipped_webhook.rb, line 173
def valid?
  return false if @webhook_type.nil?
  return false if @webhook_code.nil?
  return false if @recurring_transfer_id.nil?
  return false if @authorization_decision.nil?
  return false if @skipped_origination_date.nil?
  return false if @environment.nil?
  true
end