plaid 15.11.0 → 17.0.0

data/lib/plaid/models/credit_bank_income_source.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -24,7 +24,7 @@ module Plaid
 
     attr_accessor :income_category
 
-    # Plaid's unique idenfier for the account.
+    # Plaid's unique identifier for the account.
     attr_accessor :account_id
 
     # Minimum of all dates within the specific income sources in the user's bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).

data/lib/plaid/models/credit_bank_income_summary.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_bank_income_transaction.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.161.5
+The version of the OpenAPI document: 2020-09-14_1.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_bank_income_warning.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_bank_income_warning_code.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_bank_income_warning_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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_card_liability.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_category.rb

@@ -0,0 +1,240 @@
+=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.197.3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases.
+  class CreditCategory
+    # A high level category that communicates the broad category of the transaction.
+    attr_accessor :primary
+
+    # A granular category conveying the transaction's intent. This field can also be used as a unique identifier for the category.
+    attr_accessor :detailed
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'primary' => :'primary',
+        :'detailed' => :'detailed'
+      }
+    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
+      {
+        :'primary' => :'String',
+        :'detailed' => :'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::CreditCategory` 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::CreditCategory`. 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?(:'primary')
+        self.primary = attributes[:'primary']
+      end
+
+      if attributes.key?(:'detailed')
+        self.detailed = attributes[:'detailed']
+      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 @primary.nil?
+        invalid_properties.push('invalid value for "primary", primary cannot be nil.')
+      end
+
+      if @detailed.nil?
+        invalid_properties.push('invalid value for "detailed", detailed 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 @primary.nil?
+      return false if @detailed.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 &&
+          primary == o.primary &&
+          detailed == o.detailed
+    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
+      [primary, detailed].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/credit_document_metadata.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -19,7 +19,7 @@ module Plaid
     # The name of the document.
     attr_accessor :name
 
-    # The type of document.  `PAYSTUB`: A paystub.  `BANK_STATEMENT`: A bank statement.  `US_TAX_W2`: A W-2 wage and tax statement provided by a US employer reflecting wages earned by the employee.  `US_MILITARY_ERAS`: An electronic Retirement Account Statement (eRAS) issued by the US military.  `US_MILITARY_LES`: A Leave and Earnings Statement (LES) issued by the US military.  `US_MILITARY_CLES`: A Civilian Leave and Earnings Statment (CLES) issued by the US military.  `GIG`: Used to indicate that the income is related to gig work. Does not necessarily correspond to a specific document type.  `NONE`: Used to indicate that there is no underlying document for the data.  `UNKNOWN`: Document type could not be determined.
+    # The type of document.  `PAYSTUB`: A paystub.  `BANK_STATEMENT`: A bank statement.  `US_TAX_W2`: A W-2 wage and tax statement provided by a US employer reflecting wages earned by the employee.  `US_MILITARY_ERAS`: An electronic Retirement Account Statement (eRAS) issued by the US military.  `US_MILITARY_LES`: A Leave and Earnings Statement (LES) issued by the US military.  `US_MILITARY_CLES`: A Civilian Leave and Earnings Statment (CLES) issued by the US military.  `GIG`: Used to indicate that the income is related to gig work. Does not necessarily correspond to a specific document type.  `PLAID_GENERATED_PAYSTUB_PDF`: Used to indicate that the PDF for the paystub was generated by Plaid.  `NONE`: Used to indicate that there is no underlying document for the data.  `UNKNOWN`: Document type could not be determined.
     attr_accessor :document_type
 
     # Signed URL to retrieve the underlying file.

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

data/lib/plaid/models/credit_employment_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.161.5
+The version of the OpenAPI document: 2020-09-14_1.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -86,14 +86,6 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @client_id.nil?
-        invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
-      end
-
-      if @secret.nil?
-        invalid_properties.push('invalid value for "secret", secret cannot be nil.')
-      end
-
       if @user_token.nil?
         invalid_properties.push('invalid value for "user_token", user_token cannot be nil.')
       end
@@ -104,8 +96,6 @@ module Plaid
     # 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 @client_id.nil?
-      return false if @secret.nil?
       return false if @user_token.nil?
       true
     end

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

data/lib/plaid/models/credit_employment_item.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -21,15 +21,15 @@ module Plaid
 
     attr_accessor :employments
 
-    # A reference id to reference what payroll data was returned from this endpoint
-    attr_accessor :pull_id
+    # Token to represent the underlying Employment data
+    attr_accessor :employment_report_token
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'item_id' => :'item_id',
         :'employments' => :'employments',
-        :'pull_id' => :'pull_id'
+        :'employment_report_token' => :'employment_report_token'
       }
     end
 
@@ -43,7 +43,7 @@ module Plaid
       {
         :'item_id' => :'String',
         :'employments' => :'Array<CreditEmploymentVerification>',
-        :'pull_id' => :'String'
+        :'employment_report_token' => :'String'
       }
     end
 
@@ -78,8 +78,8 @@ module Plaid
         end
       end
 
-      if attributes.key?(:'pull_id')
-        self.pull_id = attributes[:'pull_id']
+      if attributes.key?(:'employment_report_token')
+        self.employment_report_token = attributes[:'employment_report_token']
       end
     end
 
@@ -95,10 +95,6 @@ module Plaid
         invalid_properties.push('invalid value for "employments", employments cannot be nil.')
       end
 
-      if @pull_id.nil?
-        invalid_properties.push('invalid value for "pull_id", pull_id cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -107,7 +103,6 @@ module Plaid
     def valid?
       return false if @item_id.nil?
       return false if @employments.nil?
-      return false if @pull_id.nil?
       true
     end
 
@@ -118,7 +113,7 @@ module Plaid
       self.class == o.class &&
           item_id == o.item_id &&
           employments == o.employments &&
-          pull_id == o.pull_id
+          employment_report_token == o.employment_report_token
     end
 
     # @see the `==` method
@@ -130,7 +125,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [item_id, employments, pull_id].hash
+      [item_id, employments, employment_report_token].hash
     end
 
     # Builds the object from hash

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

data/lib/plaid/models/credit_filter.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.161.5
+The version of the OpenAPI document: 2020-09-14_1.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_pay_stub.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -33,8 +33,6 @@ module Plaid
 
     attr_accessor :pay_period_details
 
-    attr_accessor :verification
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -45,8 +43,7 @@ module Plaid
         :'employee' => :'employee',
         :'employer' => :'employer',
         :'net_pay' => :'net_pay',
-        :'pay_period_details' => :'pay_period_details',
-        :'verification' => :'verification'
+        :'pay_period_details' => :'pay_period_details'
       }
     end
 
@@ -65,8 +62,7 @@ module Plaid
         :'employee' => :'CreditPayStubEmployee',
         :'employer' => :'CreditPayStubEmployer',
         :'net_pay' => :'CreditPayStubNetPay',
-        :'pay_period_details' => :'PayStubPayPeriodDetails',
-        :'verification' => :'CreditPayStubVerification'
+        :'pay_period_details' => :'PayStubPayPeriodDetails'
       }
     end
 
@@ -74,7 +70,6 @@ module Plaid
     def self.openapi_nullable
       Set.new([
         :'document_id',
-        :'verification'
       ])
     end
 
@@ -124,10 +119,6 @@ module Plaid
       if attributes.key?(:'pay_period_details')
         self.pay_period_details = attributes[:'pay_period_details']
       end
-
-      if attributes.key?(:'verification')
-        self.verification = attributes[:'verification']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -190,8 +181,7 @@ module Plaid
           employee == o.employee &&
           employer == o.employer &&
           net_pay == o.net_pay &&
-          pay_period_details == o.pay_period_details &&
-          verification == o.verification
+          pay_period_details == o.pay_period_details
     end
 
     # @see the `==` method
@@ -203,7 +193,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [deductions, document_id, document_metadata, earnings, employee, employer, net_pay, pay_period_details, verification].hash
+      [deductions, document_id, document_metadata, earnings, employee, employer, net_pay, pay_period_details].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/credit_pay_stub_address.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_pay_stub_deductions.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_pay_stub_earnings.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

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

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

data/lib/plaid/models/credit_pay_stub_net_pay.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.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

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

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