plaid 15.11.0 → 18.0.0

data/lib/plaid/models/income_verification_status_webhook.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -28,9 +28,11 @@ module Plaid
     # The Plaid `user_id` of the User associated with this webhook, warning, or error.
     attr_accessor :user_id
 
-    # `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the `/income/verification/paystubs/get` endpoint and check the document metadata to see which documents were successfully parsed.  `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation.  `VERIFICATION_STATUS_PENDING_APPROVAL`: The income verification has been sent to the user for review.
+    # `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the `/income/verification/paystubs/get` endpoint and check the document metadata to see which documents were successfully parsed.  `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation.  `VERIFICATION_STATUS_PENDING_APPROVAL`: (deprecated) The income verification has been sent to the user for review.
     attr_accessor :verification_status
 
+    attr_accessor :environment
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,7 +40,8 @@ module Plaid
         :'webhook_code' => :'webhook_code',
         :'item_id' => :'item_id',
         :'user_id' => :'user_id',
-        :'verification_status' => :'verification_status'
+        :'verification_status' => :'verification_status',
+        :'environment' => :'environment'
       }
     end
 
@@ -54,7 +57,8 @@ module Plaid
         :'webhook_code' => :'String',
         :'item_id' => :'String',
         :'user_id' => :'String',
-        :'verification_status' => :'String'
+        :'verification_status' => :'String',
+        :'environment' => :'WebhookEnvironmentValues'
       }
     end
 
@@ -98,6 +102,10 @@ module Plaid
       if attributes.key?(:'verification_status')
         self.verification_status = attributes[:'verification_status']
       end
+
+      if attributes.key?(:'environment')
+        self.environment = attributes[:'environment']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -120,6 +128,10 @@ module Plaid
         invalid_properties.push('invalid value for "verification_status", verification_status cannot be nil.')
       end
 
+      if @environment.nil?
+        invalid_properties.push('invalid value for "environment", environment cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -130,6 +142,7 @@ module Plaid
       return false if @webhook_code.nil?
       return false if @item_id.nil?
       return false if @verification_status.nil?
+      return false if @environment.nil?
       true
     end
 
@@ -142,7 +155,8 @@ module Plaid
           webhook_code == o.webhook_code &&
           item_id == o.item_id &&
           user_id == o.user_id &&
-          verification_status == o.verification_status
+          verification_status == o.verification_status &&
+          environment == o.environment
     end
 
     # @see the `==` method
@@ -154,7 +168,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [webhook_type, webhook_code, item_id, user_id, verification_status].hash
+      [webhook_type, webhook_code, item_id, user_id, verification_status, environment].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/income_verification_taxforms_get_request.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/income_verification_taxforms_get_response.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/income_verification_webhook_status.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/individual_name.rb

@@ -0,0 +1,240 @@
+=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.343.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Parent container for name that allows for choice group between parsed and unparsed containers.Parent container for name that allows for choice group between parsed and unparsed containers.
+  class IndividualName
+    # The first name of the individual represented by the parent object.
+    attr_accessor :first_name
+
+    # The last name of the individual represented by the parent object.
+    attr_accessor :last_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_name' => :'FirstName',
+        :'last_name' => :'LastName'
+      }
+    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
+      {
+        :'first_name' => :'String',
+        :'last_name' => :'String'
+      }
+    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::IndividualName` 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::IndividualName`. 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?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      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 @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name 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 @first_name.nil?
+      return false if @last_name.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 &&
+          first_name == o.first_name &&
+          last_name == o.last_name
+    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
+      [first_name, last_name].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/individual_screening_hit_names.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/individual_watchlist_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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -22,13 +22,14 @@ module Plaid
     IZ_IPL = "IZ_IPL".freeze
     IZ_PEP = "IZ_PEP".freeze
     IZ_UNC = "IZ_UNC".freeze
+    IZ_WBK = "IZ_WBK".freeze
     UK_HMC = "UK_HMC".freeze
     US_DPL = "US_DPL".freeze
     US_DTC = "US_DTC".freeze
     US_FBI = "US_FBI".freeze
     US_FSE = "US_FSE".freeze
     US_ISN = "US_ISN".freeze
-    US_MBC = "US_MBC".freeze
+    US_MBS = "US_MBS".freeze
     US_PLC = "US_PLC".freeze
     US_SDN = "US_SDN".freeze
     US_SSI = "US_SSI".freeze
@@ -37,6 +38,7 @@ module Plaid
     TR_DFD = "TR_DFD".freeze
     TR_FOR = "TR_FOR".freeze
     TR_WMD = "TR_WMD".freeze
+    TR_CMB = "TR_CMB".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/plaid/models/individual_watchlist_program.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -156,11 +156,6 @@ module Plaid
         invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
       end
 
-      pattern = Regexp.new(/^\S+(\s+\S+)*$/)
-      if @name !~ pattern
-        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
-      end
-
 
       if @name_sensitivity.nil?
         invalid_properties.push('invalid value for "name_sensitivity", name_sensitivity cannot be nil.')
@@ -186,7 +181,6 @@ module Plaid
       return false if @lists_enabled.nil?
       return false if @name.nil?
       return false if @name.to_s.length < 1
-      return false if @name !~ Regexp.new(/^\S+(\s+\S+)*$/)
       return false if @name_sensitivity.nil?
       return false if @audit_trail.nil?
       return false if @is_archived.nil?
