plaid 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown → 14.0.0

data/lib/plaid/models/deposit_switch_state_update_webhook.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.20.6
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Fired when the status of a deposit switch request has changed.
+  class DepositSwitchStateUpdateWebhook
+    # `\"DEPOSIT_SWITCH\"`
+    attr_accessor :webhook_type
+
+    # `\"SWITCH_STATE_UPDATE\"`
+    attr_accessor :webhook_code
+
+    #  The state, or status, of the deposit switch.  `initialized`: The deposit switch has been initialized with the user entering the information required to submit the deposit switch request.  `processing`: The deposit switch request has been submitted and is being processed.  `completed`: The user's employer has fulfilled and completed the deposit switch request.  `error`: There was an error processing the deposit switch request.  For more information, see the [Deposit Switch API reference](/docs/api/products#deposit_switchget).
+    attr_accessor :state
+
+    # The ID of the deposit switch.
+    attr_accessor :deposit_switch_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'webhook_type' => :'webhook_type',
+        :'webhook_code' => :'webhook_code',
+        :'state' => :'state',
+        :'deposit_switch_id' => :'deposit_switch_id'
+      }
+    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
+      {
+        :'webhook_type' => :'String',
+        :'webhook_code' => :'String',
+        :'state' => :'String',
+        :'deposit_switch_id' => :'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::DepositSwitchStateUpdateWebhook` 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::DepositSwitchStateUpdateWebhook`. 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?(:'webhook_type')
+        self.webhook_type = attributes[:'webhook_type']
+      end
+
+      if attributes.key?(:'webhook_code')
+        self.webhook_code = attributes[:'webhook_code']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'deposit_switch_id')
+        self.deposit_switch_id = attributes[:'deposit_switch_id']
+      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 &&
+          webhook_type == o.webhook_type &&
+          webhook_code == o.webhook_code &&
+          state == o.state &&
+          deposit_switch_id == o.deposit_switch_id
+    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
+      [webhook_type, webhook_code, state, deposit_switch_id].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/deposit_switch_target_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.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

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

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

data/lib/plaid/models/deposit_switch_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.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -19,7 +19,7 @@ module Plaid
     # Deposit switch token, used to initialize Link for the Deposit Switch product
     attr_accessor :deposit_switch_token
 
-    # Expiration time of the token, in ISO8601 format
+    # Expiration time of the token, in ISO 8601 format
     attr_accessor :deposit_switch_token_expiration_time
 
     # 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/depository_filter.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -16,7 +16,7 @@ require 'time'
 module Plaid
   # A filter to apply to `depository`-type accounts
   class DepositoryFilter
-    # An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](/docs/api/accounts#accounts-schema). 
+    # An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#accounts-schema). 
     attr_accessor :account_subtypes
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

data/lib/plaid/models/employee.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -21,15 +21,11 @@ module Plaid
 
     attr_accessor :address
 
-    # The SSN of the employee, with all but the last 4 digits masked out. For example: \"XXX-XX-1111\".
-    attr_accessor :ssn_masked
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
-        :'address' => :'address',
-        :'ssn_masked' => :'ssn_masked'
+        :'address' => :'address'
       }
     end
 
@@ -42,8 +38,7 @@ module Plaid
     def self.openapi_types
       {
         :'name' => :'String',
-        :'address' => :'NullableAddressData',
-        :'ssn_masked' => :'String'
+        :'address' => :'AddressDataNullable'
       }
     end
 
@@ -51,8 +46,7 @@ module Plaid
     def self.openapi_nullable
       Set.new([
         :'name',
-        :'address',
-        :'ssn_masked'
+        :'address'
       ])
     end
 
@@ -78,10 +72,6 @@ module Plaid
       if attributes.key?(:'address')
         self.address = attributes[:'address']
       end
-
-      if attributes.key?(:'ssn_masked')
-        self.ssn_masked = attributes[:'ssn_masked']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -103,8 +93,7 @@ module Plaid
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          address == o.address &&
-          ssn_masked == o.ssn_masked
+          address == o.address
     end
 
     # @see the `==` method
@@ -116,7 +105,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, address, ssn_masked].hash
+      [name, address].hash
     end
 
     # Builds the object from hash

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

data/lib/plaid/models/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.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -47,7 +47,7 @@ module Plaid
       {
         :'employer_id' => :'String',
         :'name' => :'String',
-        :'address' => :'NullableAddressData',
+        :'address' => :'AddressDataNullable',
         :'confidence_score' => :'Float'
       }
     end
@@ -56,7 +56,6 @@ module Plaid
     def self.openapi_nullable
       Set.new([
         :'address',
-        :'confidence_score'
       ])
     end
 
