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

data/lib/plaid/models/external_payment_initiation_consent_options.rb

@@ -0,0 +1,249 @@
+=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.97.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Additional payment consent options
+  class ExternalPaymentInitiationConsentOptions
+    # The EMI (E-Money Institution) wallet that this payment consent is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.
+    attr_accessor :wallet_id
+
+    # 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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'wallet_id' => :'wallet_id',
+        :'request_refund_details' => :'request_refund_details'
+      }
+    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
+      {
+        :'wallet_id' => :'String',
+        :'request_refund_details' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'wallet_id',
+        :'request_refund_details'
+      ])
+    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::ExternalPaymentInitiationConsentOptions` 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::ExternalPaymentInitiationConsentOptions`. 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?(:'wallet_id')
+        self.wallet_id = attributes[:'wallet_id']
+      end
+
+      if attributes.key?(:'request_refund_details')
+        self.request_refund_details = attributes[:'request_refund_details']
+      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 !@wallet_id.nil? && @wallet_id.to_s.length < 1
+        invalid_properties.push('invalid value for "wallet_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 !@wallet_id.nil? && @wallet_id.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] wallet_id Value to be assigned
+    def wallet_id=(wallet_id)
+      if !wallet_id.nil? && wallet_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "wallet_id", the character length must be great than or equal to 1.'
+      end
+
+
+      @wallet_id = wallet_id
+    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 &&
+          wallet_id == o.wallet_id &&
+          request_refund_details == o.request_refund_details
+    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
+      [wallet_id, request_refund_details].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/external_payment_options.rb

@@ -3,10 +3,10 @@
 
 #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.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -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,19 @@ module Plaid
 
     attr_accessor :bacs
 
+    # The EMI (E-Money Institution) wallet that this payment is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.
+    attr_accessor :wallet_id
+
+    attr_accessor :scheme
+
     # 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',
+        :'wallet_id' => :'wallet_id',
+        :'scheme' => :'scheme'
       }
     end
 
@@ -43,7 +50,9 @@ module Plaid
       {
         :'request_refund_details' => :'Boolean',
         :'iban' => :'String',
-        :'bacs' => :'PaymentInitiationOptionalRestrictionBacs'
+        :'bacs' => :'PaymentInitiationOptionalRestrictionBacs',
+        :'wallet_id' => :'String',
+        :'scheme' => :'PaymentScheme'
       }
     end
 
@@ -52,7 +61,9 @@ module Plaid
       Set.new([
         :'request_refund_details',
         :'iban',
-        :'bacs'
+        :'bacs',
+        :'wallet_id',
+        :'scheme'
       ])
     end
 
@@ -82,21 +93,72 @@ module Plaid
       if attributes.key?(:'bacs')
         self.bacs = attributes[:'bacs']
       end
+
+      if attributes.key?(:'wallet_id')
+        self.wallet_id = attributes[:'wallet_id']
+      end
+
+      if attributes.key?(:'scheme')
+        self.scheme = attributes[:'scheme']
+      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 !@wallet_id.nil? && @wallet_id.to_s.length < 1
+        invalid_properties.push('invalid value for "wallet_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 !@wallet_id.nil? && @wallet_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] wallet_id Value to be assigned
+    def wallet_id=(wallet_id)
+      if !wallet_id.nil? && wallet_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "wallet_id", the character length must be great than or equal to 1.'
+      end
+
+
+      @wallet_id = wallet_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -104,7 +166,9 @@ module Plaid
       self.class == o.class &&
           request_refund_details == o.request_refund_details &&
           iban == o.iban &&
-          bacs == o.bacs
+          bacs == o.bacs &&
+          wallet_id == o.wallet_id &&
+          scheme == o.scheme
     end
 
     # @see the `==` method
@@ -116,7 +180,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, wallet_id, scheme].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/external_payment_refund_details.rb

