plaid 16.0.0 → 17.0.0

data/lib/plaid/models/{error.rb → credit_session_error.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.181.1
+The version of the OpenAPI document: 2020-09-14_1.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -14,69 +14,27 @@ require 'date'
 require 'time'
 
 module Plaid
-  # We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues.  Error fields will be `null` if no error has occurred.
-  class Error
-    # A broad categorization of the error. Safe for programmatic use.
+  # The details of a Link error.
+  class CreditSessionError
+    # A broad categorization of the error.
     attr_accessor :error_type
 
-    # The particular error code. Safe for programmatic use.
+    # The particular error code.
     attr_accessor :error_code
 
-    # A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
+    # A developer-friendly representation of the error code.
     attr_accessor :error_message
 
-    # A user-friendly representation of the error code. `null` if the error is not related to user action.  This may change over time and is not safe for programmatic use.
+    # A user-friendly representation of the error code. `null` if the error is not related to user action.
     attr_accessor :display_message
 
-    # A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
-    attr_accessor :request_id
-
-    # In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.  `causes` will only be provided for the `error_type` `ASSET_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object.
-    attr_accessor :causes
-
-    # The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
-    attr_accessor :status
-
-    # The URL of a Plaid documentation page with more information about the error
-    attr_accessor :documentation_url
-
-    # Suggested steps for resolving the error
-    attr_accessor :suggested_action
-
-    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
       {
         :'error_type' => :'error_type',
         :'error_code' => :'error_code',
         :'error_message' => :'error_message',
-        :'display_message' => :'display_message',
-        :'request_id' => :'request_id',
-        :'causes' => :'causes',
-        :'status' => :'status',
-        :'documentation_url' => :'documentation_url',
-        :'suggested_action' => :'suggested_action'
+        :'display_message' => :'display_message'
       }
     end
 
@@ -91,21 +49,14 @@ module Plaid
         :'error_type' => :'String',
         :'error_code' => :'String',
         :'error_message' => :'String',
-        :'display_message' => :'String',
-        :'request_id' => :'String',
-        :'causes' => :'Array<AnyType>',
-        :'status' => :'Float',
-        :'documentation_url' => :'String',
-        :'suggested_action' => :'String'
+        :'display_message' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'display_message',
-        :'status',
-        :'suggested_action'
+        :'display_message'
       ])
     end
 
@@ -113,13 +64,13 @@ module Plaid
     # @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::Error` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CreditSessionError` 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::Error`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::CreditSessionError`. 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
       }
@@ -139,70 +90,21 @@ module Plaid
       if attributes.key?(:'display_message')
         self.display_message = attributes[:'display_message']
       end
-
-      if attributes.key?(:'request_id')
-        self.request_id = attributes[:'request_id']
-      end
-
-      if attributes.key?(:'causes')
-        if (value = attributes[:'causes']).is_a?(Array)
-          self.causes = value
-        end
-      end
-
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
-      end
-
-      if attributes.key?(:'documentation_url')
-        self.documentation_url = attributes[:'documentation_url']
-      end
-
-      if attributes.key?(:'suggested_action')
-        self.suggested_action = attributes[:'suggested_action']
-      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 @error_type.nil?
-        invalid_properties.push('invalid value for "error_type", error_type cannot be nil.')
-      end
-
-      if @error_code.nil?
-        invalid_properties.push('invalid value for "error_code", error_code cannot be nil.')
-      end
-
-      if @error_message.nil?
-        invalid_properties.push('invalid value for "error_message", error_message 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 @error_type.nil?
-      error_type_validator = EnumAttributeValidator.new('String', ["INVALID_REQUEST", "INVALID_RESULT", "INVALID_INPUT", "INSTITUTION_ERROR", "RATE_LIMIT_EXCEEDED", "API_ERROR", "ITEM_ERROR", "ASSET_REPORT_ERROR", "RECAPTCHA_ERROR", "OAUTH_ERROR", "PAYMENT_ERROR", "BANK_TRANSFER_ERROR", "INCOME_VERIFICATION_ERROR", "MICRODEPOSITS_ERROR"])
-      return false unless error_type_validator.valid?(@error_type)
-      return false if @error_code.nil?
-      return false if @error_message.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] error_type Object to be assigned
-    def error_type=(error_type)
-      validator = EnumAttributeValidator.new('String', ["INVALID_REQUEST", "INVALID_RESULT", "INVALID_INPUT", "INSTITUTION_ERROR", "RATE_LIMIT_EXCEEDED", "API_ERROR", "ITEM_ERROR", "ASSET_REPORT_ERROR", "RECAPTCHA_ERROR", "OAUTH_ERROR", "PAYMENT_ERROR", "BANK_TRANSFER_ERROR", "INCOME_VERIFICATION_ERROR", "MICRODEPOSITS_ERROR"])
-      unless validator.valid?(error_type)
-        fail ArgumentError, "invalid value for \"error_type\", must be one of #{validator.allowable_values}."
-      end
-      @error_type = error_type
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -211,12 +113,7 @@ module Plaid
           error_type == o.error_type &&
           error_code == o.error_code &&
           error_message == o.error_message &&
