plaid 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown → 15.3.0

data/lib/plaid/models/income_verification_taxforms_get_response.rb

@@ -0,0 +1,262 @@
+=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.97.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # IncomeVerificationTaxformsGetResponse defines the response schema for `/income/verification/taxforms/get`
+  class IncomeVerificationTaxformsGetResponse
+    # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
+    attr_accessor :request_id
+
+    attr_accessor :document_metadata
+
+    # A list of forms.
+    attr_accessor :taxforms
+
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_id' => :'request_id',
+        :'document_metadata' => :'document_metadata',
+        :'taxforms' => :'taxforms',
+        :'error' => :'error'
+      }
+    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
+      {
+        :'request_id' => :'String',
+        :'document_metadata' => :'Array<DocumentMetadata>',
+        :'taxforms' => :'Array<Taxform>',
+        :'error' => :'PlaidError'
+      }
+    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::IncomeVerificationTaxformsGetResponse` 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::IncomeVerificationTaxformsGetResponse`. 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?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      end
+
+      if attributes.key?(:'document_metadata')
+        if (value = attributes[:'document_metadata']).is_a?(Array)
+          self.document_metadata = value
+        end
+      end
+
+      if attributes.key?(:'taxforms')
+        if (value = attributes[:'taxforms']).is_a?(Array)
+          self.taxforms = value
+        end
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      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 @document_metadata.nil?
+        invalid_properties.push('invalid value for "document_metadata", document_metadata cannot be nil.')
+      end
+
+      if @taxforms.nil?
+        invalid_properties.push('invalid value for "taxforms", taxforms cannot be nil.')
+      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 @document_metadata.nil?
+      return false if @taxforms.nil?
+      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 &&
+          request_id == o.request_id &&
+          document_metadata == o.document_metadata &&
+          taxforms == o.taxforms &&
+          error == o.error
+    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
+      [request_id, document_metadata, taxforms, error].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/income_verification_webhook_status.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Plaid
+  # Status of the income verification webhook
   class IncomeVerificationWebhookStatus
     attr_accessor :id
 

data/lib/plaid/models/inflow_model.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -16,7 +16,7 @@ require 'time'
 module Plaid
   # The `inflow_model` allows you to model a test account that receives regular income or make regular payments on a loan. Any transactions generated by the `inflow_model` will appear in addition to randomly generated test data or transactions specified by `override_accounts`.
   class InflowModel
-    # Inflow model. One of the following:  `none`: No income `monthly-income`: Income occurs once per month `monthly-balance-payment`: Pays off the balance on a liability account at the given statement day of month `monthly-interest-only-payment`: Makes an interest-only payment on a liability account at the given statement day of month. Note that account types supported by Liabilities will accrue interest in the Sandbox. The types are account type `credit` with subtype `credit` or `paypal`, and account type `loan` with subtype `student` or `mortgage`.
+    # Inflow model. One of the following:  `none`: No income  `monthly-income`: Income occurs once per month `monthly-balance-payment`: Pays off the balance on a liability account at the given statement day of month.  `monthly-interest-only-payment`: Makes an interest-only payment on a liability account at the given statement day of month.  Note that account types supported by Liabilities will accrue interest in the Sandbox. The types impacted are account type `credit` with subtype `credit` or `paypal`, and account type `loan` with subtype `student` or `mortgage`.
     attr_accessor :type
 
     # Amount of income per month. This value is required if `type` is `monthly-income`.

data/lib/plaid/models/initial_update_webhook.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Plaid
-  # Fired when an Item's initial transaction pull is completed. Once this webhook has been fired, transaction data for the most recent 30 days can be fetched for the Item.
+  # Fired when an Item's initial transaction pull is completed. Once this webhook has been fired, transaction data for the most recent 30 days can be fetched for the Item. If [Account Select v2](https://plaid.com/docs/link/customization/#account-select) is enabled, this webhook will also be fired if account selections for the Item are updated, with `new_transactions` set to the number of net new transactions pulled after the account selection update.
   class InitialUpdateWebhook
     # `TRANSACTIONS`
     attr_accessor :webhook_type

data/lib/plaid/models/institution.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -22,7 +22,7 @@ module Plaid
     # The official name of the institution
     attr_accessor :name
 
-    # A list of the Plaid products supported by the institution
+    # A list of the Plaid products supported by the institution. Note that only institutions that support Instant Auth will return `auth` in the product array; institutions that do not list `auth` may still support other Auth methods such as Instant Match or Automated Micro-deposit Verification. To identify institutions that support those methods, use the `auth_metadata` object. For more details, see [Full Auth coverage](https://plaid.com/docs/auth/coverage/).
     attr_accessor :products
 
     # A list of the country codes supported by the institution.
