plaid 17.0.0 → 17.2.0

data/lib/plaid/models/email_address_match_score.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.197.3
+The version of the OpenAPI document: 2020-09-14_1.210.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -17,12 +17,12 @@ module Plaid
   # Score found by matching email provided by the API with the email on the account at the financial institution. If the account contains multiple owners, the maximum match score is filled.
   class EmailAddressMatchScore
     # Match score for normalized email. 100 is a perfect match and 0 is a no match. If the email is missing from either the API or financial institution, this is empty.
-    attr_accessor :scores
+    attr_accessor :score
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'scores' => :'scores'
+        :'score' => :'score'
       }
     end
 
@@ -34,14 +34,14 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'scores' => :'Integer'
+        :'score' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'scores'
+        :'score'
       ])
     end
 
@@ -60,8 +60,8 @@ module Plaid
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'scores')
-        self.scores = attributes[:'scores']
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
       end
     end
 
@@ -83,7 +83,7 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          scores == o.scores
+          score == o.score
     end
 
     # @see the `==` method
@@ -95,7 +95,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [scores].hash
+      [score].hash
     end
 
     # Builds the object from hash

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/plaid/models/enhancements.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.197.3
+The version of the OpenAPI document: 2020-09-14_1.210.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -19,10 +19,10 @@ module Plaid
     # The name of the primary counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.
     attr_accessor :merchant_name
 
-    # The website associated with this transaction.
+    # The website associated with this transaction, if available.
     attr_accessor :website
 
-    # A link to the logo associated with this transaction. The logo will always be 100x100 resolution.
+    # The URL of a logo associated with this transaction, if available. The logo is formatted as a 100x100 pixel PNG file.
     attr_accessor :logo_url
 
     # The check number of the transaction. This field is only populated for check transactions.
@@ -40,7 +40,7 @@ module Plaid
 
     attr_accessor :personal_finance_category
 
-    # A link to the icon associated with the primary personal finance category. The logo will always be 100x100 resolution.
+    # A link to the icon associated with the primary personal finance category. The logo will always be 100x100 pixels.
     attr_accessor :personal_finance_category_icon_url
 
     # The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description.

data/lib/plaid/models/enrich_transaction_direction.rb

@@ -0,0 +1,39 @@
+=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.210.4
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class EnrichTransactionDirection
+    INFLOW = "INFLOW".freeze
+    OUTFLOW = "OUTFLOW".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/enrichments.rb