@@ -215,11 +209,6 @@ module Plaid
         fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
       end
 
-      pattern = Regexp.new(/^\S+(\s+\S+)*$/)
-      if name !~ pattern
-        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
-      end
-
 
       @name = name
     end

data/lib/plaid/models/inflow_model.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/initial_update_webhook.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -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. 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.
+  # 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.  This webhook is intended for use with `/transactions/get`; if you are using the newer `/transactions/sync` endpoint, this webhook will still be fired to maintain backwards compatibility, but it is recommended to listen for and respond to the `SYNC_UPDATES_AVAILABLE` webhook instead.
   class InitialUpdateWebhook
     # `TRANSACTIONS`
     attr_accessor :webhook_type
@@ -31,6 +31,8 @@ module Plaid
     # The `item_id` of the Item associated with this webhook, warning, or error
     attr_accessor :item_id
 
+    attr_accessor :environment
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,7 +40,8 @@ module Plaid
         :'webhook_code' => :'webhook_code',
         :'error' => :'error',
         :'new_transactions' => :'new_transactions',
-        :'item_id' => :'item_id'
+        :'item_id' => :'item_id',
+        :'environment' => :'environment'
       }
     end
 
@@ -54,7 +57,8 @@ module Plaid
         :'webhook_code' => :'String',
         :'error' => :'String',
         :'new_transactions' => :'Float',
-        :'item_id' => :'String'
+        :'item_id' => :'String',
+        :'environment' => :'WebhookEnvironmentValues'
       }
     end
 
@@ -99,6 +103,10 @@ module Plaid
       if attributes.key?(:'item_id')
         self.item_id = attributes[:'item_id']
       end
+
+      if attributes.key?(:'environment')
+        self.environment = attributes[:'environment']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -121,6 +129,10 @@ module Plaid
         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
 
@@ -131,6 +143,7 @@ module Plaid
       return false if @webhook_code.nil?
       return false if @new_transactions.nil?
       return false if @item_id.nil?
+      return false if @environment.nil?
       true
     end
 
@@ -143,7 +156,8 @@ module Plaid
           webhook_code == o.webhook_code &&
           error == o.error &&
           new_transactions == o.new_transactions &&
-          item_id == o.item_id
+          item_id == o.item_id &&
+          environment == o.environment
     end
 
     # @see the `==` method
@@ -155,7 +169,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [webhook_type, webhook_code, error, new_transactions, item_id].hash
+      [webhook_type, webhook_code, error, new_transactions, item_id, environment].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/institution.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -34,13 +34,16 @@ module Plaid
     # Hexadecimal representation of the primary color used by the institution
     attr_accessor :primary_color
 
-    # Base64 encoded representation of the institution's logo
+    # Base64 encoded representation of the institution's logo, returned as a base64 encoded 152x152 PNG. Not all institutions' logos are available.
     attr_accessor :logo
 
     # 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.
+    # A partial list of DTC numbers associated with the institution.
+    attr_accessor :dtc_numbers
+
+    # Indicates that the institution has a mandatory OAuth login flow. Note that `oauth` may be `false` even for institutions that support OAuth, if the institution is in the process of migrating to OAuth and some active Items still exist that do not use OAuth.
     attr_accessor :oauth
 
     attr_accessor :status
@@ -60,6 +63,7 @@ module Plaid
         :'primary_color' => :'primary_color',
         :'logo' => :'logo',
         :'routing_numbers' => :'routing_numbers',
+        :'dtc_numbers' => :'dtc_numbers',
         :'oauth' => :'oauth',
         :'status' => :'status',
         :'payment_initiation_metadata' => :'payment_initiation_metadata',
@@ -83,6 +87,7 @@ module Plaid
         :'primary_color' => :'String',
         :'logo' => :'String',
         :'routing_numbers' => :'Array<String>',
+        :'dtc_numbers' => :'Array<String>',
         :'oauth' => :'Boolean',
         :'status' => :'InstitutionStatus',
         :'payment_initiation_metadata' => :'PaymentInitiationMetadata',
@@ -155,6 +160,12 @@ module Plaid
         end
       end
 
+      if attributes.key?(:'dtc_numbers')
+        if (value = attributes[:'dtc_numbers']).is_a?(Array)
+          self.dtc_numbers = value
+        end
+      end
+
       if attributes.key?(:'oauth')
         self.oauth = attributes[:'oauth']
       end
@@ -228,6 +239,7 @@ module Plaid
           primary_color == o.primary_color &&
           logo == o.logo &&
           routing_numbers == o.routing_numbers &&
+          dtc_numbers == o.dtc_numbers &&
           oauth == o.oauth &&
           status == o.status &&
           payment_initiation_metadata == o.payment_initiation_metadata &&
@@ -243,7 +255,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, auth_metadata].hash
+      [institution_id, name, products, country_codes, url, primary_color, logo, routing_numbers, dtc_numbers, oauth, status, payment_initiation_metadata, auth_metadata].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/institution_status.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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -73,6 +73,14 @@ module Plaid
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'item_logins',
+        :'transactions_updates',
+        :'auth',
+        :'identity',
+        :'investments_updates',
+        :'liabilities_updates',
+        :'liabilities',
+        :'investments',
         :'health_incidents'
       ])
     end