plaid 17.0.0 → 17.2.0

data/lib/plaid/models/transactions_enrich_request_options.rb

@@ -0,0 +1,222 @@
+=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
+  # An optional object to be used with the request.
+  class TransactionsEnrichRequestOptions
+    # Include `legacy_category` and `legacy_category_id` in the response (in addition to the default `personal_finance_category`).   Categories are based on Plaid's legacy taxonomy. For a full list of legacy categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget).
+    attr_accessor :include_legacy_category
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'include_legacy_category' => :'include_legacy_category'
+      }
+    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
+      {
+        :'include_legacy_category' => :'Boolean'
+      }
+    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::TransactionsEnrichRequestOptions` 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::TransactionsEnrichRequestOptions`. 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?(:'include_legacy_category')
+        self.include_legacy_category = attributes[:'include_legacy_category']
+      else
+        self.include_legacy_category = false
+      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 &&
+          include_legacy_category == o.include_legacy_category
+    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
+      [include_legacy_category].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/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.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/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.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
@@ -34,6 +34,9 @@ module Plaid
     # Include the [`personal_finance_category`](https://plaid.com/docs/api/products/transactions/#transactions-get-response-transactions-personal-finance-category) object in the response.  See the [`taxonomy csv file`](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.  We’re introducing Category Rules - a new beta endpoint that will enable you to change the `personal_finance_category` for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to transactions-feedback@plaid.com.
     attr_accessor :include_personal_finance_category
 
+    # Include counterparties and extran merchant fields in the transaction. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.
+    attr_accessor :include_logo_and_counterparty_beta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -42,7 +45,8 @@ module Plaid
         :'offset' => :'offset',
         :'include_original_description' => :'include_original_description',
         :'include_personal_finance_category_beta' => :'include_personal_finance_category_beta',
-        :'include_personal_finance_category' => :'include_personal_finance_category'
+        :'include_personal_finance_category' => :'include_personal_finance_category',
+        :'include_logo_and_counterparty_beta' => :'include_logo_and_counterparty_beta'
       }
     end
 
@@ -59,7 +63,8 @@ module Plaid
         :'offset' => :'Integer',
         :'include_original_description' => :'Boolean',
         :'include_personal_finance_category_beta' => :'Boolean',
-        :'include_personal_finance_category' => :'Boolean'
+        :'include_personal_finance_category' => :'Boolean',
+        :'include_logo_and_counterparty_beta' => :'Boolean'
       }
     end
 
@@ -120,6 +125,12 @@ module Plaid
       else
         self.include_personal_finance_category = false
       end
+
+      if attributes.key?(:'include_logo_and_counterparty_beta')
+        self.include_logo_and_counterparty_beta = attributes[:'include_logo_and_counterparty_beta']
+      else
+        self.include_logo_and_counterparty_beta = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -188,7 +199,8 @@ module Plaid
           offset == o.offset &&
           include_original_description == o.include_original_description &&
           include_personal_finance_category_beta == o.include_personal_finance_category_beta &&
-          include_personal_finance_category == o.include_personal_finance_category
+          include_personal_finance_category == o.include_personal_finance_category &&
+          include_logo_and_counterparty_beta == o.include_logo_and_counterparty_beta
     end
 
     # @see the `==` method
@@ -200,7 +212,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_ids, count, offset, include_original_description, include_personal_finance_category_beta, include_personal_finance_category].hash
+      [account_ids, count, offset, include_original_description, include_personal_finance_category_beta, include_personal_finance_category, include_logo_and_counterparty_beta].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/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.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/transactions_recurring_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/transactions_recurring_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.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/transactions_recurring_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/transactions_refresh_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/transactions_refresh_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/transactions_removed_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.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/transactions_rule_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/transactions_rule_field.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/transactions_rule_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/transactions_rules_create_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/transactions_rules_create_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/transactions_rules_list_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/transactions_rules_list_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/transactions_rules_remove_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/transactions_rules_remove_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/transactions_sync_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/transactions_sync_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.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
@@ -22,11 +22,15 @@ module Plaid
     # Include the [`personal_finance_category`](https://plaid.com/docs/api/products/transactions/#transactions-sync-response-added-personal-finance-category) object in the response.  See the [`taxonomy csv file`](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) for a full list of personal finance categories.  We’re introducing Category Rules - a new beta endpoint that will enable you to change the `personal_finance_category` for a transaction based on your users’ needs. When rules are set, the selected category will override the Plaid provided category. To learn more, send a note to transactions-feedback@plaid.com.
     attr_accessor :include_personal_finance_category
 
+    # Include counterparties and extra merchant fields in the transaction. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.
+    attr_accessor :include_logo_and_counterparty_beta
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'include_original_description' => :'include_original_description',
-        :'include_personal_finance_category' => :'include_personal_finance_category'
+        :'include_personal_finance_category' => :'include_personal_finance_category',
+        :'include_logo_and_counterparty_beta' => :'include_logo_and_counterparty_beta'
       }
     end
 
@@ -39,7 +43,8 @@ module Plaid
     def self.openapi_types
       {
         :'include_original_description' => :'Boolean',
-        :'include_personal_finance_category' => :'Boolean'
+        :'include_personal_finance_category' => :'Boolean',
+        :'include_logo_and_counterparty_beta' => :'Boolean'
       }
     end
 
@@ -76,6 +81,12 @@ module Plaid
       else
         self.include_personal_finance_category = false
       end
+
+      if attributes.key?(:'include_logo_and_counterparty_beta')
+        self.include_logo_and_counterparty_beta = attributes[:'include_logo_and_counterparty_beta']
+      else
+        self.include_logo_and_counterparty_beta = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -97,7 +108,8 @@ module Plaid
       return true if self.equal?(o)
       self.class == o.class &&
           include_original_description == o.include_original_description &&
-          include_personal_finance_category == o.include_personal_finance_category
+          include_personal_finance_category == o.include_personal_finance_category &&
+          include_logo_and_counterparty_beta == o.include_logo_and_counterparty_beta
     end
 
     # @see the `==` method
@@ -109,7 +121,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [include_original_description, include_personal_finance_category].hash
+      [include_original_description, include_personal_finance_category, include_logo_and_counterparty_beta].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transactions_sync_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
@@ -25,10 +25,10 @@ module Plaid
     # Transactions that have been removed from the item since `cursor` ordered by ascending last modified time.
     attr_accessor :removed
 
-    # Cursor used for fetching any future updates after the latest update provided in this response.
+    # Cursor used for fetching any future updates after the latest update provided in this response. The cursor obtained after all pages have been pulled (indicated by `has_more` being `false`) will be valid for at least 1 year. This cursor should be persisted for later calls.
     attr_accessor :next_cursor
 
-    # Represents if more than requested count of transaction updates exist. If true, the additional updates can be fetched by making an additional request with `cursor` set to `next_cursor`.
+    # Represents if more than requested count of transaction updates exist. If true, the additional updates can be fetched by making an additional request with `cursor` set to `next_cursor`. If `has_more` is true, it’s important to pull all available pages, to make it less likely for underlying data changes to conflict with pagination.
     attr_accessor :has_more
 
     # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.