-          display_message == o.display_message &&
-          request_id == o.request_id &&
-          causes == o.causes &&
-          status == o.status &&
-          documentation_url == o.documentation_url &&
-          suggested_action == o.suggested_action
+          display_message == o.display_message
     end
 
     # @see the `==` method
@@ -228,7 +125,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [error_type, error_code, error_message, display_message, request_id, causes, status, documentation_url, suggested_action].hash
+      [error_type, error_code, error_message, display_message].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/credit_session_item_add_result.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.181.1
+The version of the OpenAPI document: 2020-09-14_1.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -14,19 +14,22 @@ require 'date'
 require 'time'
 
 module Plaid
-  # The details of an item add in link
+  # The details of an item add in Link
   class CreditSessionItemAddResult
-    attr_accessor :item_id
-
+    # Returned once a user has successfully linked their Item.
     attr_accessor :public_token
 
+    # The Plaid Item ID. The `item_id` is always unique; linking the same account at the same institution twice will result in two Items with different `item_id` values. Like all Plaid identifiers, the `item_id` is case-sensitive.
+    attr_accessor :item_id
+
+    # The Plaid Institution ID associated with the Item.
     attr_accessor :institution_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'item_id' => :'item_id',
         :'public_token' => :'public_token',
+        :'item_id' => :'item_id',
         :'institution_id' => :'institution_id'
       }
     end
@@ -39,8 +42,8 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'item_id' => :'String',
         :'public_token' => :'String',
+        :'item_id' => :'String',
         :'institution_id' => :'String'
       }
     end
@@ -66,14 +69,14 @@ module Plaid
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'item_id')
-        self.item_id = attributes[:'item_id']
-      end
-
       if attributes.key?(:'public_token')
         self.public_token = attributes[:'public_token']
       end
 
+      if attributes.key?(:'item_id')
+        self.item_id = attributes[:'item_id']
+      end
+
       if attributes.key?(:'institution_id')
         self.institution_id = attributes[:'institution_id']
       end
@@ -97,8 +100,8 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          item_id == o.item_id &&
           public_token == o.public_token &&
+          item_id == o.item_id &&
           institution_id == o.institution_id
     end
 
@@ -111,7 +114,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [item_id, public_token, institution_id].hash
+      [public_token, item_id, institution_id].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/credit_session_payroll_income_result.rb

