plaid 14.0.0.beta.4 → 14.2.0

data/lib/plaid/api_client.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
@@ -30,7 +30,7 @@ module Plaid
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Plaid Ruby v#{VERSION}"
+      @user_agent = "Plaid Ruby v#"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent,
@@ -71,7 +71,8 @@ module Plaid
           else
             fail ApiError.new(:code => response.status,
                               :response_headers => response.headers,
-                              :response_body => response.body),
+                              :response_body => response.body,
+                              :data => JSON.parse(response.body)),
                  response.reason_phrase
           end
         end
@@ -380,4 +381,4 @@ module Plaid
       end
     end
   end
-end
+end

data/lib/plaid/api_error.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
@@ -12,7 +12,7 @@ OpenAPI Generator version: 5.1.0
 
 module Plaid
   class ApiError < StandardError
-    attr_reader :code, :response_headers, :response_body
+    attr_reader :code, :response_headers, :response_body, :data
 
     # Usage examples:
     #   ApiError.new
@@ -54,4 +54,4 @@ module Plaid
       msg
     end
   end
-end
+end

data/lib/plaid/configuration.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
@@ -145,7 +145,9 @@ module Plaid
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
-      @api_key = {}
+      @api_key = {
+        'Plaid-Version' => '2020-09-14',
+      }
       @api_key_prefix = {}
       @timeout = 0
       @client_side_validation = true

data/lib/plaid/models/account_access.rb

@@ -0,0 +1,238 @@
+=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
+  # Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered `new_accounts`.
+  class AccountAccess
+    # The unique account identifier for this account. This value must match that returned by the data access API for this account.
+    attr_accessor :unique_id
+
+    # Allow the application to see this account (and associated details, including balance) in the list of accounts. If unset, defaults to `true`.
+    attr_accessor :authorized
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'unique_id' => :'unique_id',
+        :'authorized' => :'authorized'
+      }
+    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
+      {
+        :'unique_id' => :'String',
+        :'authorized' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'authorized'
+      ])
+    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::AccountAccess` 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::AccountAccess`. 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?(:'unique_id')
+        self.unique_id = attributes[:'unique_id']
+      end
+
+      if attributes.key?(:'authorized')
+        self.authorized = attributes[:'authorized']
+      else
+        self.authorized = true
+      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 @unique_id.nil?
+        invalid_properties.push('invalid value for "unique_id", unique_id 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 @unique_id.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 &&
+          unique_id == o.unique_id &&
+          authorized == o.authorized
+    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
+      [unique_id, authorized].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/account_assets.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
@@ -117,10 +117,6 @@ module Plaid
         :'mask',
         :'official_name',
         :'subtype',
-        :'verification_status',
-        :'days_available',
-        :'transactions',
-        :'historical_balances'
       ])
     end
 
@@ -222,10 +218,22 @@ module Plaid
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
+      if @days_available.nil?
+        invalid_properties.push('invalid value for "days_available", days_available cannot be nil.')
+      end
+
+      if @transactions.nil?
+        invalid_properties.push('invalid value for "transactions", transactions cannot be nil.')
+      end
+
       if @owners.nil?
         invalid_properties.push('invalid value for "owners", owners cannot be nil.')
       end
 
+      if @historical_balances.nil?
+        invalid_properties.push('invalid value for "historical_balances", historical_balances cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -236,16 +244,19 @@ module Plaid
       return false if @balances.nil?
       return false if @name.nil?
       return false if @type.nil?
-      verification_status_validator = EnumAttributeValidator.new('String', ["pending_automatic_verification", "pending_manual_verification", "manually_verified", "verification_expired", "verification_failed"])
+      verification_status_validator = EnumAttributeValidator.new('String', ["automatically_verified", "pending_automatic_verification", "pending_manual_verification", "manually_verified", "verification_expired", "verification_failed"])
       return false unless verification_status_validator.valid?(@verification_status)
+      return false if @days_available.nil?
+      return false if @transactions.nil?
       return false if @owners.nil?
+      return false if @historical_balances.nil?
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] verification_status Object to be assigned
     def verification_status=(verification_status)
-      validator = EnumAttributeValidator.new('String', ["pending_automatic_verification", "pending_manual_verification", "manually_verified", "verification_expired", "verification_failed"])
+      validator = EnumAttributeValidator.new('String', ["automatically_verified", "pending_automatic_verification", "pending_manual_verification", "manually_verified", "verification_expired", "verification_failed"])
       unless validator.valid?(verification_status)
         fail ArgumentError, "invalid value for \"verification_status\", must be one of #{validator.allowable_values}."
       end

data/lib/plaid/models/account_assets_all_of.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
@@ -55,9 +55,6 @@ module Plaid
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'days_available',
-        :'transactions',
-        :'historical_balances'
       ])
     end
 
