plaid 15.11.0 → 18.0.0

data/lib/plaid/models/fdx_party_registry.rb

@@ -0,0 +1,41 @@
+=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
+  class FDXPartyRegistry
+    FDX = "FDX".freeze
+    GLEIF = "GLEIF".freeze
+    ICANN = "ICANN".freeze
+    PRIVATE = "PRIVATE".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end

data/lib/plaid/models/fdx_party_type.rb

@@ -0,0 +1,43 @@
+=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
+  class FDXPartyType
+    DATA_ACCESS_PLATFORM = "DATA_ACCESS_PLATFORM".freeze
+    DATA_PROVIDER = "DATA_PROVIDER".freeze
+    DATA_RECIPIENT = "DATA_RECIPIENT".freeze
+    INDIVIDUAL = "INDIVIDUAL".freeze
+    MERCHANT = "MERCHANT".freeze
+    VENDOR = "VENDOR".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end

data/lib/plaid/models/fdxfi_attribute.rb

@@ -0,0 +1,230 @@
+=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
+  # Financial Institution provider-specific attribute
+  class FDXFiAttribute
+    # Name of attribute
+    attr_accessor :name
+
+    # Value of attribute
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'value' => :'value'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'value' => :'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::FDXFiAttribute` 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::FDXFiAttribute`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      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 &&
+          name == o.name &&
+          value == o.value
+    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
+      [name, value].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/form1099_type.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/freddie_report_type.rb

@@ -0,0 +1,38 @@
+=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
+  class FreddieReportType
+    VERIFICATION_OF_EMPLOYMENT = "VERIFICATION_OF_EMPLOYMENT".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
+      value
+    end
+  end
+
+end

data/lib/plaid/models/generic_screening_hit_location_items.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/health_incident.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
@@ -56,6 +56,7 @@ module Plaid
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'end_date',
       ])
     end
 

data/lib/plaid/models/historical_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.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/historical_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 historical transaction pull is completed and Plaid has prepared as much historical transaction data as possible for the Item. Once this webhook has been fired, transaction data beyond 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 historical transaction pull is completed and Plaid has prepared as much historical transaction data as possible for the Item. Once this webhook has been fired, transaction data beyond 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 HistoricalUpdateWebhook
     # `TRANSACTIONS`
     attr_accessor :webhook_type
@@ -30,6 +30,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
       {
@@ -37,7 +39,8 @@ module Plaid
         :'webhook_code' => :'webhook_code',
         :'error' => :'error',
         :'new_transactions' => :'new_transactions',
-        :'item_id' => :'item_id'
+        :'item_id' => :'item_id',
+        :'environment' => :'environment'
       }
     end
 
@@ -53,7 +56,8 @@ module Plaid
         :'webhook_code' => :'String',
         :'error' => :'PlaidError',
         :'new_transactions' => :'Float',
-        :'item_id' => :'String'
+        :'item_id' => :'String',
+        :'environment' => :'WebhookEnvironmentValues'
       }
     end
 
@@ -98,6 +102,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?
@@ -120,6 +128,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
 
@@ -130,6 +142,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
 
@@ -142,7 +155,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
@@ -154,7 +168,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/holding.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
@@ -19,7 +19,7 @@ module Plaid
     # The Plaid `account_id` associated with the holding.
     attr_accessor :account_id
 
-    # The Plaid `security_id` associated with the holding.
+    # The Plaid `security_id` associated with the holding. Security data is not specific to a user's account; any user who held the same security at the same financial institution at the same time would have identical security data. The `security_id` for the same security will typically be the same across different institutions, but this is not guaranteed. The `security_id` does not typically change, but may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.
     attr_accessor :security_id
 
     # The last price given by the institution for this security.
@@ -34,7 +34,7 @@ module Plaid
     # The value of the holding, as reported by the institution.
     attr_accessor :institution_value
 
-    # The original total value or the purchase price per share of the holding. This field is an aggregate on a per holding basis and dependent on the information provided by the institution.
+    # The original total value of the holding. This field is calculated by Plaid as the sum of the purchase price of all of the shares in the holding.
     attr_accessor :cost_basis
 
     # The total quantity of the asset held, as reported by the financial institution. If the security is an option, `quantity` will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.

data/lib/plaid/models/holdings_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.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 new or updated holdings have been detected on an investment account. The webhook typically fires once per day, after market close, in response to any newly added holdings or price changes to existing holdings.
+  # Fired when new or updated holdings have been detected on an investment account. The webhook typically fires in response to any newly added holdings or price changes to existing holdings, most commonly after market close.
   class HoldingsDefaultUpdateWebhook
     # `HOLDINGS`
     attr_accessor :webhook_type
@@ -33,6 +33,8 @@ module Plaid
     # The number of updated holdings reported since the last time this webhook was fired.
     attr_accessor :updated_holdings
 
+    attr_accessor :environment
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -41,7 +43,8 @@ module Plaid
         :'item_id' => :'item_id',
         :'error' => :'error',
         :'new_holdings' => :'new_holdings',
-        :'updated_holdings' => :'updated_holdings'
+        :'updated_holdings' => :'updated_holdings',
+        :'environment' => :'environment'
       }
     end
 
@@ -58,7 +61,8 @@ module Plaid
         :'item_id' => :'String',
         :'error' => :'PlaidError',
         :'new_holdings' => :'Float',
-        :'updated_holdings' => :'Float'
+        :'updated_holdings' => :'Float',
+        :'environment' => :'WebhookEnvironmentValues'
       }
     end
 
@@ -107,6 +111,10 @@ module Plaid
       if attributes.key?(:'updated_holdings')
         self.updated_holdings = attributes[:'updated_holdings']
       end
+
+      if attributes.key?(:'environment')
+        self.environment = attributes[:'environment']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -133,6 +141,10 @@ module Plaid
         invalid_properties.push('invalid value for "updated_holdings", updated_holdings cannot be nil.')
       end
 
+      if @environment.nil?
+        invalid_properties.push('invalid value for "environment", environment cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -144,6 +156,7 @@ module Plaid
       return false if @item_id.nil?
       return false if @new_holdings.nil?
       return false if @updated_holdings.nil?
+      return false if @environment.nil?
       true
     end
 
@@ -157,7 +170,8 @@ module Plaid
           item_id == o.item_id &&
           error == o.error &&
           new_holdings == o.new_holdings &&
-          updated_holdings == o.updated_holdings
+          updated_holdings == o.updated_holdings &&
+          environment == o.environment
     end
 
     # @see the `==` method
@@ -169,7 +183,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [webhook_type, webhook_code, item_id, error, new_holdings, updated_holdings].hash
+      [webhook_type, webhook_code, item_id, error, new_holdings, updated_holdings, environment].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/holdings_override.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/id_number_type.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