class Plaid::IncomeVerificationRiskSignalsStatusWebhook

Fired when risk signals have been processed for documents uploaded via Document Income. It will typically take a minute or two for this webhook to fire after the end user has uploaded their documents in the Document Income flow. Once this webhook has fired, ‘/credit/payroll_income/risk_signals/get` may then be called to determine whether the documents were successfully processed and to retrieve risk data.

Attributes

environment[RW]
item_id[RW]

The Item ID associated with the verification.

risk_signals_status[RW]

‘RISK_SIGNALS_PROCESSING_COMPLETE`: The income verification fraud detection processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the `/credit/payroll_income/risk_signals/get` endpoint to get all risk signal data.

user_id[RW]

The Plaid ‘user_id` of the User associated with this webhook, warning, or error.

webhook_code[RW]

‘INCOME_VERIFICATION_RISK_SIGNALS`

webhook_type[RW]

‘"INCOME"`

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/income_verification_risk_signals_status_webhook.rb, line 71
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/income_verification_risk_signals_status_webhook.rb, line 59
def self.attribute_map
  {
    :'webhook_type' => :'webhook_type',
    :'webhook_code' => :'webhook_code',
    :'item_id' => :'item_id',
    :'user_id' => :'user_id',
    :'risk_signals_status' => :'risk_signals_status',
    :'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/income_verification_risk_signals_status_webhook.rb, line 194
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/income_verification_risk_signals_status_webhook.rb, line 95
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::IncomeVerificationRiskSignalsStatusWebhook` 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::IncomeVerificationRiskSignalsStatusWebhook`. 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?(:'item_id')
    self.item_id = attributes[:'item_id']
  end

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

  if attributes.key?(:'risk_signals_status')
    self.risk_signals_status = attributes[:'risk_signals_status']
  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/income_verification_risk_signals_status_webhook.rb, line 88
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/income_verification_risk_signals_status_webhook.rb, line 76
def self.openapi_types
  {
    :'webhook_type' => :'String',
    :'webhook_code' => :'String',
    :'item_id' => :'String',
    :'user_id' => :'String',
    :'risk_signals_status' => :'String',
    :'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/income_verification_risk_signals_status_webhook.rb, line 168
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      webhook_type == o.webhook_type &&
      webhook_code == o.webhook_code &&
      item_id == o.item_id &&
      user_id == o.user_id &&
      risk_signals_status == o.risk_signals_status &&
      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/income_verification_risk_signals_status_webhook.rb, line 225
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/income_verification_risk_signals_status_webhook.rb, line 296
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/income_verification_risk_signals_status_webhook.rb, line 201
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/income_verification_risk_signals_status_webhook.rb, line 181
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/income_verification_risk_signals_status_webhook.rb, line 187
def hash
  [webhook_type, webhook_code, item_id, user_id, risk_signals_status, 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/income_verification_risk_signals_status_webhook.rb, line 135
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 @item_id.nil?
    invalid_properties.push('invalid value for "item_id", item_id 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/income_verification_risk_signals_status_webhook.rb, line 272
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/income_verification_risk_signals_status_webhook.rb, line 278
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/income_verification_risk_signals_status_webhook.rb, line 266
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/income_verification_risk_signals_status_webhook.rb, line 158
def valid?
  return false if @webhook_type.nil?
  return false if @webhook_code.nil?
  return false if @item_id.nil?
  return false if @environment.nil?
  true
end