@@ -40,13 +40,15 @@ module Plaid
     # A partial list of routing numbers associated with the institution. This list is provided for the purpose of looking up institutions by routing number. It is not comprehensive and should never be used as a complete list of routing numbers for an institution.
     attr_accessor :routing_numbers
 
-    # Indicates that the institution has an OAuth login flow. This is primarily relevant to institutions with European country codes.
+    # Indicates that the institution has an OAuth login flow.
     attr_accessor :oauth
 
     attr_accessor :status
 
     attr_accessor :payment_initiation_metadata
 
+    attr_accessor :auth_metadata
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -60,7 +62,8 @@ module Plaid
         :'routing_numbers' => :'routing_numbers',
         :'oauth' => :'oauth',
         :'status' => :'status',
-        :'payment_initiation_metadata' => :'payment_initiation_metadata'
+        :'payment_initiation_metadata' => :'payment_initiation_metadata',
+        :'auth_metadata' => :'auth_metadata'
       }
     end
 
@@ -82,7 +85,8 @@ module Plaid
         :'routing_numbers' => :'Array<String>',
         :'oauth' => :'Boolean',
         :'status' => :'InstitutionStatus',
-        :'payment_initiation_metadata' => :'PaymentInitiationMetadata'
+        :'payment_initiation_metadata' => :'PaymentInitiationMetadata',
+        :'auth_metadata' => :'AuthMetadata'
       }
     end
 
@@ -92,8 +96,9 @@ module Plaid
         :'url',
         :'primary_color',
         :'logo',
-        :'routing_numbers',
-        :'payment_initiation_metadata'
+        :'status',
+        :'payment_initiation_metadata',
+        :'auth_metadata'
       ])
     end
 
@@ -161,6 +166,10 @@ module Plaid
       if attributes.key?(:'payment_initiation_metadata')
         self.payment_initiation_metadata = attributes[:'payment_initiation_metadata']
       end
+
+      if attributes.key?(:'auth_metadata')
+        self.auth_metadata = attributes[:'auth_metadata']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -183,6 +192,10 @@ module Plaid
         invalid_properties.push('invalid value for "country_codes", country_codes cannot be nil.')
       end
 
+      if @routing_numbers.nil?
+        invalid_properties.push('invalid value for "routing_numbers", routing_numbers cannot be nil.')
+      end
+
       if @oauth.nil?
         invalid_properties.push('invalid value for "oauth", oauth cannot be nil.')
       end
@@ -197,6 +210,7 @@ module Plaid
       return false if @name.nil?
       return false if @products.nil?
       return false if @country_codes.nil?
+      return false if @routing_numbers.nil?
       return false if @oauth.nil?
       true
     end
@@ -216,7 +230,8 @@ module Plaid
           routing_numbers == o.routing_numbers &&
           oauth == o.oauth &&
           status == o.status &&
-          payment_initiation_metadata == o.payment_initiation_metadata
+          payment_initiation_metadata == o.payment_initiation_metadata &&
+          auth_metadata == o.auth_metadata
     end
 
     # @see the `==` method
@@ -228,7 +243,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [institution_id, name, products, country_codes, url, primary_color, logo, routing_numbers, oauth, status, payment_initiation_metadata].hash
+      [institution_id, name, products, country_codes, url, primary_color, logo, routing_numbers, oauth, status, payment_initiation_metadata, auth_metadata].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/institution_status.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Plaid
-  # The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Auth requests, Balance requests, and Identity requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution's status, Plaid will return null rather than potentially inaccurate data.  Institution status is accessible in the Dashboard and via the API using the `/institutions/get_by_id` endpoint with the `include_status` option set to true. Note that institution status is not available in the Sandbox environment. 
+  # The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution's status, Plaid will return null rather than potentially inaccurate data.  Institution status is accessible in the Dashboard and via the API using the `/institutions/get_by_id` endpoint with the `include_status` option set to true. Note that institution status is not available in the Sandbox environment. 
   class InstitutionStatus
     attr_accessor :item_logins
 
@@ -22,12 +22,16 @@ module Plaid
 
     attr_accessor :auth
 
-    attr_accessor :balance
-
     attr_accessor :identity
 
     attr_accessor :investments_updates
 
+    attr_accessor :liabilities_updates
+
+    attr_accessor :liabilities
+
+    attr_accessor :investments
+
     # Details of recent health incidents associated with the institution.
     attr_accessor :health_incidents
 