@@ -0,0 +1,347 @@
+=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.210.4
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # A grouping of the Plaid produced transaction enrichment fields.
+  class Enrichments
+    # The check number of the transaction. This field is only populated for check transactions.
+    attr_accessor :check_number
+
+    # The counterparties present in the transaction. Counterparties, such as the merchant or the financial institution, are extracted by Plaid from the raw description.
+    attr_accessor :counterparties
+
+    # The ID of the legacy category to which this transaction belongs. For a full list of legacy categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget).  We recommend using the `personal_finance_category` for transaction categorization to obtain the best results.
+    attr_accessor :legacy_category_id
+
+    # A hierarchical array of the legacy categories to which this transaction belongs. For a full list of legacy categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget).  We recommend using the `personal_finance_category` for transaction categorization to obtain the best results.
+    attr_accessor :legacy_category
+
+    attr_accessor :location
+
+    # The URL of a logo associated with this transaction, if available. The logo is formatted as a 100x100 pixel PNG file.
+    attr_accessor :logo_url
+
+    # The name of the primary counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.
+    attr_accessor :merchant_name
+
+    attr_accessor :payment_channel
+
+    attr_accessor :personal_finance_category
+
+    # A link to the icon associated with the primary personal finance category. The logo will always be 100x100 pixels.
+    attr_accessor :personal_finance_category_icon_url
+
+    # The website associated with this transaction.
+    attr_accessor :website
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'check_number' => :'check_number',
+        :'counterparties' => :'counterparties',
+        :'legacy_category_id' => :'legacy_category_id',
+        :'legacy_category' => :'legacy_category',
+        :'location' => :'location',
+        :'logo_url' => :'logo_url',
+        :'merchant_name' => :'merchant_name',
+        :'payment_channel' => :'payment_channel',
+        :'personal_finance_category' => :'personal_finance_category',
+        :'personal_finance_category_icon_url' => :'personal_finance_category_icon_url',
+        :'website' => :'website'
+      }
+    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
+      {
+        :'check_number' => :'String',
+        :'counterparties' => :'Array<Counterparty>',
+        :'legacy_category_id' => :'String',
+        :'legacy_category' => :'Array<String>',
+        :'location' => :'Location',
+        :'logo_url' => :'String',
+        :'merchant_name' => :'String',
+        :'payment_channel' => :'PaymentChannel',
+        :'personal_finance_category' => :'PersonalFinanceCategory',
+        :'personal_finance_category_icon_url' => :'String',
+        :'website' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'check_number',
+        :'legacy_category_id',
+        :'logo_url',
+        :'merchant_name',
+        :'personal_finance_category',
+        :'website'
+      ])
+    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::Enrichments` 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::Enrichments`. 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?(:'check_number')
+        self.check_number = attributes[:'check_number']
+      end
+
+      if attributes.key?(:'counterparties')
+        if (value = attributes[:'counterparties']).is_a?(Array)
+          self.counterparties = value
+        end
+      end
+
+      if attributes.key?(:'legacy_category_id')
+        self.legacy_category_id = attributes[:'legacy_category_id']
+      end
+
+      if attributes.key?(:'legacy_category')
+        if (value = attributes[:'legacy_category']).is_a?(Array)
+          self.legacy_category = value
+        end
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'logo_url')
+        self.logo_url = attributes[:'logo_url']
+      end
+
+      if attributes.key?(:'merchant_name')
+        self.merchant_name = attributes[:'merchant_name']
+      end
+
+      if attributes.key?(:'payment_channel')
+        self.payment_channel = attributes[:'payment_channel']
+      end
+
+      if attributes.key?(:'personal_finance_category')
+        self.personal_finance_category = attributes[:'personal_finance_category']
+      end
+
+      if attributes.key?(:'personal_finance_category_icon_url')
+        self.personal_finance_category_icon_url = attributes[:'personal_finance_category_icon_url']
+      end
+
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
+      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 @counterparties.nil?
+        invalid_properties.push('invalid value for "counterparties", counterparties cannot be nil.')
+      end
+
+      if @location.nil?
+        invalid_properties.push('invalid value for "location", location cannot be nil.')
+      end
+
+      if @payment_channel.nil?
+        invalid_properties.push('invalid value for "payment_channel", payment_channel cannot be nil.')
+      end
+
+      if @personal_finance_category_icon_url.nil?
+        invalid_properties.push('invalid value for "personal_finance_category_icon_url", personal_finance_category_icon_url 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 @counterparties.nil?
+      return false if @location.nil?
+      return false if @payment_channel.nil?
+      return false if @personal_finance_category_icon_url.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 &&
+          check_number == o.check_number &&
+          counterparties == o.counterparties &&
+          legacy_category_id == o.legacy_category_id &&
+          legacy_category == o.legacy_category &&
+          location == o.location &&
+          logo_url == o.logo_url &&
+          merchant_name == o.merchant_name &&
+          payment_channel == o.payment_channel &&
+          personal_finance_category == o.personal_finance_category &&
+          personal_finance_category_icon_url == o.personal_finance_category_icon_url &&
+          website == o.website
+    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
+      [check_number, counterparties, legacy_category_id, legacy_category, location, logo_url, merchant_name, payment_channel, personal_finance_category, personal_finance_category_icon_url, website].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/entity_document.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.197.3
+The version of the OpenAPI document: 2020-09-14_1.210.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

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

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

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

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

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

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