plaid 14.2.0 → 14.6.0

data/lib/plaid/models/pay_period_details.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.31.1
+The version of the OpenAPI document: 2020-09-14_1.40.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -16,29 +16,62 @@ require 'time'
 module Plaid
   # Details about the pay period.
   class PayPeriodDetails
-    # The pay period start date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
-    attr_accessor :start_date
+    # The amount of the paycheck.
+    attr_accessor :check_amount
+
+    attr_accessor :distribution_breakdown
 
     # The pay period end date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
     attr_accessor :end_date
 
+    # Total earnings before tax/deductions.
+    attr_accessor :gross_earnings
+
+    # The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (\"yyyy-mm-dd\").
+    attr_accessor :pay_date
+
+    # The frequency at which an individual is paid.
+    attr_accessor :pay_frequency
+
     # 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.
-    attr_accessor :gross_earnings
+    # The pay period start date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: \"yyyy-mm-dd\".
+    attr_accessor :start_date
 
-    # The net amount of the paycheck.
-    attr_accessor :check_amount
+    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
       {
-        :'start_date' => :'start_date',
+        :'check_amount' => :'check_amount',
+        :'distribution_breakdown' => :'distribution_breakdown',
         :'end_date' => :'end_date',
-        :'pay_day' => :'pay_day',
         :'gross_earnings' => :'gross_earnings',
-        :'check_amount' => :'check_amount'
+        :'pay_date' => :'pay_date',
+        :'pay_frequency' => :'pay_frequency',
+        :'pay_day' => :'pay_day',
+        :'start_date' => :'start_date'
       }
     end
 
@@ -50,22 +83,27 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'start_date' => :'Date',
+        :'check_amount' => :'Float',
+        :'distribution_breakdown' => :'Array<DistributionBreakdown>',
         :'end_date' => :'Date',
-        :'pay_day' => :'Date',
         :'gross_earnings' => :'Float',
-        :'check_amount' => :'Float'
+        :'pay_date' => :'Date',
+        :'pay_frequency' => :'String',
+        :'pay_day' => :'Date',
+        :'start_date' => :'Date'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'start_date',
+        :'check_amount',
         :'end_date',
-        :'pay_day',
         :'gross_earnings',
-        :'check_amount'
+        :'pay_date',
+        :'pay_frequency',
+        :'pay_day',
+        :'start_date'
       ])
     end
 
@@ -84,24 +122,38 @@ module Plaid
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'start_date')
-        self.start_date = attributes[:'start_date']
+      if attributes.key?(:'check_amount')
+        self.check_amount = attributes[:'check_amount']
       end
 
-      if attributes.key?(:'end_date')
-        self.end_date = attributes[:'end_date']
+      if attributes.key?(:'distribution_breakdown')
+        if (value = attributes[:'distribution_breakdown']).is_a?(Array)
+          self.distribution_breakdown = value
+        end
       end
 
-      if attributes.key?(:'pay_day')
-        self.pay_day = attributes[:'pay_day']
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
       end
 
       if attributes.key?(:'gross_earnings')
         self.gross_earnings = attributes[:'gross_earnings']
       end
 
-      if attributes.key?(:'check_amount')
-        self.check_amount = attributes[:'check_amount']
+      if attributes.key?(:'pay_date')
+        self.pay_date = attributes[:'pay_date']
+      end
+
+      if attributes.key?(:'pay_frequency')
+        self.pay_frequency = attributes[:'pay_frequency']
+      end
+
+      if attributes.key?(:'pay_day')
+        self.pay_day = attributes[:'pay_day']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
       end
     end
 
@@ -115,19 +167,34 @@ module Plaid
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      pay_frequency_validator = EnumAttributeValidator.new('String', ["PAY_FREQUENCY_UNKNOWN", "PAY_FREQUENCY_WEEKLY", "PAY_FREQUENCY_BIWEEKLY", "PAY_FREQUENCY_SEMIMONTHLY", "PAY_FREQUENCY_MONTHLY", "null"])
+      return false unless pay_frequency_validator.valid?(@pay_frequency)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pay_frequency Object to be assigned
+    def pay_frequency=(pay_frequency)
+      validator = EnumAttributeValidator.new('String', ["PAY_FREQUENCY_UNKNOWN", "PAY_FREQUENCY_WEEKLY", "PAY_FREQUENCY_BIWEEKLY", "PAY_FREQUENCY_SEMIMONTHLY", "PAY_FREQUENCY_MONTHLY", "null"])
+      unless validator.valid?(pay_frequency)
+        fail ArgumentError, "invalid value for \"pay_frequency\", must be one of #{validator.allowable_values}."
+      end
+      @pay_frequency = pay_frequency
+    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 &&
-          start_date == o.start_date &&
+          check_amount == o.check_amount &&
+          distribution_breakdown == o.distribution_breakdown &&
           end_date == o.end_date &&
-          pay_day == o.pay_day &&
           gross_earnings == o.gross_earnings &&
-          check_amount == o.check_amount
+          pay_date == o.pay_date &&
+          pay_frequency == o.pay_frequency &&
+          pay_day == o.pay_day &&
+          start_date == o.start_date
     end
 
     # @see the `==` method
@@ -139,7 +206,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [start_date, end_date, pay_day, gross_earnings, check_amount].hash
+      [check_amount, distribution_breakdown, end_date, gross_earnings, pay_date, pay_frequency, pay_day, start_date].hash
     end
 
     # Builds the object from hash

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/plaid/models/payment_schedule_interval.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.31.1
+The version of the OpenAPI document: 2020-09-14_1.40.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -29,9 +29,11 @@ module Plaid
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      constantValues = PaymentScheduleInterval.constants.select { |c| PaymentScheduleInterval::const_get(c) == value }
-      raise "Invalid ENUM value #{value} for class #PaymentScheduleInterval" if constantValues.empty?
+      # We do not validate that the value is one of the enums set in the OpenAPI
+      # file because we want to be able to add to our list of enums without
+      # breaking this client library.
       value
     end
   end
+
 end

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