plaid 14.4.0 → 14.8.0

data/lib/plaid/models/income_verification_precheck_employer_address.rb

@@ -0,0 +1,280 @@
+=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.46.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # The address of the employer
+  class IncomeVerificationPrecheckEmployerAddress
+    # The full city name
+    attr_accessor :city
+
+    # The region or state Example: `\"NC\"`
+    attr_accessor :region
+
+    # The full street address Example: `\"564 Main Street, APT 15\"`
+    attr_accessor :street
+
+    # The postal code
+    attr_accessor :postal_code
+
+    # The ISO 3166-1 alpha-2 country code
+    attr_accessor :country
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'city' => :'city',
+        :'region' => :'region',
+        :'street' => :'street',
+        :'postal_code' => :'postal_code',
+        :'country' => :'country'
+      }
+    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
+      {
+        :'city' => :'String',
+        :'region' => :'String',
+        :'street' => :'String',
+        :'postal_code' => :'String',
+        :'country' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'region',
+        :'postal_code',
+        :'country'
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'AddressData'
+      ]
+    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::IncomeVerificationPrecheckEmployerAddress` 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::IncomeVerificationPrecheckEmployerAddress`. 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?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'street')
+        self.street = attributes[:'street']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      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 @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @street.nil?
+        invalid_properties.push('invalid value for "street", street 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 @city.nil?
+      return false if @street.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 &&
+          city == o.city &&
+          region == o.region &&
+          street == o.street &&
+          postal_code == o.postal_code &&
+          country == o.country
+    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
+      [city, region, street, postal_code, country].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/income_verification_precheck_military_info.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.34.1
+The version of the OpenAPI document: 2020-09-14_1.46.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

data/lib/plaid/models/income_verification_precheck_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.34.1
+The version of the OpenAPI document: 2020-09-14_1.46.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -29,6 +29,9 @@ module Plaid
     # The access token associated with the Item data is being requested for.
     attr_accessor :transactions_access_token
 
+    # An array of access tokens corresponding to the Items that will be cross-referenced with the product data. If the `transactions` product was not initialized for the Items during link, it will be initialized after this Link session.
+    attr_accessor :transactions_access_tokens
+
     attr_accessor :us_military_info
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -39,6 +42,7 @@ module Plaid
         :'user' => :'user',
         :'employer' => :'employer',
         :'transactions_access_token' => :'transactions_access_token',
+        :'transactions_access_tokens' => :'transactions_access_tokens',
         :'us_military_info' => :'us_military_info'
       }
     end
@@ -56,6 +60,7 @@ module Plaid
         :'user' => :'IncomeVerificationPrecheckUser',
         :'employer' => :'IncomeVerificationPrecheckEmployer',
         :'transactions_access_token' => :'String',
+        :'transactions_access_tokens' => :'Array<String>',
         :'us_military_info' => :'IncomeVerificationPrecheckMilitaryInfo'
       }
     end
@@ -105,6 +110,12 @@ module Plaid
         self.transactions_access_token = attributes[:'transactions_access_token']
       end
 
+      if attributes.key?(:'transactions_access_tokens')
+        if (value = attributes[:'transactions_access_tokens']).is_a?(Array)
+          self.transactions_access_tokens = value
+        end
+      end
+
       if attributes.key?(:'us_military_info')
         self.us_military_info = attributes[:'us_military_info']
       end
@@ -133,6 +144,7 @@ module Plaid
           user == o.user &&
           employer == o.employer &&
           transactions_access_token == o.transactions_access_token &&
+          transactions_access_tokens == o.transactions_access_tokens &&
           us_military_info == o.us_military_info
     end
 
@@ -145,7 +157,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, user, employer, transactions_access_token, us_military_info].hash
+      [client_id, secret, user, employer, transactions_access_token, transactions_access_tokens, us_military_info].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/income_verification_precheck_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.34.1
+The version of the OpenAPI document: 2020-09-14_1.46.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -22,31 +22,8 @@ module Plaid
     # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
     attr_accessor :request_id
 
-    # The confidence that Plaid can support the user in the income verification flow. One of the following:  `\"HIGH\"`: This precheck information submitted is definitively tied to a Plaid-supported integration.  \"`LOW`\": This precheck information submitted is known not to be supported by Plaid.  `\"UNKNOWN\"`: It was not possible to determine if the user is supportable with the information passed.
     attr_accessor :confidence
 
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
-
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -66,7 +43,7 @@ module Plaid
       {
         :'precheck_id' => :'String',
         :'request_id' => :'String',
-        :'confidence' => :'String'
+        :'confidence' => :'IncomeVerificationPrecheckConfidence'
       }
     end
 
@@ -129,21 +106,9 @@ module Plaid
       return false if @precheck_id.nil?
       return false if @request_id.nil?
       return false if @confidence.nil?
-      confidence_validator = EnumAttributeValidator.new('String', ["HIGH", "LOW", "UNKNOWN"])
-      return false unless confidence_validator.valid?(@confidence)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] confidence Object to be assigned
-    def confidence=(confidence)
-      validator = EnumAttributeValidator.new('String', ["HIGH", "LOW", "UNKNOWN"])
-      unless validator.valid?(confidence)
-        fail ArgumentError, "invalid value for \"confidence\", must be one of #{validator.allowable_values}."
-      end
-      @confidence = confidence
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

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

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

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

data/lib/plaid/models/income_verification_status_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.34.1
+The version of the OpenAPI document: 2020-09-14_1.46.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -25,7 +25,10 @@ module Plaid
     # The `income_verification_id` of the verification instance whose status is being reported.
     attr_accessor :income_verification_id
 