@@ -0,0 +1,250 @@
+=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
+  # The details of a digital payroll income verification in Link
+  class CreditSessionPayrollIncomeResult
+    # The number of paystubs retrieved from a payroll provider.
+    attr_accessor :num_paystubs_retrieved
+
+    # The number of w2s retrieved from a payroll provider.
+    attr_accessor :num_w2s_retrieved
+
+    # The Plaid Institution ID associated with the Item.
+    attr_accessor :institution_id
+
+    # The Institution Name associated with the Item.
+    attr_accessor :institution_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'num_paystubs_retrieved' => :'num_paystubs_retrieved',
+        :'num_w2s_retrieved' => :'num_w2s_retrieved',
+        :'institution_id' => :'institution_id',
+        :'institution_name' => :'institution_name'
+      }
+    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
+      {
+        :'num_paystubs_retrieved' => :'Integer',
+        :'num_w2s_retrieved' => :'Integer',
+        :'institution_id' => :'String',
+        :'institution_name' => :'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::CreditSessionPayrollIncomeResult` 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::CreditSessionPayrollIncomeResult`. 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?(:'num_paystubs_retrieved')
+        self.num_paystubs_retrieved = attributes[:'num_paystubs_retrieved']
+      end
+
+      if attributes.key?(:'num_w2s_retrieved')
+        self.num_w2s_retrieved = attributes[:'num_w2s_retrieved']
+      end
+
+      if attributes.key?(:'institution_id')
+        self.institution_id = attributes[:'institution_id']
+      end
+
+      if attributes.key?(:'institution_name')
+        self.institution_name = attributes[:'institution_name']
+      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 &&
+          num_paystubs_retrieved == o.num_paystubs_retrieved &&
+          num_w2s_retrieved == o.num_w2s_retrieved &&
+          institution_id == o.institution_id &&
+          institution_name == o.institution_name
+    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
+      [num_paystubs_retrieved, num_w2s_retrieved, institution_id, institution_name].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_session_results.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.181.1
+The version of the OpenAPI document: 2020-09-14_1.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -14,17 +14,26 @@ require 'date'
 require 'time'
 
 module Plaid
-  # The set of results for a link session
+  # The set of results for a Link session.
   class CreditSessionResults
+    # The set of item adds for the Link session.
     attr_accessor :item_add_results
 
+    # The set of bank income verifications for the Link session.
     attr_accessor :bank_income_results
 
+    # The set of payroll income verifications for the Link session.
+    attr_accessor :payroll_income_results
+
+    attr_accessor :document_income_results
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'item_add_results' => :'item_add_results',
-        :'bank_income_results' => :'bank_income_results'
+        :'bank_income_results' => :'bank_income_results',
+        :'payroll_income_results' => :'payroll_income_results',
+        :'document_income_results' => :'document_income_results'
       }
     end
 
@@ -37,13 +46,16 @@ module Plaid
     def self.openapi_types
       {
         :'item_add_results' => :'Array<CreditSessionItemAddResult>',
-        :'bank_income_results' => :'Array<CreditSessionBankIncomeResult>'
+        :'bank_income_results' => :'Array<CreditSessionBankIncomeResult>',
+        :'payroll_income_results' => :'Array<CreditSessionPayrollIncomeResult>',
+        :'document_income_results' => :'CreditSessionDocumentIncomeResult'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'document_income_results'
       ])
     end
 
@@ -73,6 +85,16 @@ module Plaid
           self.bank_income_results = value
         end
       end
+
+      if attributes.key?(:'payroll_income_results')
+        if (value = attributes[:'payroll_income_results']).is_a?(Array)
+          self.payroll_income_results = value
+        end
+      end
+
+      if attributes.key?(:'document_income_results')
+        self.document_income_results = attributes[:'document_income_results']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,7 +116,9 @@ module Plaid
       return true if self.equal?(o)
       self.class == o.class &&
           item_add_results == o.item_add_results &&
-          bank_income_results == o.bank_income_results
+          bank_income_results == o.bank_income_results &&
+          payroll_income_results == o.payroll_income_results &&
+          document_income_results == o.document_income_results
     end
 
     # @see the `==` method
@@ -106,7 +130,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [item_add_results, bank_income_results].hash
+      [item_add_results, bank_income_results, payroll_income_results, document_income_results].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/credit_sessions_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.181.1
+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_sessions_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.181.1
+The version of the OpenAPI document: 2020-09-14_1.197.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -16,6 +16,7 @@ require 'time'
 module Plaid
   # CreditSessionsGetResponse defines the response schema for `/credit/sessions/get`
   class CreditSessionsGetResponse
+    # A list of Link sessions for the user. Sessions will be sorted in reverse chronological order.
     attr_accessor :sessions
 
     # A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

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