plaid 14.0.0.beta.4 → 14.2.0

data/lib/plaid/models/country_code.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.11.0
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/credit_card_liability.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.11.0
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -28,19 +28,16 @@ module Plaid
     # The amount of the last payment.
     attr_accessor :last_payment_amount
 
-    # The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD). Availability for this field is limited.
+    # The date of the last payment. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Availability for this field is limited.
     attr_accessor :last_payment_date
 
-    # The outstanding balance on the last statement. Availability for this field is limited.
-    attr_accessor :last_statement_balance
-
-    # The date of the last statement. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
+    # The date of the last statement. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
     attr_accessor :last_statement_issue_date
 
     # The minimum payment due for the next billing cycle.
     attr_accessor :minimum_payment_amount
 
-    # The due date for the next payment. The due date is `null` if a payment is not expected. Dates are returned in an ISO 8601 format (YYYY-MM-DD).
+    # The due date for the next payment. The due date is `null` if a payment is not expected. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
     attr_accessor :next_payment_due_date
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -51,7 +48,6 @@ module Plaid
         :'is_overdue' => :'is_overdue',
         :'last_payment_amount' => :'last_payment_amount',
         :'last_payment_date' => :'last_payment_date',
-        :'last_statement_balance' => :'last_statement_balance',
         :'last_statement_issue_date' => :'last_statement_issue_date',
         :'minimum_payment_amount' => :'minimum_payment_amount',
         :'next_payment_due_date' => :'next_payment_due_date'
@@ -70,11 +66,10 @@ module Plaid
         :'aprs' => :'Array<APR>',
         :'is_overdue' => :'Boolean',
         :'last_payment_amount' => :'Float',
-        :'last_payment_date' => :'String',
-        :'last_statement_balance' => :'Float',
-        :'last_statement_issue_date' => :'String',
+        :'last_payment_date' => :'Date',
+        :'last_statement_issue_date' => :'Date',
         :'minimum_payment_amount' => :'Float',
-        :'next_payment_due_date' => :'String'
+        :'next_payment_due_date' => :'Date'
       }
     end
 
@@ -83,6 +78,7 @@ module Plaid
       Set.new([
         :'account_id',
         :'is_overdue',
+        :'next_payment_due_date'
       ])
     end
 
@@ -123,10 +119,6 @@ module Plaid
         self.last_payment_date = attributes[:'last_payment_date']
       end
 
-      if attributes.key?(:'last_statement_balance')
-        self.last_statement_balance = attributes[:'last_statement_balance']
-      end
-
       if attributes.key?(:'last_statement_issue_date')
         self.last_statement_issue_date = attributes[:'last_statement_issue_date']
       end
@@ -156,10 +148,6 @@ module Plaid
         invalid_properties.push('invalid value for "last_payment_date", last_payment_date cannot be nil.')
       end
 
-      if @last_statement_balance.nil?
-        invalid_properties.push('invalid value for "last_statement_balance", last_statement_balance cannot be nil.')
-      end
-
       if @last_statement_issue_date.nil?
         invalid_properties.push('invalid value for "last_statement_issue_date", last_statement_issue_date cannot be nil.')
       end
@@ -168,10 +156,6 @@ module Plaid
         invalid_properties.push('invalid value for "minimum_payment_amount", minimum_payment_amount cannot be nil.')
       end
 
-      if @next_payment_due_date.nil?
-        invalid_properties.push('invalid value for "next_payment_due_date", next_payment_due_date cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -181,10 +165,8 @@ module Plaid
       return false if @aprs.nil?
       return false if @last_payment_amount.nil?
       return false if @last_payment_date.nil?
-      return false if @last_statement_balance.nil?
       return false if @last_statement_issue_date.nil?
       return false if @minimum_payment_amount.nil?
-      return false if @next_payment_due_date.nil?
       true
     end
 
@@ -198,7 +180,6 @@ module Plaid
           is_overdue == o.is_overdue &&
           last_payment_amount == o.last_payment_amount &&
           last_payment_date == o.last_payment_date &&
-          last_statement_balance == o.last_statement_balance &&
           last_statement_issue_date == o.last_statement_issue_date &&
           minimum_payment_amount == o.minimum_payment_amount &&
           next_payment_due_date == o.next_payment_due_date
@@ -213,7 +194,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, aprs, is_overdue, last_payment_amount, last_payment_date, last_statement_balance, last_statement_issue_date, minimum_payment_amount, next_payment_due_date].hash
+      [account_id, aprs, is_overdue, last_payment_amount, last_payment_date, last_statement_issue_date, minimum_payment_amount, next_payment_due_date].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/credit_filter.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.11.0
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -16,7 +16,7 @@ require 'time'
 module Plaid
   # A filter to apply to `credit`-type accounts
   class CreditFilter
