class Plaid::LinkTokenCreateRequestCraOptions

Specifies options for initializing Link for use with Plaid Check products

Attributes

base_report[RW]
cashflow_insights[RW]
days_requested[RW]

The number of days of history to include in Plaid Check products. Default value is 365; maximum is 730; minimum is 180. If a value lower than 180 is provided, a minimum of 180 days of history will be requested.

days_required[RW]

The minimum number of days of data required for the report to be successfully generated.

partner_insights[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/link_token_create_request_cra_options.rb, line 43
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/link_token_create_request_cra_options.rb, line 32
def self.attribute_map
  {
    :'days_requested' => :'days_requested',
    :'days_required' => :'days_required',
    :'partner_insights' => :'partner_insights',
    :'base_report' => :'base_report',
    :'cashflow_insights' => :'cashflow_insights'
  }
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/link_token_create_request_cra_options.rb, line 183
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/link_token_create_request_cra_options.rb, line 66
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::LinkTokenCreateRequestCraOptions` 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::LinkTokenCreateRequestCraOptions`. 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?(:'days_requested')
    self.days_requested = attributes[:'days_requested']
  end

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/plaid/models/link_token_create_request_cra_options.rb, line 48
def self.openapi_types
  {
    :'days_requested' => :'Integer',
    :'days_required' => :'Integer',
    :'partner_insights' => :'LinkTokenCreateRequestCraOptionsPartnerInsights',
    :'base_report' => :'LinkTokenCreateRequestCraOptionsBaseReport',
    :'cashflow_insights' => :'LinkTokenCreateRequestCraOptionsCashflowInsights'
  }
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/link_token_create_request_cra_options.rb, line 158
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      days_requested == o.days_requested &&
      days_required == o.days_required &&
      partner_insights == o.partner_insights &&
      base_report == o.base_report &&
      cashflow_insights == o.cashflow_insights
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/link_token_create_request_cra_options.rb, line 214
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/link_token_create_request_cra_options.rb, line 285
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/link_token_create_request_cra_options.rb, line 190
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
days_requested=(days_requested) click to toggle source

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

# File lib/plaid/models/link_token_create_request_cra_options.rb, line 132
def days_requested=(days_requested)
  if days_requested.nil?
    fail ArgumentError, 'days_requested cannot be nil'
  end

  if days_requested > 730
    fail ArgumentError, 'invalid value for "days_requested", must be smaller than or equal to 730.'
  end


  @days_requested = days_requested
end
days_required=(days_required) click to toggle source

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

# File lib/plaid/models/link_token_create_request_cra_options.rb, line 147
def days_required=(days_required)
  if !days_required.nil? && days_required > 730
    fail ArgumentError, 'invalid value for "days_required", must be smaller than or equal to 730.'
  end


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

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

# File lib/plaid/models/link_token_create_request_cra_options.rb, line 170
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/link_token_create_request_cra_options.rb, line 176
def hash
  [days_requested, days_required, partner_insights, base_report, cashflow_insights].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/link_token_create_request_cra_options.rb, line 102
def list_invalid_properties
  invalid_properties = Array.new
  if @days_requested.nil?
    invalid_properties.push('invalid value for "days_requested", days_requested cannot be nil.')
  end

  if @days_requested > 730
    invalid_properties.push('invalid value for "days_requested", must be smaller than or equal to 730.')
  end


  if !@days_required.nil? && @days_required > 730
    invalid_properties.push('invalid value for "days_required", must be smaller than or equal to 730.')
  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/link_token_create_request_cra_options.rb, line 261
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/link_token_create_request_cra_options.rb, line 267
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/link_token_create_request_cra_options.rb, line 255
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/link_token_create_request_cra_options.rb, line 123
def valid?
  return false if @days_requested.nil?
  return false if @days_requested > 730
  return false if !@days_required.nil? && @days_required > 730
  true
end