plaid 14.0.0.beta.5 → 14.3.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.16.6
+The version of the OpenAPI document: 2020-09-14_1.33.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0

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.16.6
+The version of the OpenAPI document: 2020-09-14_1.33.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -40,10 +40,10 @@ module Plaid
     # The original value of the `start_date` provided during the creation of a standing order. If the payment is not a standing order, this field will be `null`.
     attr_accessor :original_start_date
 
-    # The start date sent to the bank after adjusting for holidays or weekends.  Will be provided in ISO 8601 format (YYYY-MM-DD). If the start date did not require adjustment, or if the payment is not a standing order, this field will be `null`.
+    # 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, or if the payment is not a standing order, this field will be `null`.
     attr_accessor :adjusted_start_date
 
-    # The timestamp of the update, in ISO 8601 format, e.g. `\"2017-09-14T14:42:19.350Z\"`
+    # The timestamp of the update, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g. `\"2017-09-14T14:42:19.350Z\"`
     attr_accessor :timestamp
 
     attr_accessor :error
@@ -104,7 +104,7 @@ module Plaid
         :'adjusted_reference' => :'String',
         :'original_start_date' => :'Date',
         :'adjusted_start_date' => :'Date',
-        :'timestamp' => :'String',
+        :'timestamp' => :'Time',
         :'error' => :'Error'
       }
     end

data/lib/plaid/models/paystub.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.16.6
+The version of the OpenAPI document: 2020-09-14_1.33.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -16,18 +16,25 @@ require 'time'
 module Plaid
   # An object representing data extracted from the end user's paystub.
   class Paystub
-    # The unique identifier for this paystub.
-    attr_accessor :paystub_id
+    attr_accessor :deductions
 
-    # The account identifier for the account associated with this paystub.
-    attr_accessor :account_id
+    # An identifier of the document referenced by the document metadata.
+    attr_accessor :doc_id
+
+    attr_accessor :earnings
 
     attr_accessor :employer
 
     attr_accessor :employee
 
+    attr_accessor :employment_details
+
+    attr_accessor :net_pay
+
     attr_accessor :pay_period_details
 
+    attr_accessor :paystub_details
+
     attr_accessor :income_breakdown
 
     attr_accessor :ytd_earnings
@@ -35,11 +42,15 @@ module Plaid
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'paystub_id' => :'paystub_id',
-        :'account_id' => :'account_id',
+        :'deductions' => :'deductions',
+        :'doc_id' => :'doc_id',
+        :'earnings' => :'earnings',
         :'employer' => :'employer',
         :'employee' => :'employee',
+        :'employment_details' => :'employment_details',
+        :'net_pay' => :'net_pay',
         :'pay_period_details' => :'pay_period_details',
+        :'paystub_details' => :'paystub_details',
         :'income_breakdown' => :'income_breakdown',
         :'ytd_earnings' => :'ytd_earnings'
       }
@@ -53,12 +64,16 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'paystub_id' => :'String',
-        :'account_id' => :'String',
-        :'employer' => :'Employer',
+        :'deductions' => :'Deductions',
+        :'doc_id' => :'String',
+        :'earnings' => :'Earnings',
+        :'employer' => :'PaystubEmployer',
         :'employee' => :'Employee',
+        :'employment_details' => :'EmploymentDetails',
+        :'net_pay' => :'NetPay',
         :'pay_period_details' => :'PayPeriodDetails',
-        :'income_breakdown' => :'IncomeBreakdown',
+        :'paystub_details' => :'PaystubDetails',
+        :'income_breakdown' => :'Array<IncomeBreakdown>',
         :'ytd_earnings' => :'PaystubYTDDetails'
       }
     end
@@ -66,7 +81,6 @@ module Plaid
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'account_id',
       ])
     end
 
@@ -85,12 +99,16 @@ module Plaid
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'paystub_id')
-        self.paystub_id = attributes[:'paystub_id']
+      if attributes.key?(:'deductions')
+        self.deductions = attributes[:'deductions']
       end
 
-      if attributes.key?(:'account_id')
-        self.account_id = attributes[:'account_id']
+      if attributes.key?(:'doc_id')
+        self.doc_id = attributes[:'doc_id']
+      end
+
+      if attributes.key?(:'earnings')
+        self.earnings = attributes[:'earnings']
       end
 
       if attributes.key?(:'employer')