@@ -37,9 +41,11 @@ module Plaid
         :'item_logins' => :'item_logins',
         :'transactions_updates' => :'transactions_updates',
         :'auth' => :'auth',
-        :'balance' => :'balance',
         :'identity' => :'identity',
         :'investments_updates' => :'investments_updates',
+        :'liabilities_updates' => :'liabilities_updates',
+        :'liabilities' => :'liabilities',
+        :'investments' => :'investments',
         :'health_incidents' => :'health_incidents'
       }
     end
@@ -55,9 +61,11 @@ module Plaid
         :'item_logins' => :'ProductStatus',
         :'transactions_updates' => :'ProductStatus',
         :'auth' => :'ProductStatus',
-        :'balance' => :'ProductStatus',
         :'identity' => :'ProductStatus',
         :'investments_updates' => :'ProductStatus',
+        :'liabilities_updates' => :'ProductStatus',
+        :'liabilities' => :'ProductStatus',
+        :'investments' => :'ProductStatus',
         :'health_incidents' => :'Array<HealthIncident>'
       }
     end
@@ -96,10 +104,6 @@ module Plaid
         self.auth = attributes[:'auth']
       end
 
-      if attributes.key?(:'balance')
-        self.balance = attributes[:'balance']
-      end
-
       if attributes.key?(:'identity')
         self.identity = attributes[:'identity']
       end
@@ -108,6 +112,18 @@ module Plaid
         self.investments_updates = attributes[:'investments_updates']
       end
 
+      if attributes.key?(:'liabilities_updates')
+        self.liabilities_updates = attributes[:'liabilities_updates']
+      end
+
+      if attributes.key?(:'liabilities')
+        self.liabilities = attributes[:'liabilities']
+      end
+
+      if attributes.key?(:'investments')
+        self.investments = attributes[:'investments']
+      end
+
       if attributes.key?(:'health_incidents')
         if (value = attributes[:'health_incidents']).is_a?(Array)
           self.health_incidents = value
@@ -131,10 +147,6 @@ module Plaid
         invalid_properties.push('invalid value for "auth", auth cannot be nil.')
       end
 
-      if @balance.nil?
-        invalid_properties.push('invalid value for "balance", balance cannot be nil.')
-      end
-
       if @identity.nil?
         invalid_properties.push('invalid value for "identity", identity cannot be nil.')
       end
@@ -152,7 +164,6 @@ module Plaid
       return false if @item_logins.nil?
       return false if @transactions_updates.nil?
       return false if @auth.nil?
-      return false if @balance.nil?
       return false if @identity.nil?
       return false if @investments_updates.nil?
       true
@@ -166,9 +177,11 @@ module Plaid
           item_logins == o.item_logins &&
           transactions_updates == o.transactions_updates &&
           auth == o.auth &&
-          balance == o.balance &&
           identity == o.identity &&
           investments_updates == o.investments_updates &&
+          liabilities_updates == o.liabilities_updates &&
+          liabilities == o.liabilities &&
+          investments == o.investments &&
           health_incidents == o.health_incidents
     end
 
@@ -181,7 +194,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [item_logins, transactions_updates, auth, balance, identity, investments_updates, health_incidents].hash
+      [item_logins, transactions_updates, auth, identity, investments_updates, liabilities_updates, liabilities, investments, health_incidents].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/institutions_get_by_id_request.rb

@@ -3,10 +3,10 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -25,7 +25,7 @@ module Plaid
     # The ID of the institution to get details about
     attr_accessor :institution_id
 
-    # Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. 
+    # Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. In API versions 2019-05-29 and earlier, the `country_codes` parameter is an optional parameter within the `options` object and will default to `[US]` if it is not supplied. 
     attr_accessor :country_codes
 
     attr_accessor :options
@@ -109,6 +109,11 @@ module Plaid
         invalid_properties.push('invalid value for "institution_id", institution_id cannot be nil.')
       end
 
+      if @institution_id.to_s.length < 1
+        invalid_properties.push('invalid value for "institution_id", the character length must be great than or equal to 1.')
+      end
+
+
       if @country_codes.nil?
         invalid_properties.push('invalid value for "country_codes", country_codes cannot be nil.')
       end
@@ -120,10 +125,26 @@ module Plaid
     # @return true if the model is valid
     def valid?
       return false if @institution_id.nil?
+      return false if @institution_id.to_s.length < 1
       return false if @country_codes.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] institution_id Value to be assigned
+    def institution_id=(institution_id)
+      if institution_id.nil?
+        fail ArgumentError, 'institution_id cannot be nil'
+      end
+
+      if institution_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "institution_id", the character length must be great than or equal to 1.'
+      end
+
+
+      @institution_id = institution_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)