plaid 15.10.0 → 16.0.0

data/lib/plaid/models/credit1099_recipient.rb

@@ -0,0 +1,274 @@
+=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.181.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # An object representing a recipient used in both 1099-K and 1099-MISC tax documents.
+  class Credit1099Recipient
+    attr_accessor :address
+
+    # Name of recipient.
+    attr_accessor :name
+
+    # Tax identification number of recipient.
+    attr_accessor :tin
+
+    # Account number number of recipient.
+    attr_accessor :account_number
+
+    # Checked if FACTA is a filing requirement.
+    attr_accessor :facta_filing_requirement
+
+    # Checked if 2nd TIN exists.
+    attr_accessor :second_tin_exists
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address' => :'address',
+        :'name' => :'name',
+        :'tin' => :'tin',
+        :'account_number' => :'account_number',
+        :'facta_filing_requirement' => :'facta_filing_requirement',
+        :'second_tin_exists' => :'second_tin_exists'
+      }
+    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
+      {
+        :'address' => :'CreditPayStubAddress',
+        :'name' => :'String',
+        :'tin' => :'String',
+        :'account_number' => :'String',
+        :'facta_filing_requirement' => :'String',
+        :'second_tin_exists' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'tin',
+        :'account_number',
+        :'facta_filing_requirement',
+        :'second_tin_exists'
+      ])
+    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::Credit1099Recipient` 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::Credit1099Recipient`. 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?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'tin')
+        self.tin = attributes[:'tin']
+      end
+
+      if attributes.key?(:'account_number')
+        self.account_number = attributes[:'account_number']
+      end
+
+      if attributes.key?(:'facta_filing_requirement')
+        self.facta_filing_requirement = attributes[:'facta_filing_requirement']
+      end
+
+      if attributes.key?(:'second_tin_exists')
+        self.second_tin_exists = attributes[:'second_tin_exists']
+      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 &&
+          address == o.address &&
+          name == o.name &&
+          tin == o.tin &&
+          account_number == o.account_number &&
+          facta_filing_requirement == o.facta_filing_requirement &&
+          second_tin_exists == o.second_tin_exists
+    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
+      [address, name, tin, account_number, facta_filing_requirement, second_tin_exists].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_account_subtype.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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1

data/lib/plaid/models/credit_audit_copy_token_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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -48,7 +48,7 @@ module Plaid
       {
         :'client_id' => :'String',
         :'secret' => :'String',
-        :'report_tokens' => :'Array<ReportToken>',
+        :'report_tokens' => :'Array<String>',
         :'auditor_id' => :'String'
       }
     end

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

data/lib/plaid/models/credit_audit_copy_token_remove_request.rb

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

data/lib/plaid/models/credit_audit_copy_token_remove_response.rb

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

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

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

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

data/lib/plaid/models/credit_bank_income_category.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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -25,6 +25,9 @@ module Plaid
     RETIREMENT = "RETIREMENT".freeze
     LONG_TERM_DISABILITY = "LONG_TERM_DISABILITY".freeze
     BANK_INTEREST = "BANK_INTEREST".freeze
+    CASH_DEPOSIT = "CASH_DEPOSIT".freeze
+    TRANSFER_FROM_APPLICATION = "TRANSFER_FROM_APPLICATION".freeze
+    TAX_REFUND = "TAX_REFUND".freeze
     OTHER = "OTHER".freeze
 
     # Builds the enum from string

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

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

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

data/lib/plaid/models/credit_bank_income_get_request_options.rb

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

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

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

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

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

data/lib/plaid/models/{asset_report_relay_remove_request.rb → credit_bank_income_pdf_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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -14,23 +14,23 @@ require 'date'
 require 'time'
 
 module Plaid
-  # AssetReportRelayRemoveRequest defines the request schema for `/asset_report/relay/remove`
-  class AssetReportRelayRemoveRequest
+  # CreditBankIncomePDFGetRequest defines the request schema for `/credit/bank_income/pdf/get`
+  class CreditBankIncomePDFGetRequest
     # Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
     attr_accessor :client_id
 
     # Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
     attr_accessor :secret
 
-    # The `asset_relay_token` you would like to revoke.
-    attr_accessor :asset_relay_token
+    # The user token associated with the User data is being requested for.
+    attr_accessor :user_token
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'client_id' => :'client_id',
         :'secret' => :'secret',
-        :'asset_relay_token' => :'asset_relay_token'
+        :'user_token' => :'user_token'
       }
     end
 
@@ -44,7 +44,7 @@ module Plaid
       {
         :'client_id' => :'String',
         :'secret' => :'String',
-        :'asset_relay_token' => :'String'
+        :'user_token' => :'String'
       }
     end
 
@@ -58,13 +58,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::AssetReportRelayRemoveRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CreditBankIncomePDFGetRequest` 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::AssetReportRelayRemoveRequest`. 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::CreditBankIncomePDFGetRequest`. 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
       }
@@ -77,8 +77,8 @@ module Plaid
         self.secret = attributes[:'secret']
       end
 
-      if attributes.key?(:'asset_relay_token')
-        self.asset_relay_token = attributes[:'asset_relay_token']
+      if attributes.key?(:'user_token')
+        self.user_token = attributes[:'user_token']
       end
     end
 
@@ -86,8 +86,8 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @asset_relay_token.nil?
-        invalid_properties.push('invalid value for "asset_relay_token", asset_relay_token cannot be nil.')
+      if @user_token.nil?
+        invalid_properties.push('invalid value for "user_token", user_token cannot be nil.')
       end
 
       invalid_properties
@@ -96,7 +96,7 @@ 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 @asset_relay_token.nil?
+      return false if @user_token.nil?
       true
     end
 
@@ -107,7 +107,7 @@ module Plaid
       self.class == o.class &&
           client_id == o.client_id &&
           secret == o.secret &&
-          asset_relay_token == o.asset_relay_token
+          user_token == o.user_token
     end
 
     # @see the `==` method
@@ -119,7 +119,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_id, secret, asset_relay_token].hash
+      [client_id, secret, user_token].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/credit_bank_income_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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -94,14 +94,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
@@ -112,8 +104,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_bank_income_refresh_request_options.rb

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

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

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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 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.146.0
+The version of the OpenAPI document: 2020-09-14_1.181.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1