@@ -101,12 +119,26 @@ module Plaid
         self.employee = attributes[:'employee']
       end
 
+      if attributes.key?(:'employment_details')
+        self.employment_details = attributes[:'employment_details']
+      end
+
+      if attributes.key?(:'net_pay')
+        self.net_pay = attributes[:'net_pay']
+      end
+
       if attributes.key?(:'pay_period_details')
         self.pay_period_details = attributes[:'pay_period_details']
       end
 
+      if attributes.key?(:'paystub_details')
+        self.paystub_details = attributes[:'paystub_details']
+      end
+
       if attributes.key?(:'income_breakdown')
-        self.income_breakdown = attributes[:'income_breakdown']
+        if (value = attributes[:'income_breakdown']).is_a?(Array)
+          self.income_breakdown = value
+        end
       end
 
       if attributes.key?(:'ytd_earnings')
@@ -118,10 +150,6 @@ module Plaid
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @paystub_id.nil?
-        invalid_properties.push('invalid value for "paystub_id", paystub_id cannot be nil.')
-      end
-
       if @employer.nil?
         invalid_properties.push('invalid value for "employer", employer cannot be nil.')
       end
@@ -148,7 +176,6 @@ module Plaid
     # 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 @paystub_id.nil?
       return false if @employer.nil?
       return false if @employee.nil?
       return false if @pay_period_details.nil?
@@ -162,11 +189,15 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          paystub_id == o.paystub_id &&
-          account_id == o.account_id &&
+          deductions == o.deductions &&
+          doc_id == o.doc_id &&
+          earnings == o.earnings &&
           employer == o.employer &&
           employee == o.employee &&
+          employment_details == o.employment_details &&
+          net_pay == o.net_pay &&
           pay_period_details == o.pay_period_details &&
+          paystub_details == o.paystub_details &&
           income_breakdown == o.income_breakdown &&
           ytd_earnings == o.ytd_earnings
     end
@@ -180,7 +211,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [paystub_id, account_id, employer, employee, pay_period_details, income_breakdown, ytd_earnings].hash
+      [deductions, doc_id, earnings, employer, employee, employment_details, net_pay, pay_period_details, paystub_details, income_breakdown, ytd_earnings].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/paystub_address.rb

@@ -0,0 +1,297 @@
+=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.33.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class PaystubAddress
+    # The full city name.
+    attr_accessor :city
+
+    # The listed street address.
+    attr_accessor :street
+
+    # Street address line 1.
+    attr_accessor :line1
+
+    # Street address line 2.
+    attr_accessor :line2
+
+    # 5 digit postal code.
+    attr_accessor :postal_code
+
+    # The region or state Example: `\"NC\"`
+    attr_accessor :region
+
+    # The region or state Example: `\"NC\"`
+    attr_accessor :state_code
+
+    # The country of the address.
+    attr_accessor :country
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'city' => :'city',
+        :'street' => :'street',
+        :'line1' => :'line1',
+        :'line2' => :'line2',
+        :'postal_code' => :'postal_code',
+        :'region' => :'region',
+        :'state_code' => :'state_code',
+        :'country' => :'country'
+      }
+    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
+      {
+        :'city' => :'String',
+        :'street' => :'String',
+        :'line1' => :'String',
+        :'line2' => :'String',
+        :'postal_code' => :'String',
+        :'region' => :'String',
+        :'state_code' => :'String',
+        :'country' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'city',
+        :'street',
+        :'line1',
+        :'line2',
+        :'postal_code',
+        :'region',
+        :'state_code',
+        :'country'
+      ])
+    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::PaystubAddress` 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::PaystubAddress`. 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?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'street')
+        self.street = attributes[:'street']
+      end
+
+      if attributes.key?(:'line1')
+        self.line1 = attributes[:'line1']
+      end
+
+      if attributes.key?(:'line2')
+        self.line2 = attributes[:'line2']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'state_code')
+        self.state_code = attributes[:'state_code']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      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 &&
+          city == o.city &&
+          street == o.street &&
+          line1 == o.line1 &&
+          line2 == o.line2 &&
+          postal_code == o.postal_code &&
+          region == o.region &&
+          state_code == o.state_code &&
+          country == o.country
+    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
+      [city, street, line1, line2, postal_code, region, state_code, country].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