-    # An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](/docs/api/accounts#accounts-schema). 
+    # An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#accounts-schema). 
     attr_accessor :account_subtypes
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/plaid/models/customer_initiated_return_risk.rb

@@ -0,0 +1,300 @@
+=begin
+#The Plaid API
+
+#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
+
+The version of the OpenAPI document: 2020-09-14_1.31.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit. Common return codes in this category include: “R05”, \"R07\", \"R10\", \"R11\", \"R29\". These returns typically have a return time frame of up to 60 calendar days. During this period, the customer of financial institutions can dispute a transaction as unauthorized.
+  class CustomerInitiatedReturnRisk
+    # A score from 0-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood.
+    attr_accessor :score
+
+    # A tier corresponding to the projected likelihood that the transaction, if initiated, will be subject to a return.  In the `customer_initiated_return_risk` object, there are five risk tiers corresponding to the scores:   1: Predicted customer-initiated return incidence rate between 0.00% - 0.02%   2: Predicted customer-initiated return incidence rate between 0.02% - 0.05%   3: Predicted customer-initiated return incidence rate between 0.05% - 0.1%   4: Predicted customer-initiated return incidence rate between 0.1% - 0.5%   5: Predicted customer-initiated return incidence rate greater than 0.5% 
+    attr_accessor :risk_tier
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'score' => :'score',
+        :'risk_tier' => :'risk_tier'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'score' => :'Integer',
+        :'risk_tier' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CustomerInitiatedReturnRisk` 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::CustomerInitiatedReturnRisk`. 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?(:'score')
+        self.score = attributes[:'score']
+      end
+
+      if attributes.key?(:'risk_tier')
+        self.risk_tier = attributes[:'risk_tier']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @score.nil?
+        invalid_properties.push('invalid value for "score", score cannot be nil.')
+      end
+
+      if @score > 100
+        invalid_properties.push('invalid value for "score", must be smaller than or equal to 100.')
+      end
+
+      if @score < 0
+        invalid_properties.push('invalid value for "score", must be greater than or equal to 0.')
+      end
+
+
+      if @risk_tier.nil?
+        invalid_properties.push('invalid value for "risk_tier", risk_tier cannot be nil.')
+      end
+
+      if @risk_tier > 5
+        invalid_properties.push('invalid value for "risk_tier", must be smaller than or equal to 5.')
+      end
+
+      if @risk_tier < 1
+        invalid_properties.push('invalid value for "risk_tier", must be greater than or equal to 1.')
+      end
+
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @score.nil?
+      return false if @score > 100
+      return false if @score < 0
+      return false if @risk_tier.nil?
+      return false if @risk_tier > 5
+      return false if @risk_tier < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] score Value to be assigned
+    def score=(score)
+      if score.nil?
+        fail ArgumentError, 'score cannot be nil'
+      end
+
+      if score > 100
+        fail ArgumentError, 'invalid value for "score", must be smaller than or equal to 100.'
+      end
+
+      if score < 0
+        fail ArgumentError, 'invalid value for "score", must be greater than or equal to 0.'
+      end
+
+
+      @score = score
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] risk_tier Value to be assigned
+    def risk_tier=(risk_tier)
+      if risk_tier.nil?
+        fail ArgumentError, 'risk_tier cannot be nil'
+      end
+
+      if risk_tier > 5
+        fail ArgumentError, 'invalid value for "risk_tier", must be smaller than or equal to 5.'
+      end
+
+      if risk_tier < 1
+        fail ArgumentError, 'invalid value for "risk_tier", must be greater than or equal to 1.'
+      end
+
+
+      @risk_tier = risk_tier
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          score == o.score &&
+          risk_tier == o.risk_tier
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [score, risk_tier].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end

data/lib/plaid/models/deductions.rb

@@ -0,0 +1,232 @@
+=begin
+#The Plaid API
+
+#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
+
+The version of the OpenAPI document: 2020-09-14_1.31.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # An object with the deduction information found on a paystub.
+  class Deductions
+    attr_accessor :subtotals
+
+    attr_accessor :totals
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'subtotals' => :'subtotals',
+        :'totals' => :'totals'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'subtotals' => :'Array<Total>',
+        :'totals' => :'Array<Total>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::Deductions` 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::Deductions`. 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?(:'subtotals')
+        if (value = attributes[:'subtotals']).is_a?(Array)
+          self.subtotals = value
+        end
+      end
+
+      if attributes.key?(:'totals')
+        if (value = attributes[:'totals']).is_a?(Array)
+          self.totals = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          subtotals == o.subtotals &&
+          totals == o.totals
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [subtotals, totals].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end