@@ -3,10 +3,10 @@
 
 #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.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Plaid
+  # Details about external payment refund
   class ExternalPaymentRefundDetails
     # The name of the account holder.
     attr_accessor :name
@@ -42,7 +43,7 @@ module Plaid
       {
         :'name' => :'String',
         :'iban' => :'String',
-        :'bacs' => :'NullableRecipientBACS'
+        :'bacs' => :'RecipientBACSNullable'
       }
     end
 
@@ -86,12 +87,17 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @name.nil?
       true
     end
 

data/lib/plaid/models/{external_payment_schedule.rb → external_payment_schedule_base.rb}

@@ -3,10 +3,10 @@
 
 #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.97.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.1.0
+OpenAPI Generator version: 5.1.1
 
 =end
 
@@ -15,25 +15,29 @@ require 'time'
 
 module Plaid
   # The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.
-  class ExternalPaymentSchedule
+  class ExternalPaymentScheduleBase
     attr_accessor :interval
 
     # The day of the interval on which to schedule the payment.  If the payment interval is weekly, `interval_execution_day` should be an integer from 1 (Monday) to 7 (Sunday).  If the payment interval is monthly, `interval_execution_day` should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on.
     attr_accessor :interval_execution_day
 
-    # A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`.  If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so.
+    # A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`.  If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so.
     attr_accessor :start_date
 
-    # A date in ISO 8601 format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`.  If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so.
+    # A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`. If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so.
     attr_accessor :end_date
 
+    # The start date sent to the bank after adjusting for holidays or weekends.  Will be provided in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). If the start date did not require adjustment, this field will be `null`.
+    attr_accessor :adjusted_start_date
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'interval' => :'interval',
         :'interval_execution_day' => :'interval_execution_day',
         :'start_date' => :'start_date',
-        :'end_date' => :'end_date'
+        :'end_date' => :'end_date',
+        :'adjusted_start_date' => :'adjusted_start_date'
       }
     end
 
@@ -48,14 +52,16 @@ module Plaid
         :'interval' => :'PaymentScheduleInterval',
         :'interval_execution_day' => :'Integer',
         :'start_date' => :'Date',
-        :'end_date' => :'Date'
+        :'end_date' => :'Date',
+        :'adjusted_start_date' => :'Date'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'end_date'
+        :'end_date',
+        :'adjusted_start_date'
       ])
     end
 
@@ -63,13 +69,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::ExternalPaymentSchedule` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::ExternalPaymentScheduleBase` 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::ExternalPaymentSchedule`. 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::ExternalPaymentScheduleBase`. 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
       }
@@ -89,33 +95,22 @@ module Plaid
       if attributes.key?(:'end_date')
         self.end_date = attributes[:'end_date']
       end
+
+      if attributes.key?(:'adjusted_start_date')
+        self.adjusted_start_date = attributes[:'adjusted_start_date']
+      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 @interval.nil?
-        invalid_properties.push('invalid value for "interval", interval cannot be nil.')
-      end
-
-      if @interval_execution_day.nil?
-        invalid_properties.push('invalid value for "interval_execution_day", interval_execution_day cannot be nil.')
-      end
-
-      if @start_date.nil?
-        invalid_properties.push('invalid value for "start_date", start_date 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 @interval.nil?
-      return false if @interval_execution_day.nil?
-      return false if @start_date.nil?
       true
     end
 
@@ -127,7 +122,8 @@ module Plaid
           interval == o.interval &&
           interval_execution_day == o.interval_execution_day &&
           start_date == o.start_date &&
-          end_date == o.end_date
+          end_date == o.end_date &&
+          adjusted_start_date == o.adjusted_start_date
     end
 
     # @see the `==` method
@@ -139,7 +135,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [interval, interval_execution_day, start_date, end_date].hash
+      [interval, interval_execution_day, start_date, end_date, adjusted_start_date].hash
     end
 
     # Builds the object from hash