plaid 14.5.0 → 14.6.0

data/lib/plaid/models/earnings_breakdown.rb

@@ -0,0 +1,332 @@
+=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.40.3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # An object representing the earnings line items for the pay period.
+  class EarningsBreakdown
+    # Commonly used term to describe the earning line item.
+    attr_accessor :canonical_description
+
+    # Raw amount of the earning line item.
+    attr_accessor :current_amount
+
+    # Description of the earning line item.
+    attr_accessor :description
+
+    # Number of hours applicable for this earning.
+    attr_accessor :hours
+
+    # The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null.
+    attr_accessor :iso_currency_code
+
+    # Hourly rate applicable for this earning.
+    attr_accessor :rate
+
+    # 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
+
+    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
+      {
+        :'canonical_description' => :'canonical_description',
+        :'current_amount' => :'current_amount',
+        :'description' => :'description',
+        :'hours' => :'hours',
+        :'iso_currency_code' => :'iso_currency_code',
+        :'rate' => :'rate',
+        :'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
+      {
+        :'canonical_description' => :'String',
+        :'current_amount' => :'Float',
+        :'description' => :'String',
+        :'hours' => :'Float',
+        :'iso_currency_code' => :'String',
+        :'rate' => :'Float',
+        :'unofficial_currency_code' => :'String',
+        :'ytd_amount' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'canonical_description',
+        :'current_amount',
+        :'description',
+        :'hours',
+        :'iso_currency_code',
+        :'rate',
+        :'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::EarningsBreakdown` 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::EarningsBreakdown`. 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?(:'canonical_description')
+        self.canonical_description = attributes[:'canonical_description']
+      end
+
+      if attributes.key?(:'current_amount')
+        self.current_amount = attributes[:'current_amount']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'hours')
+        self.hours = attributes[:'hours']
+      end
+
+      if attributes.key?(:'iso_currency_code')
+        self.iso_currency_code = attributes[:'iso_currency_code']
+      end
+
+      if attributes.key?(:'rate')
+        self.rate = attributes[:'rate']
+      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?
+      canonical_description_validator = EnumAttributeValidator.new('String', ["BONUS", "COMMISSION", "OVERTIME", "PAID TIME OFF", "REGULAR PAY", "VACATION", "OTHER", "null"])
+      return false unless canonical_description_validator.valid?(@canonical_description)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] canonical_description Object to be assigned
+    def canonical_description=(canonical_description)
+      validator = EnumAttributeValidator.new('String', ["BONUS", "COMMISSION", "OVERTIME", "PAID TIME OFF", "REGULAR PAY", "VACATION", "OTHER", "null"])
+      unless validator.valid?(canonical_description)
+        fail ArgumentError, "invalid value for \"canonical_description\", must be one of #{validator.allowable_values}."
+      end
+      @canonical_description = canonical_description
+    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 &&
+          canonical_description == o.canonical_description &&
+          current_amount == o.current_amount &&
+          description == o.description &&
+          hours == o.hours &&
+          iso_currency_code == o.iso_currency_code &&
+          rate == o.rate &&
+          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
+      [canonical_description, current_amount, description, hours, iso_currency_code, rate, 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

data/lib/plaid/models/earnings_total.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.37.4
+The version of the OpenAPI document: 2020-09-14_1.40.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -19,16 +19,24 @@ module Plaid
     # Commonly used term to describe the line item.
     attr_accessor :canonical_description
 
-    # Text of the line item as printed on the paystub.
-    attr_accessor :description
+    # Total amount of the earnings for this pay period
+    attr_accessor :current_amount
 
     attr_accessor :current_pay
 
     attr_accessor :ytd_pay
 
-    attr_accessor :current_hours
+    # Total number of hours worked for this pay period
+    attr_accessor :hours
 
-    attr_accessor :current_rate
+    # 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 security. 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 total year-to-date amount of the earnings
+    attr_accessor :ytd_amount
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -56,11 +64,13 @@ module Plaid
     def self.attribute_map
       {
         :'canonical_description' => :'canonical_description',
-        :'description' => :'description',
+        :'current_amount' => :'current_amount',
         :'current_pay' => :'current_pay',
         :'ytd_pay' => :'ytd_pay',
-        :'current_hours' => :'current_hours',
-        :'current_rate' => :'current_rate'
+        :'hours' => :'hours',
+        :'iso_currency_code' => :'iso_currency_code',
+        :'unofficial_currency_code' => :'unofficial_currency_code',
+        :'ytd_amount' => :'ytd_amount'
       }
     end
 
@@ -73,11 +83,13 @@ module Plaid
     def self.openapi_types
       {
         :'canonical_description' => :'String',
-        :'description' => :'String',
+        :'current_amount' => :'Float',
         :'current_pay' => :'Pay',
         :'ytd_pay' => :'Pay',
-        :'current_hours' => :'String',
-        :'current_rate' => :'String'
+        :'hours' => :'Float',
+        :'iso_currency_code' => :'String',
+        :'unofficial_currency_code' => :'String',
+        :'ytd_amount' => :'Float'
       }
     end
 
@@ -85,9 +97,11 @@ module Plaid
     def self.openapi_nullable
       Set.new([
         :'canonical_description',
-        :'description',
-        :'current_hours',
-        :'current_rate'
+        :'current_amount',
+        :'hours',
+        :'iso_currency_code',
+        :'unofficial_currency_code',
+        :'ytd_amount'
       ])
     end
 
@@ -110,8 +124,8 @@ module Plaid
         self.canonical_description = attributes[:'canonical_description']
       end
 
-      if attributes.key?(:'description')
-        self.description = attributes[:'description']
+      if attributes.key?(:'current_amount')
+        self.current_amount = attributes[:'current_amount']
       end
 
       if attributes.key?(:'current_pay')
@@ -122,12 +136,20 @@ module Plaid
         self.ytd_pay = attributes[:'ytd_pay']
       end
 
-      if attributes.key?(:'current_hours')
-        self.current_hours = attributes[:'current_hours']
+      if attributes.key?(:'hours')
+        self.hours = attributes[:'hours']
+      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?(:'current_rate')
-        self.current_rate = attributes[:'current_rate']
+      if attributes.key?(:'ytd_amount')
+        self.ytd_amount = attributes[:'ytd_amount']
       end
     end
 
@@ -162,11 +184,13 @@ module Plaid
       return true if self.equal?(o)
       self.class == o.class &&
           canonical_description == o.canonical_description &&
-          description == o.description &&
+          current_amount == o.current_amount &&
           current_pay == o.current_pay &&
           ytd_pay == o.ytd_pay &&
-          current_hours == o.current_hours &&
-          current_rate == o.current_rate
+          hours == o.hours &&
+          iso_currency_code == o.iso_currency_code &&
+          unofficial_currency_code == o.unofficial_currency_code &&
+          ytd_amount == o.ytd_amount
     end
 
     # @see the `==` method
@@ -178,7 +202,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [canonical_description, description, current_pay, ytd_pay, current_hours, current_rate].hash
+      [canonical_description, current_amount, current_pay, ytd_pay, hours, iso_currency_code, unofficial_currency_code, ytd_amount].hash
     end
 
     # Builds the object from hash

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.37.4
+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/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.37.4
+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,11 +16,11 @@ require 'time'
 module Plaid
   # Data about the employee.
   class Employee
+    attr_accessor :address
+
     # The name of the employee.
     attr_accessor :name
 
-    attr_accessor :address
-
     # Marital status of the employee.
     attr_accessor :marital_status
 
@@ -29,8 +29,8 @@ module Plaid
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'name' => :'name',
         :'address' => :'address',
+        :'name' => :'name',
         :'marital_status' => :'marital_status',
         :'taxpayer_id' => :'taxpayer_id'
       }
@@ -44,8 +44,8 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'name' => :'String',
         :'address' => :'PaystubAddress',
+        :'name' => :'String',
         :'marital_status' => :'String',
         :'taxpayer_id' => :'TaxpayerID'
       }
@@ -74,14 +74,14 @@ module Plaid
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      end
-
       if attributes.key?(:'address')
         self.address = attributes[:'address']
       end
 
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.key?(:'marital_status')
         self.marital_status = attributes[:'marital_status']
       end
@@ -114,8 +114,8 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          name == o.name &&
           address == o.address &&
+          name == o.name &&
           marital_status == o.marital_status &&
           taxpayer_id == o.taxpayer_id
     end
@@ -129,7 +129,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, address, marital_status, taxpayer_id].hash
+      [address, name, marital_status, taxpayer_id].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.37.4
+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/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.37.4
+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/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.37.4
+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/employer_verification.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.37.4
+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/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.37.4
+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/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.37.4
+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/employment_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.37.4
+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/employment_verification.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.37.4
+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/employment_verification_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.37.4
+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/employment_verification_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.37.4
+The version of the OpenAPI document: 2020-09-14_1.40.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0