@@ -104,6 +103,10 @@ module Plaid
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
+      if @confidence_score.nil?
+        invalid_properties.push('invalid value for "confidence_score", confidence_score cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -112,6 +115,7 @@ module Plaid
     def valid?
       return false if @employer_id.nil?
       return false if @name.nil?
+      return false if @confidence_score.nil?
       true
     end
 

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

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

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

data/lib/plaid/models/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.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -28,7 +28,7 @@ module Plaid
     # 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.
     attr_accessor :display_message
 
-    # A unique identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
+    # 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`.
@@ -105,8 +105,6 @@ module Plaid
       Set.new([
         :'display_message',
         :'status',
-        :'documentation_url',
-        :'suggested_action'
       ])
     end
 
@@ -180,10 +178,6 @@ module Plaid
         invalid_properties.push('invalid value for "error_message", error_message cannot be nil.')
       end
 
-      if @request_id.nil?
-        invalid_properties.push('invalid value for "request_id", request_id cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -195,7 +189,6 @@ module Plaid
       return false unless error_type_validator.valid?(@error_type)
       return false if @error_code.nil?
       return false if @error_message.nil?
-      return false if @request_id.nil?
       true
     end
 

data/lib/plaid/models/external_payment_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.16.6
+The version of the OpenAPI document: 2020-09-14_1.20.6
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -16,7 +16,7 @@ require 'time'
 module Plaid
   # Additional payment options
   class ExternalPaymentOptions
-    # When `true`, Plaid will attempt to request refund details from the payee's financial institution.  Support varies between financial institutions and will not always be available.  If refund details could be retrieved, they will be available in the `/payment/get` response.
+    # When `true`, Plaid will attempt to request refund details from the payee's financial institution.  Support varies between financial institutions and will not always be available.  If refund details could be retrieved, they will be available in the `/payment_initiation/payment/get` response.
     attr_accessor :request_refund_details
 
     # The International Bank Account Number (IBAN) for the payer's account. If provided, the end user will be able to send payments only from the specified bank account.
@@ -24,12 +24,16 @@ module Plaid
 
     attr_accessor :bacs
 
+    # The EMI (E-Money Institution) account that this payment is associated with, if any. This EMI account is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.
+    attr_accessor :emi_account_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'request_refund_details' => :'request_refund_details',
         :'iban' => :'iban',
-        :'bacs' => :'bacs'
+        :'bacs' => :'bacs',
+        :'emi_account_id' => :'emi_account_id'
       }
     end
 
@@ -43,7 +47,8 @@ module Plaid
       {
         :'request_refund_details' => :'Boolean',
         :'iban' => :'String',
-        :'bacs' => :'PaymentInitiationOptionalRestrictionBacs'
+        :'bacs' => :'PaymentInitiationOptionalRestrictionBacs',
+        :'emi_account_id' => :'String'
       }
     end
 
@@ -52,7 +57,8 @@ module Plaid
       Set.new([
         :'request_refund_details',
         :'iban',
-        :'bacs'
+        :'bacs',
+        :'emi_account_id'
       ])
     end
 
@@ -82,21 +88,68 @@ module Plaid
       if attributes.key?(:'bacs')
         self.bacs = attributes[:'bacs']
       end
+
+      if attributes.key?(:'emi_account_id')
+        self.emi_account_id = attributes[:'emi_account_id']
+      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 !@iban.nil? && @iban.to_s.length > 34
+        invalid_properties.push('invalid value for "iban", the character length must be smaller than or equal to 34.')
+      end
+
+      if !@iban.nil? && @iban.to_s.length < 15
+        invalid_properties.push('invalid value for "iban", the character length must be great than or equal to 15.')
+      end
+
+
+      if !@emi_account_id.nil? && @emi_account_id.to_s.length < 1
+        invalid_properties.push('invalid value for "emi_account_id", the character length must be great than or equal to 1.')
+      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 !@iban.nil? && @iban.to_s.length > 34
+      return false if !@iban.nil? && @iban.to_s.length < 15
+      return false if !@emi_account_id.nil? && @emi_account_id.to_s.length < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] iban Value to be assigned
+    def iban=(iban)
+      if !iban.nil? && iban.to_s.length > 34
+        fail ArgumentError, 'invalid value for "iban", the character length must be smaller than or equal to 34.'
+      end
+
+      if !iban.nil? && iban.to_s.length < 15
+        fail ArgumentError, 'invalid value for "iban", the character length must be great than or equal to 15.'
+      end
+
+
+      @iban = iban
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] emi_account_id Value to be assigned
+    def emi_account_id=(emi_account_id)
+      if !emi_account_id.nil? && emi_account_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "emi_account_id", the character length must be great than or equal to 1.'
+      end
+
+
+      @emi_account_id = emi_account_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -104,7 +157,8 @@ module Plaid
       self.class == o.class &&
           request_refund_details == o.request_refund_details &&
           iban == o.iban &&
-          bacs == o.bacs
+          bacs == o.bacs &&
+          emi_account_id == o.emi_account_id
     end
 
     # @see the `==` method
@@ -116,7 +170,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [request_refund_details, iban, bacs].hash
+      [request_refund_details, iban, bacs, emi_account_id].hash
     end
 
     # Builds the object from hash