plaid 15.0.0 → 15.3.0

data/lib/plaid/models/link_token_create_institution_data.rb

@@ -0,0 +1,220 @@
+=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
+  # A map containing data used to highlight institutions in Link.
+  class LinkTokenCreateInstitutionData
+    # The routing number of the bank to highlight.
+    attr_accessor :routing_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'routing_number' => :'routing_number'
+      }
+    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
+      {
+        :'routing_number' => :'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::LinkTokenCreateInstitutionData` 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::LinkTokenCreateInstitutionData`. 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?(:'routing_number')
+        self.routing_number = attributes[:'routing_number']
+      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 &&
+          routing_number == o.routing_number
+    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
+      [routing_number].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/link_token_create_investment_filter.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.79.0
+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
 

data/lib/plaid/models/link_token_create_loan_filter.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.79.0
+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
 

data/lib/plaid/models/link_token_create_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.79.0
+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
 
@@ -28,7 +28,7 @@ module Plaid
     # The language that Link should be displayed in.  Supported languages are: - English (`'en'`) - French (`'fr'`) - Spanish (`'es'`) - Dutch (`'nl'`) - German(`'de'`)  When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied.
     attr_accessor :language
 
-    # Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown.  Supported country codes are: `US`, `CA`, `DE`, `ES`, `FR`, `GB`, `IE`, `NL`. For a complete mapping of supported products by country, see https://plaid.com/global/.  If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. To gain access to European institutions in the Production environment, [file a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow.  If using a Link customization, make sure the country codes in the customization match those specified in `country_codes`. If both `country_codes` and a Link customization are used, the value in `country_codes` may override the value in the customization.  If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `['US']`.
+    # Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown.  Supported country codes are: `US`, `CA`, `DE`, `ES`, `FR`, `GB`, `IE`, `IT`, `NL`. For a complete mapping of supported products by country, see https://plaid.com/global/.  If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. To gain access to European institutions in the Production environment, [file a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow.  If using a Link customization, make sure the country codes in the customization match those specified in `country_codes`. If both `country_codes` and a Link customization are used, the value in `country_codes` may override the value in the customization.  If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `['US']`.
     attr_accessor :country_codes
 
     attr_accessor :user
@@ -51,6 +51,8 @@ module Plaid
     # The name of your app's Android package. Required if using the `link_token` to initialize Link on Android. When creating a `link_token` for initializing Link on other platforms, this field must be left blank. Any package name specified here must also be added to the Allowed Android package names setting on the [developer dashboard](https://dashboard.plaid.com/team/api). 
     attr_accessor :android_package_name
 
+    attr_accessor :institution_data
+
     attr_accessor :account_filters
 
     attr_accessor :eu_config
@@ -70,6 +72,9 @@ module Plaid
 
     attr_accessor :update
 
+    # A user token generated using /user/create. Any item created during the link session will be associated with the user.
+    attr_accessor :user_token
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -85,6 +90,7 @@ module Plaid
         :'link_customization_name' => :'link_customization_name',
         :'redirect_uri' => :'redirect_uri',
         :'android_package_name' => :'android_package_name',
+        :'institution_data' => :'institution_data',
         :'account_filters' => :'account_filters',
         :'eu_config' => :'eu_config',
         :'institution_id' => :'institution_id',
@@ -93,7 +99,8 @@ module Plaid
         :'income_verification' => :'income_verification',
         :'auth' => :'auth',
         :'transfer' => :'transfer',
-        :'update' => :'update'
+        :'update' => :'update',
+        :'user_token' => :'user_token'
       }
     end
 
@@ -117,6 +124,7 @@ module Plaid
         :'link_customization_name' => :'String',
         :'redirect_uri' => :'String',
         :'android_package_name' => :'String',
+        :'institution_data' => :'LinkTokenCreateInstitutionData',
         :'account_filters' => :'LinkTokenAccountFilters',
         :'eu_config' => :'LinkTokenEUConfig',
         :'institution_id' => :'String',
@@ -125,7 +133,8 @@ module Plaid
         :'income_verification' => :'LinkTokenCreateRequestIncomeVerification',
         :'auth' => :'LinkTokenCreateRequestAuth',
         :'transfer' => :'LinkTokenCreateRequestTransfer',
-        :'update' => :'LinkTokenCreateRequestUpdate'
+        :'update' => :'LinkTokenCreateRequestUpdate',
+        :'user_token' => :'String'
       }
     end
 
@@ -202,6 +211,10 @@ module Plaid
         self.android_package_name = attributes[:'android_package_name']
       end
 
