plaid 14.4.0 → 14.8.0

data/lib/plaid/models/income_verification_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.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,12 +25,19 @@ module Plaid
     # The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process.
     attr_accessor :webhook
 
+    # The ID of a precheck created with `/income/verification/precheck`. Will be used to improve conversion of the income verification flow.
+    attr_accessor :precheck_id
+
+    attr_accessor :options
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'client_id' => :'client_id',
         :'secret' => :'secret',
-        :'webhook' => :'webhook'
+        :'webhook' => :'webhook',
+        :'precheck_id' => :'precheck_id',
+        :'options' => :'options'
       }
     end
 
@@ -44,7 +51,9 @@ module Plaid
       {
         :'client_id' => :'String',
         :'secret' => :'String',
-        :'webhook' => :'String'
+        :'webhook' => :'String',
+        :'precheck_id' => :'String',
+        :'options' => :'IncomeVerificationCreateRequestOptions'
       }
     end
 
@@ -80,6 +89,14 @@ module Plaid
       if attributes.key?(:'webhook')
         self.webhook = attributes[:'webhook']
       end
+
+      if attributes.key?(:'precheck_id')
+        self.precheck_id = attributes[:'precheck_id']
+      end
+
+      if attributes.key?(:'options')
+        self.options = attributes[:'options']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -107,7 +124,9 @@ module Plaid
       self.class == o.class &&
           client_id == o.client_id &&
           secret == o.secret &&
-          webhook == o.webhook
+          webhook == o.webhook &&
+          precheck_id == o.precheck_id &&
+          options == o.options
     end
 
     # @see the `==` method
@@ -119,7 +138,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, webhook].hash
+      [client_id, secret, webhook, precheck_id, options].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/income_verification_create_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.46.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # IncomeVerificationCreateRequestOptions defines the optional arguments schema for `/income/verification/create`
+  class IncomeVerificationCreateRequestOptions
+    # 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 :access_tokens
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'access_tokens' => :'access_tokens'
+      }
+    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
+      {
+        :'access_tokens' => :'Array<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::IncomeVerificationCreateRequestOptions` 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::IncomeVerificationCreateRequestOptions`. 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?(:'access_tokens')
+        if (value = attributes[:'access_tokens']).is_a?(Array)
+          self.access_tokens = value
+        end
+      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 &&
+          access_tokens == o.access_tokens
+    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
+      [access_tokens].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_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.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_documents_download_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
@@ -28,13 +28,17 @@ module Plaid
     # The access token associated with the Item data is being requested for.
     attr_accessor :access_token
 
+    # The document ID to download. If passed, a single document will be returned in the resulting zip file, rather than all document
+    attr_accessor :document_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'client_id' => :'client_id',
         :'secret' => :'secret',
         :'income_verification_id' => :'income_verification_id',
-        :'access_token' => :'access_token'
+        :'access_token' => :'access_token',
+        :'document_id' => :'document_id'
       }
     end
 
@@ -49,7 +53,8 @@ module Plaid
         :'client_id' => :'String',
         :'secret' => :'String',
         :'income_verification_id' => :'String',
-        :'access_token' => :'String'
+        :'access_token' => :'String',
+        :'document_id' => :'String'
       }
     end
 
@@ -57,7 +62,8 @@ module Plaid
     def self.openapi_nullable
       Set.new([
         :'income_verification_id',
-        :'access_token'
+        :'access_token',
+        :'document_id'
       ])
     end
 
@@ -91,6 +97,10 @@ module Plaid
       if attributes.key?(:'access_token')
         self.access_token = attributes[:'access_token']
       end