@@ -103,17 +100,32 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @days_available.nil?
+        invalid_properties.push('invalid value for "days_available", days_available cannot be nil.')
+      end
+
+      if @transactions.nil?
+        invalid_properties.push('invalid value for "transactions", transactions cannot be nil.')
+      end
+
       if @owners.nil?
         invalid_properties.push('invalid value for "owners", owners cannot be nil.')
       end
 
+      if @historical_balances.nil?
+        invalid_properties.push('invalid value for "historical_balances", historical_balances 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 @days_available.nil?
+      return false if @transactions.nil?
       return false if @owners.nil?
+      return false if @historical_balances.nil?
       true
     end
 

data/lib/plaid/models/account_balance.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,10 +16,10 @@ require 'time'
 module Plaid
   # A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by `/accounts/balance/get`.
   class AccountBalance
-    # The amount of funds available to be withdrawn from the account, as determined by the financial institution.  For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows.  For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit.  For `investment`-type accounts, the `available` balance is the total cash available to withdraw as presented by the institution.  Note that not all institutions calculate the `available`  balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`.  Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`.
+    # The amount of funds available to be withdrawn from the account, as determined by the financial institution.  For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows.  For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit.  For `investment`-type accounts, the `available` balance is the total cash available to withdraw as presented by the institution.  Note that not all institutions calculate the `available`  balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`.  Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`.  If `current` is `null` this field is guaranteed not to be `null`.
     attr_accessor :available
 
-    # The total amount of funds in or owed by the account.  For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.  For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.  For `investment`-type accounts, the current balance is the total value of assets as presented by the institution.  Note that balance information may be cached unless the value was returned by `/accounts/balance/get`, and current balance information is typically not updated intra-day. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`.
+    # The total amount of funds in or owed by the account.  For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.  For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.  For `investment`-type accounts, the current balance is the total value of assets as presented by the institution.  Note that balance information may be cached unless the value was returned by `/accounts/balance/get`; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`.  When returned by `/accounts/balance/get`, this field may be `null`. When this happens, `available` is guaranteed not to be `null`.
     attr_accessor :current
 
     # For `credit`-type accounts, this represents the credit limit.  For `depository`-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.  In North America, this field is typically only available for `credit`-type accounts.
@@ -28,9 +28,12 @@ module Plaid
     # The ISO-4217 currency code of the balance. Always null if `unofficial_currency_code` is non-null.
     attr_accessor :iso_currency_code
 
-    # The unofficial currency code associated with the balance. 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 `unofficial_currency_code`s.
+    # The unofficial currency code associated with the balance. 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 `unofficial_currency_code`s.
     attr_accessor :unofficial_currency_code
 
+    # Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the last time that the balance for the given account has been updated  This is currently only provided when the `min_last_updated_datetime` is passed when calling `/accounts/balance/get` for `ins_128026` (Capital One).
+    attr_accessor :last_updated_datetime
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -38,7 +41,8 @@ module Plaid
         :'current' => :'current',
         :'limit' => :'limit',
         :'iso_currency_code' => :'iso_currency_code',
-        :'unofficial_currency_code' => :'unofficial_currency_code'
+        :'unofficial_currency_code' => :'unofficial_currency_code',
+        :'last_updated_datetime' => :'last_updated_datetime'
       }
     end
 
@@ -54,7 +58,8 @@ module Plaid
         :'current' => :'Float',
         :'limit' => :'Float',
         :'iso_currency_code' => :'String',
-        :'unofficial_currency_code' => :'String'
+        :'unofficial_currency_code' => :'String',
+        :'last_updated_datetime' => :'Time'
       }
     end
 
@@ -62,9 +67,11 @@ module Plaid
     def self.openapi_nullable
       Set.new([
         :'available',
+        :'current',
         :'limit',
         :'iso_currency_code',
-        :'unofficial_currency_code'
+        :'unofficial_currency_code',
+        :'last_updated_datetime'
       ])
     end
 
@@ -102,23 +109,22 @@ module Plaid
       if attributes.key?(:'unofficial_currency_code')
         self.unofficial_currency_code = attributes[:'unofficial_currency_code']
       end
+
+      if attributes.key?(:'last_updated_datetime')
+        self.last_updated_datetime = attributes[:'last_updated_datetime']
+      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 @current.nil?
-        invalid_properties.push('invalid value for "current", current 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 @current.nil?
       true
     end
 
@@ -131,7 +137,8 @@ module Plaid
           current == o.current &&
           limit == o.limit &&
           iso_currency_code == o.iso_currency_code &&
-          unofficial_currency_code == o.unofficial_currency_code
+          unofficial_currency_code == o.unofficial_currency_code &&
+          last_updated_datetime == o.last_updated_datetime
     end
 
     # @see the `==` method
@@ -143,7 +150,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [available, current, limit, iso_currency_code, unofficial_currency_code].hash
+      [available, current, limit, iso_currency_code, unofficial_currency_code, last_updated_datetime].hash
     end
 
     # Builds the object from hash