plaid 14.0.0.beta.4 → 14.2.0

data/lib/plaid/models/institutions_search_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.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
@@ -25,7 +25,7 @@ module Plaid
     # The search query. Institutions with names matching the query are returned
     attr_accessor :query
 
-    # Filter the Institutions based on whether they support all products listed in products. Provide `null` to get institutions regardless of supported products
+    # Filter the Institutions based on whether they support all products listed in `products`. Provide `null` to get institutions regardless of supported products. Note that when `auth` is specified as a product, if you are enabled for Instant Match or Automated Micro-deposits, institutions that support those products will be returned even if `auth` is not present in their product array.
     attr_accessor :products
 
     # Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. 

data/lib/plaid/models/institutions_search_request_options.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
@@ -19,14 +19,25 @@ module Plaid
     # Limit results to institutions with or without OAuth login flows. This is primarily relevant to institutions with European country codes
     attr_accessor :oauth
 
-    # When true, return the institution's homepage URL, logo and primary brand color. Learn more
+    # When true, return the institution's homepage URL, logo and primary brand color.
     attr_accessor :include_optional_metadata
 
+    # When `true`, returns metadata related to the Auth product indicating which auth methods are supported.
+    attr_accessor :include_auth_metadata
+
+    # When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
+    attr_accessor :include_payment_initiation_metadata
+
+    attr_accessor :payment_initiation
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'oauth' => :'oauth',
-        :'include_optional_metadata' => :'include_optional_metadata'
+        :'include_optional_metadata' => :'include_optional_metadata',
+        :'include_auth_metadata' => :'include_auth_metadata',
+        :'include_payment_initiation_metadata' => :'include_payment_initiation_metadata',
+        :'payment_initiation' => :'payment_initiation'
       }
     end
 
@@ -39,13 +50,17 @@ module Plaid
     def self.openapi_types
       {
         :'oauth' => :'Boolean',
-        :'include_optional_metadata' => :'Boolean'
+        :'include_optional_metadata' => :'Boolean',
+        :'include_auth_metadata' => :'Boolean',
+        :'include_payment_initiation_metadata' => :'Boolean',
+        :'payment_initiation' => :'InstitutionsSearchPaymentInitiationOptions'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'payment_initiation'
       ])
     end
 
@@ -71,6 +86,22 @@ module Plaid
       if attributes.key?(:'include_optional_metadata')
         self.include_optional_metadata = attributes[:'include_optional_metadata']
       end
+
+      if attributes.key?(:'include_auth_metadata')
+        self.include_auth_metadata = attributes[:'include_auth_metadata']
+      else
+        self.include_auth_metadata = false
+      end
+
+      if attributes.key?(:'include_payment_initiation_metadata')
+        self.include_payment_initiation_metadata = attributes[:'include_payment_initiation_metadata']
+      else
+        self.include_payment_initiation_metadata = false
+      end
+
+      if attributes.key?(:'payment_initiation')
+        self.payment_initiation = attributes[:'payment_initiation']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -92,7 +123,10 @@ module Plaid
       return true if self.equal?(o)
       self.class == o.class &&
           oauth == o.oauth &&
-          include_optional_metadata == o.include_optional_metadata
+          include_optional_metadata == o.include_optional_metadata &&
+          include_auth_metadata == o.include_auth_metadata &&
+          include_payment_initiation_metadata == o.include_payment_initiation_metadata &&
+          payment_initiation == o.payment_initiation
     end
 
     # @see the `==` method
@@ -104,7 +138,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [oauth, include_optional_metadata].hash
+      [oauth, include_optional_metadata, include_auth_metadata, include_payment_initiation_metadata, payment_initiation].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/institutions_search_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.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/investment_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 `investment`-type accounts
   class InvestmentFilter
-    # 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/investment_holdings_get_request_options.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/investment_transaction.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,13 +28,13 @@ module Plaid
     # The `security_id` to which this transaction is related.
     attr_accessor :security_id
 
-    # The ISO-8601 posting date for the transaction, or transacted date for pending transactions.
+    # The [ISO 8601](https://wikipedia.org/wiki/ISO_8601) posting date for the transaction, or transacted date for pending transactions.
     attr_accessor :date
 
     # The institution’s description of the transaction.
     attr_accessor :name
 
-    # The number of units of the security involved in this transactions
+    # The number of units of the security involved in this transaction.
     attr_accessor :quantity
 
     # The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities.
@@ -46,16 +46,16 @@ module Plaid
     # The combined value of all fees applied to this transaction
     attr_accessor :fees
 
-    # Value is one of the following: `buy`: Buying an investment `sell`: Selling an investment `cancel`: A cancellation of a pending transaction  `cash`: Activity that modifies a cash position `fee`: A fee on the account `transfer`: Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
+    # Value is one of the following: `buy`: Buying an investment `sell`: Selling an investment `cancel`: A cancellation of a pending transaction `cash`: Activity that modifies a cash position `fee`: A fee on the account `transfer`: Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer  For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-schema).
     attr_accessor :type
 