-    # `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed.  `VERIFICATION_STATUS_UPLOAD_ERROR`: An upload error occurred when the end user attempted to upload their verification documentation.  `VERIFICATION_STATUS_INVALID_TYPE`: The end user attempted to upload verification documentation in an unsupported file format.  `VERIFICATION_STATUS_DOCUMENT_REJECTED`: The documentation uploaded by the end user was recognized as a supported file format, but not recognized as a valid paystub.  `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation.
+    # The Item ID associated with the verification.
+    attr_accessor :item_id
+
+    # `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed. If the user uploaded multiple documents, this status means that at least one document was processed successfully.   `VERIFICATION_STATUS_DOCUMENT_REJECTED`: The documentation uploaded by the end user was recognized as a supported file format, but not recognized as a valid verification document. Common causes include poor image quality or the document not being an acceptable income verification document.  `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation.  `VERIFICATION_STATUS_PENDING_APPROVAL`: The income verification has been sent to the user for review.
     attr_accessor :verification_status
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -34,6 +37,7 @@ module Plaid
         :'webhook_type' => :'webhook_type',
         :'webhook_code' => :'webhook_code',
         :'income_verification_id' => :'income_verification_id',
+        :'item_id' => :'item_id',
         :'verification_status' => :'verification_status'
       }
     end
@@ -49,6 +53,7 @@ module Plaid
         :'webhook_type' => :'String',
         :'webhook_code' => :'String',
         :'income_verification_id' => :'String',
+        :'item_id' => :'String',
         :'verification_status' => :'String'
       }
     end
@@ -86,6 +91,10 @@ module Plaid
         self.income_verification_id = attributes[:'income_verification_id']
       end
 
+      if attributes.key?(:'item_id')
+        self.item_id = attributes[:'item_id']
+      end
+
       if attributes.key?(:'verification_status')
         self.verification_status = attributes[:'verification_status']
       end
@@ -107,6 +116,10 @@ module Plaid
         invalid_properties.push('invalid value for "income_verification_id", income_verification_id cannot be nil.')
       end
 
+      if @item_id.nil?
+        invalid_properties.push('invalid value for "item_id", item_id cannot be nil.')
+      end
+
       if @verification_status.nil?
         invalid_properties.push('invalid value for "verification_status", verification_status cannot be nil.')
       end
@@ -120,6 +133,7 @@ module Plaid
       return false if @webhook_type.nil?
       return false if @webhook_code.nil?
       return false if @income_verification_id.nil?
+      return false if @item_id.nil?
       return false if @verification_status.nil?
       true
     end
@@ -132,6 +146,7 @@ module Plaid
           webhook_type == o.webhook_type &&
           webhook_code == o.webhook_code &&
           income_verification_id == o.income_verification_id &&
+          item_id == o.item_id &&
           verification_status == o.verification_status
     end
 
@@ -144,7 +159,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [webhook_type, webhook_code, income_verification_id, verification_status].hash
+      [webhook_type, webhook_code, income_verification_id, item_id, verification_status].hash
     end
 
     # Builds the object from hash

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

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

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

data/lib/plaid/models/income_verification_taxforms_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.34.1
+The version of the OpenAPI document: 2020-09-14_1.46.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -19,19 +19,19 @@ module Plaid
     # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
     attr_accessor :request_id
 
+    attr_accessor :document_metadata
+
     # A list of taxforms.
     attr_accessor :taxforms
 
-    attr_accessor :document_metadata
-
     attr_accessor :error
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'request_id' => :'request_id',
-        :'taxforms' => :'taxforms',
         :'document_metadata' => :'document_metadata',
+        :'taxforms' => :'taxforms',
         :'error' => :'error'
       }
     end
@@ -45,8 +45,8 @@ module Plaid
     def self.openapi_types
       {
         :'request_id' => :'String',
-        :'taxforms' => :'Array<Taxform>',
         :'document_metadata' => :'Array<DocumentMetadata>',
+        :'taxforms' => :'Array<Taxform>',
         :'error' => :'Error'
       }
     end
@@ -77,18 +77,18 @@ module Plaid
         self.request_id = attributes[:'request_id']
       end
 
-      if attributes.key?(:'taxforms')
-        if (value = attributes[:'taxforms']).is_a?(Array)
-          self.taxforms = value
-        end
-      end
-
       if attributes.key?(:'document_metadata')
         if (value = attributes[:'document_metadata']).is_a?(Array)
           self.document_metadata = value
         end
       end
 
+      if attributes.key?(:'taxforms')
+        if (value = attributes[:'taxforms']).is_a?(Array)
+          self.taxforms = value
+        end
+      end
+
       if attributes.key?(:'error')
         self.error = attributes[:'error']
       end
@@ -98,22 +98,22 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @taxforms.nil?
-        invalid_properties.push('invalid value for "taxforms", taxforms cannot be nil.')
-      end
-
       if @document_metadata.nil?
         invalid_properties.push('invalid value for "document_metadata", document_metadata cannot be nil.')
       end
 
+      if @taxforms.nil?
+        invalid_properties.push('invalid value for "taxforms", taxforms 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 @taxforms.nil?
       return false if @document_metadata.nil?
+      return false if @taxforms.nil?
       true
     end
 
@@ -123,8 +123,8 @@ module Plaid
       return true if self.equal?(o)
       self.class == o.class &&
           request_id == o.request_id &&
-          taxforms == o.taxforms &&
           document_metadata == o.document_metadata &&
+          taxforms == o.taxforms &&
           error == o.error
     end
 
@@ -137,7 +137,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [request_id, taxforms, document_metadata, error].hash
+      [request_id, document_metadata, taxforms, error].hash
     end
 
     # Builds the object from hash

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