+
+      if attributes.key?(:'document_id')
+        self.document_id = attributes[:'document_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -114,7 +124,8 @@ module Plaid
           client_id == o.client_id &&
           secret == o.secret &&
           income_verification_id == o.income_verification_id &&
-          access_token == o.access_token
+          access_token == o.access_token &&
+          document_id == o.document_id
     end
 
     # @see the `==` method
@@ -126,7 +137,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, income_verification_id, access_token].hash
+      [client_id, secret, income_verification_id, access_token, document_id].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/income_verification_paystub_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_paystub_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_paystubs_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_paystubs_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
@@ -16,21 +16,21 @@ require 'time'
 module Plaid
   # IncomeVerificationPaystubsGetResponse defines the response schema for `/income/verification/paystubs/get`.
   class IncomeVerificationPaystubsGetResponse
+    attr_accessor :document_metadata
+
     attr_accessor :paystubs
 
     attr_accessor :error
 
-    attr_accessor :document_metadata
-
     # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'document_metadata' => :'document_metadata',
         :'paystubs' => :'paystubs',
         :'error' => :'error',
-        :'document_metadata' => :'document_metadata',
         :'request_id' => :'request_id'
       }
     end
@@ -43,9 +43,9 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'document_metadata' => :'Array<DocumentMetadata>',
         :'paystubs' => :'Array<Paystub>',
         :'error' => :'Error',
-        :'document_metadata' => :'Array<DocumentMetadata>',
         :'request_id' => :'String'
       }
     end
@@ -72,6 +72,12 @@ module Plaid
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'document_metadata')
+        if (value = attributes[:'document_metadata']).is_a?(Array)
+          self.document_metadata = value
+        end
+      end
+
       if attributes.key?(:'paystubs')
         if (value = attributes[:'paystubs']).is_a?(Array)
           self.paystubs = value
@@ -82,12 +88,6 @@ module Plaid
         self.error = attributes[:'error']
       end
 
-      if attributes.key?(:'document_metadata')
-        if (value = attributes[:'document_metadata']).is_a?(Array)
-          self.document_metadata = value
-        end
-      end
-
       if attributes.key?(:'request_id')
         self.request_id = attributes[:'request_id']
       end
@@ -121,9 +121,9 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          document_metadata == o.document_metadata &&
           paystubs == o.paystubs &&
           error == o.error &&
-          document_metadata == o.document_metadata &&
           request_id == o.request_id
     end
 
@@ -136,7 +136,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [paystubs, error, document_metadata, request_id].hash
+      [document_metadata, paystubs, error, request_id].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/income_verification_precheck_confidence.rb

@@ -0,0 +1,40 @@
+=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
+  class IncomeVerificationPrecheckConfidence
+    HIGH = "HIGH".freeze
+    LOW = "LOW".freeze
+    UNKNOWN = "UNKNOWN".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/income_verification_precheck_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.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
@@ -18,14 +18,21 @@ module Plaid
     # The employer's name
     attr_accessor :name
 
+    attr_accessor :address
+
     # The employer's tax id
     attr_accessor :tax_id
 
+    # The URL for the employer's public website
+    attr_accessor :url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
-        :'tax_id' => :'tax_id'
+        :'address' => :'address',
+        :'tax_id' => :'tax_id',
+        :'url' => :'url'
       }
     end
 
@@ -38,7 +45,9 @@ module Plaid
     def self.openapi_types
       {
         :'name' => :'String',
-        :'tax_id' => :'String'
+        :'address' => :'IncomeVerificationPrecheckEmployerAddress',
+        :'tax_id' => :'String',
+        :'url' => :'String'
       }
     end
 
@@ -46,7 +55,9 @@ module Plaid
     def self.openapi_nullable
       Set.new([
         :'name',
-        :'tax_id'
+        :'address',
+        :'tax_id',
+        :'url'
       ])
     end
 
@@ -69,9 +80,17 @@ module Plaid
         self.name = attributes[:'name']
       end
 
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
       if attributes.key?(:'tax_id')
         self.tax_id = attributes[:'tax_id']
       end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -93,7 +112,9 @@ module Plaid
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          tax_id == o.tax_id
+          address == o.address &&
+          tax_id == o.tax_id &&
+          url == o.url
     end
 
     # @see the `==` method
@@ -105,7 +126,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, tax_id].hash
+      [name, address, tax_id, url].hash
     end
 
     # Builds the object from hash