plaid 14.0.0.beta.3 → 14.1.0

data/lib/plaid/models/pay_frequency.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.8.0
+The version of the OpenAPI document: 2020-09-14_1.26.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/plaid/models/pay_period_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.8.0
+The version of the OpenAPI document: 2020-09-14_1.26.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -16,13 +16,13 @@ require 'time'
 module Plaid
   # Details about the pay period.
   class PayPeriodDetails
-    # The pay period start date, in ISO 8601 format: \"yyyy-mm-dd\".
+    # The pay period start date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
     attr_accessor :start_date
 
-    # The pay period end date, in ISO 8601 format: \"yyyy-mm-dd\".
+    # The pay period end date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
     attr_accessor :end_date
 
-    # The date on which the paystub was issued, in ISO 8601 format (\"yyyy-mm-dd\").
+    # The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (\"yyyy-mm-dd\").
     attr_accessor :pay_day
 
     # Total earnings before tax.
@@ -50,9 +50,9 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'start_date' => :'String',
-        :'end_date' => :'String',
-        :'pay_day' => :'String',
+        :'start_date' => :'Date',
+        :'end_date' => :'Date',
+        :'pay_day' => :'Date',
         :'gross_earnings' => :'Float',
         :'check_amount' => :'Float'
       }

data/lib/plaid/models/payment_amount.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.8.0
+The version of the OpenAPI document: 2020-09-14_1.26.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -16,12 +16,34 @@ require 'time'
 module Plaid
   # The amount and currency of a payment
   class PaymentAmount
-    # The ISO-4217 currency code of the payment amount
+    # The ISO-4217 currency code of the payment. For standing orders, `\"GBP\"` must be used.
     attr_accessor :currency
 
-    # The payment amount
+    # The amount of the payment. Must contain at most two digits of precision e.g. `1.23`. Minimum accepted value is `1`.
     attr_accessor :value
 
+    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
       {
@@ -81,6 +103,15 @@ module Plaid
         invalid_properties.push('invalid value for "currency", currency cannot be nil.')
       end
 
+      if @currency.to_s.length > 3
+        invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
+      end
+
+      if @currency.to_s.length < 3
+        invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
+      end
+
+
       if @value.nil?
         invalid_properties.push('invalid value for "value", value cannot be nil.')
       end
@@ -92,10 +123,24 @@ module Plaid
     # @return true if the model is valid
     def valid?
       return false if @currency.nil?
+      currency_validator = EnumAttributeValidator.new('String', ["GBP", "EUR"])
+      return false unless currency_validator.valid?(@currency)
+      return false if @currency.to_s.length > 3
+      return false if @currency.to_s.length < 3
       return false if @value.nil?
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] currency Object to be assigned
+    def currency=(currency)
+      validator = EnumAttributeValidator.new('String', ["GBP", "EUR"])
+      unless validator.valid?(currency)
+        fail ArgumentError, "invalid value for \"currency\", must be one of #{validator.allowable_values}."
+      end
+      @currency = currency
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/plaid/models/payment_initiation_address.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.8.0
+The version of the OpenAPI document: 2020-09-14_1.26.1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -97,15 +97,146 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @street.nil?
+        invalid_properties.push('invalid value for "street", street cannot be nil.')
+      end
+
+
+      if @street.length < 1
+        invalid_properties.push('invalid value for "street", number of items must be greater than or equal to 1.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @city.to_s.length > 35
+        invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 35.')
+      end
+
+      if @city.to_s.length < 1
+        invalid_properties.push('invalid value for "city", the character length must be great than or equal to 1.')
+      end
+
+
+      if @postal_code.nil?
+        invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.')
+      end
+
+      if @postal_code.to_s.length > 16
+        invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 16.')
+      end
+
+      if @postal_code.to_s.length < 1
+        invalid_properties.push('invalid value for "postal_code", the character length must be great than or equal to 1.')
+      end
+
+
+      if @country.nil?
+        invalid_properties.push('invalid value for "country", country cannot be nil.')
+      end
+
+      if @country.to_s.length > 2
+        invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
+      end
+
+      if @country.to_s.length < 2
+        invalid_properties.push('invalid value for "country", the character length must be great than or equal to 2.')
+      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 @street.nil?
+      return false if @street.length < 1
+      return false if @city.nil?
+      return false if @city.to_s.length > 35
+      return false if @city.to_s.length < 1
+      return false if @postal_code.nil?
+      return false if @postal_code.to_s.length > 16
+      return false if @postal_code.to_s.length < 1
+      return false if @country.nil?
+      return false if @country.to_s.length > 2
+      return false if @country.to_s.length < 2
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] street Value to be assigned
+    def street=(street)
+      if street.nil?
+        fail ArgumentError, 'street cannot be nil'
+      end
+
+
+      if street.length < 1
+        fail ArgumentError, 'invalid value for "street", number of items must be greater than or equal to 1.'
+      end
+
+      @street = street
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      if city.to_s.length > 35
+        fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 35.'
+      end
+
+      if city.to_s.length < 1
+        fail ArgumentError, 'invalid value for "city", the character length must be great than or equal to 1.'
+      end
+
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if postal_code.nil?
+        fail ArgumentError, 'postal_code cannot be nil'
+      end
+
+      if postal_code.to_s.length > 16
+        fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 16.'
+      end
+
+      if postal_code.to_s.length < 1
+        fail ArgumentError, 'invalid value for "postal_code", the character length must be great than or equal to 1.'
+      end
+
+
+      @postal_code = postal_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if country.nil?
+        fail ArgumentError, 'country cannot be nil'
+      end
+
+      if country.to_s.length > 2
+        fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
+      end
+
+      if country.to_s.length < 2
+        fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 2.'
+      end
+
+
+      @country = country
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/plaid/models/payment_initiation_metadata.rb