-    # For descriptions of possible transaction subtypes, see [Investment transaction subtypes schema](/docs/api/accounts/#investment-transaction-subtypes-schema).
+    # For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-schema).
     attr_accessor :subtype
 
     # The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-`null`.
     attr_accessor :iso_currency_code
 
-    # The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.  See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
+    # The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.  See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
     attr_accessor :unofficial_currency_code
 
     class EnumAttributeValidator
@@ -112,7 +112,7 @@ module Plaid
         :'cancel_transaction_id' => :'String',
         :'account_id' => :'String',
         :'security_id' => :'String',
-        :'date' => :'String',
+        :'date' => :'Date',
         :'name' => :'String',
         :'quantity' => :'Float',
         :'amount' => :'Float',

data/lib/plaid/models/investments_default_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.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/investments_holdings_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.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/investments_holdings_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.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/investments_transactions_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.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/investments_transactions_get_request_options.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
@@ -96,8 +96,8 @@ module Plaid
         invalid_properties.push('invalid value for "count", must be smaller than or equal to 500.')
       end
 
-      if !@count.nil? && @count < 0
-        invalid_properties.push('invalid value for "count", must be greater than or equal to 0.')
+      if !@count.nil? && @count < 1
+        invalid_properties.push('invalid value for "count", must be greater than or equal to 1.')
       end
 
 
@@ -113,7 +113,7 @@ module Plaid
     # @return true if the model is valid
     def valid?
       return false if !@count.nil? && @count > 500
-      return false if !@count.nil? && @count < 0
+      return false if !@count.nil? && @count < 1
       return false if !@offset.nil? && @offset < 0
       true
     end
@@ -125,8 +125,8 @@ module Plaid
         fail ArgumentError, 'invalid value for "count", must be smaller than or equal to 500.'
       end
 
-      if !count.nil? && count < 0
-        fail ArgumentError, 'invalid value for "count", must be greater than or equal to 0.'
+      if !count.nil? && count < 1
+        fail ArgumentError, 'invalid value for "count", must be greater than or equal to 1.'
       end
 
 

data/lib/plaid/models/investments_transactions_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.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/investments_transactions_override.rb

@@ -0,0 +1,319 @@
+=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
+  # Specify the list of investments transactions on the account.
+  class InvestmentsTransactionsOverride
+    # Posting date for the transaction. Must be formatted as an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date.
+    attr_accessor :date
+
+    # The institution's description of the transaction.
+    attr_accessor :name
+
+    # The number of units of the security involved in this transaction. Must be positive if the type is a buy and negative if the type is a sell.
+    attr_accessor :quantity
+
+    # The price of the security at which this transaction occurred.
+    attr_accessor :price
+
+    # The combined value of all fees applied to this transaction.
+    attr_accessor :fees
+
+    # The type of the investment transaction. Possible values are: `buy`: Buying an investment `sell`: Selling an investment `cash`: Activity that modifies a cash position `fee`: A fee on the account `transfer`: Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
+    attr_accessor :type
+
+    # Either a valid `iso_currency_code` or `unofficial_currency_code`
+    attr_accessor :currency
+
+    attr_accessor :security
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'date' => :'date',
+        :'name' => :'name',
+        :'quantity' => :'quantity',
+        :'price' => :'price',
+        :'fees' => :'fees',
+        :'type' => :'type',
+        :'currency' => :'currency',
+        :'security' => :'security'
+      }
+    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
+      {
+        :'date' => :'Date',
+        :'name' => :'String',
+        :'quantity' => :'Float',
+        :'price' => :'Float',
+        :'fees' => :'Float',
+        :'type' => :'String',
+        :'currency' => :'String',
+        :'security' => :'SecurityOverride'
+      }
+    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::InvestmentsTransactionsOverride` 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::InvestmentsTransactionsOverride`. 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?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      end
+
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      end
+
+      if attributes.key?(:'fees')
+        self.fees = attributes[:'fees']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'security')
+        self.security = attributes[:'security']
+      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 @date.nil?
+        invalid_properties.push('invalid value for "date", date cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @quantity.nil?
+        invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
+      end
+
+      if @price.nil?
+        invalid_properties.push('invalid value for "price", price cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency 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 @date.nil?
+      return false if @name.nil?
+      return false if @quantity.nil?
+      return false if @price.nil?
+      return false if @type.nil?
+      return false if @currency.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 &&
+          date == o.date &&
+          name == o.name &&
+          quantity == o.quantity &&
+          price == o.price &&
+          fees == o.fees &&
+          type == o.type &&
+          currency == o.currency &&
+          security == o.security
+    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
+      [date, name, quantity, price, fees, type, currency, security].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