+      if attributes.key?(:'institution_data')
+        self.institution_data = attributes[:'institution_data']
+      end
+
       if attributes.key?(:'account_filters')
         self.account_filters = attributes[:'account_filters']
       end
@@ -237,6 +250,10 @@ module Plaid
       if attributes.key?(:'update')
         self.update = attributes[:'update']
       end
+
+      if attributes.key?(:'user_token')
+        self.user_token = attributes[:'user_token']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -310,6 +327,7 @@ module Plaid
           link_customization_name == o.link_customization_name &&
           redirect_uri == o.redirect_uri &&
           android_package_name == o.android_package_name &&
+          institution_data == o.institution_data &&
           account_filters == o.account_filters &&
           eu_config == o.eu_config &&
           institution_id == o.institution_id &&
@@ -318,7 +336,8 @@ module Plaid
           income_verification == o.income_verification &&
           auth == o.auth &&
           transfer == o.transfer &&
-          update == o.update
+          update == o.update &&
+          user_token == o.user_token
     end
 
     # @see the `==` method
@@ -330,7 +349,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, client_name, language, country_codes, user, products, webhook, access_token, link_customization_name, redirect_uri, android_package_name, account_filters, eu_config, institution_id, payment_initiation, deposit_switch, income_verification, auth, transfer, update].hash
+      [client_id, secret, client_name, language, country_codes, user, products, webhook, access_token, link_customization_name, redirect_uri, android_package_name, institution_data, account_filters, eu_config, institution_id, payment_initiation, deposit_switch, income_verification, auth, transfer, update, user_token].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/link_token_create_request_account_subtypes.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.79.0
+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
 

data/lib/plaid/models/link_token_create_request_auth.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.79.0
+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
 

data/lib/plaid/models/link_token_create_request_deposit_switch.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.79.0
+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
 

data/lib/plaid/models/link_token_create_request_income_verification.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.79.0
+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
 
@@ -28,13 +28,23 @@ module Plaid
     # An array of access tokens corresponding to the Items that will be cross-referenced with the product data. If the `transactions` product was not initialized for the Items during link, it will be initialized after this Link session.
     attr_accessor :access_tokens
 
+    # The types of source income data that users will be permitted to share. Options include `bank` and `payroll`. Currently you can only specify one of these options.
+    attr_accessor :income_source_types
+
+    attr_accessor :bank_income
+
+    attr_accessor :payroll_income
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'income_verification_id' => :'income_verification_id',
         :'asset_report_id' => :'asset_report_id',
         :'precheck_id' => :'precheck_id',
-        :'access_tokens' => :'access_tokens'
+        :'access_tokens' => :'access_tokens',
+        :'income_source_types' => :'income_source_types',
+        :'bank_income' => :'bank_income',
+        :'payroll_income' => :'payroll_income'
       }
     end
 
@@ -49,7 +59,10 @@ module Plaid
         :'income_verification_id' => :'String',
         :'asset_report_id' => :'String',
         :'precheck_id' => :'String',
-        :'access_tokens' => :'Array<String>'
+        :'access_tokens' => :'Array<String>',
+        :'income_source_types' => :'Array<IncomeVerificationSourceType>',
+        :'bank_income' => :'LinkTokenCreateRequestIncomeVerificationBankIncome',
+        :'payroll_income' => :'LinkTokenCreateRequestIncomeVerificationPayrollIncome'
       }
     end
 
@@ -91,6 +104,20 @@ module Plaid
           self.access_tokens = value
         end
       end
+
+      if attributes.key?(:'income_source_types')
+        if (value = attributes[:'income_source_types']).is_a?(Array)
+          self.income_source_types = value
+        end
+      end
+
+      if attributes.key?(:'bank_income')
+        self.bank_income = attributes[:'bank_income']
+      end
+
+      if attributes.key?(:'payroll_income')
+        self.payroll_income = attributes[:'payroll_income']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -114,7 +141,10 @@ module Plaid
           income_verification_id == o.income_verification_id &&
           asset_report_id == o.asset_report_id &&
           precheck_id == o.precheck_id &&
-          access_tokens == o.access_tokens
+          access_tokens == o.access_tokens &&
+          income_source_types == o.income_source_types &&
+          bank_income == o.bank_income &&
+          payroll_income == o.payroll_income
     end
 
     # @see the `==` method
@@ -126,7 +156,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [income_verification_id, asset_report_id, precheck_id, access_tokens].hash
+      [income_verification_id, asset_report_id, precheck_id, access_tokens, income_source_types, bank_income, payroll_income].hash
     end
 
     # Builds the object from hash