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

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.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,29 +16,62 @@ require 'time'
 module Plaid
   # Details about the pay period.
   class PayPeriodDetails
-    # The pay period start date, in 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 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\").
+    # 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' => :'String',
-        :'end_date' => :'String',
-        :'pay_day' => :'String',
+        :'check_amount' => :'Float',
+        :'distribution_breakdown' => :'Array<DistributionBreakdown>',
+        :'end_date' => :'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/pay_stub_deductions_breakdown.rb

@@ -0,0 +1,265 @@
+=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
+  # An object representing the deduction line items for the pay period
+  class PayStubDeductionsBreakdown
+    # Raw amount of the deduction
+    attr_accessor :current_amount
+
+    # Description of the deduction line item
+    attr_accessor :description
+
+    # The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null.
+    attr_accessor :iso_currency_code
+
+    # The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.  See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
+    attr_accessor :unofficial_currency_code
+
+    # The year-to-date amount of the deduction
+    attr_accessor :ytd_amount
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'current_amount' => :'current_amount',
+        :'description' => :'description',
+        :'iso_currency_code' => :'iso_currency_code',
+        :'unofficial_currency_code' => :'unofficial_currency_code',
+        :'ytd_amount' => :'ytd_amount'
+      }
+    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
+      {
+        :'current_amount' => :'Float',
+        :'description' => :'String',
+        :'iso_currency_code' => :'String',
+        :'unofficial_currency_code' => :'String',
+        :'ytd_amount' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'current_amount',
+        :'description',
+        :'iso_currency_code',
+        :'unofficial_currency_code',
+        :'ytd_amount'
+      ])
+    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::PayStubDeductionsBreakdown` 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::PayStubDeductionsBreakdown`. 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?(:'current_amount')
+        self.current_amount = attributes[:'current_amount']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'iso_currency_code')
+        self.iso_currency_code = attributes[:'iso_currency_code']
+      end
+
+      if attributes.key?(:'unofficial_currency_code')
+        self.unofficial_currency_code = attributes[:'unofficial_currency_code']
+      end
+
+      if attributes.key?(:'ytd_amount')
+        self.ytd_amount = attributes[:'ytd_amount']
+      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 &&
+          current_amount == o.current_amount &&
+          description == o.description &&
+          iso_currency_code == o.iso_currency_code &&
+          unofficial_currency_code == o.unofficial_currency_code &&
+          ytd_amount == o.ytd_amount
+    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
+      [current_amount, description, iso_currency_code, unofficial_currency_code, ytd_amount].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