@@ -0,0 +1,267 @@
+=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.26.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.
+  class PaymentInitiationMetadata
+    # Indicates whether the institution supports payments from a different country.
+    attr_accessor :supports_international_payments
+
+    # A mapping of currency to maximum payment amount (denominated in the smallest unit of currency) supported by the insitution.  Example: `{\"GBP\": \"10000\"}` 
+    attr_accessor :maximum_payment_amount
+
+    # Indicates whether the institution supports returning refund details when initiating a payment.
+    attr_accessor :supports_refund_details
+
+    attr_accessor :standing_order_metadata
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'supports_international_payments' => :'supports_international_payments',
+        :'maximum_payment_amount' => :'maximum_payment_amount',
+        :'supports_refund_details' => :'supports_refund_details',
+        :'standing_order_metadata' => :'standing_order_metadata'
+      }
+    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
+      {
+        :'supports_international_payments' => :'Boolean',
+        :'maximum_payment_amount' => :'Hash<String, String>',
+        :'supports_refund_details' => :'Boolean',
+        :'standing_order_metadata' => :'PaymentInitiationStandingOrderMetadata'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'standing_order_metadata'
+      ])
+    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::PaymentInitiationMetadata` 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::PaymentInitiationMetadata`. 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?(:'supports_international_payments')
+        self.supports_international_payments = attributes[:'supports_international_payments']
+      end
+
+      if attributes.key?(:'maximum_payment_amount')
+        if (value = attributes[:'maximum_payment_amount']).is_a?(Hash)
+          self.maximum_payment_amount = value
+        end
+      end
+
+      if attributes.key?(:'supports_refund_details')
+        self.supports_refund_details = attributes[:'supports_refund_details']
+      end
+
+      if attributes.key?(:'standing_order_metadata')
+        self.standing_order_metadata = attributes[:'standing_order_metadata']
+      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 @supports_international_payments.nil?
+        invalid_properties.push('invalid value for "supports_international_payments", supports_international_payments cannot be nil.')
+      end
+
+      if @maximum_payment_amount.nil?
+        invalid_properties.push('invalid value for "maximum_payment_amount", maximum_payment_amount cannot be nil.')
+      end
+
+      if @supports_refund_details.nil?
+        invalid_properties.push('invalid value for "supports_refund_details", supports_refund_details 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 @supports_international_payments.nil?
+      return false if @maximum_payment_amount.nil?
+      return false if @supports_refund_details.nil?
+      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 &&
+          supports_international_payments == o.supports_international_payments &&
+          maximum_payment_amount == o.maximum_payment_amount &&
+          supports_refund_details == o.supports_refund_details &&
+          standing_order_metadata == o.standing_order_metadata
+    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
+      [supports_international_payments, maximum_payment_amount, supports_refund_details, standing_order_metadata].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