plaid 14.0.0 → 14.4.0

data/lib/plaid/models/payment_initiation_refund.rb

@@ -0,0 +1,303 @@
+=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.34.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # PaymentInitiationRefund defines a payment initiation refund
+  class PaymentInitiationRefund
+    # The ID of the refund. Like all Plaid identifiers, the `refund_id` is case sensitive.
+    attr_accessor :refund_id
+
+    attr_accessor :amount
+
+    # The status of the refund.  `PROCESSING`: The refund is currently being processed. The refund will automatically exit this state when processing is complete.  `INITIATED`: The refund has been successfully initiated.  `EXECUTED`: Indicates that the refund has been successfully executed.  `FAILED`: The refund has failed to be executed. This error is retryable once the root cause is resolved.
+    attr_accessor :status
+
+    # The date and time of the last time the `status` was updated, in IS0 8601 format
+    attr_accessor :last_status_update
+
+    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
+      {
+        :'refund_id' => :'refund_id',
+        :'amount' => :'amount',
+        :'status' => :'status',
+        :'last_status_update' => :'last_status_update'
+      }
+    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
+      {
+        :'refund_id' => :'String',
+        :'amount' => :'PaymentAmount',
+        :'status' => :'String',
+        :'last_status_update' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::PaymentInitiationRefund` 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::PaymentInitiationRefund`. 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?(:'refund_id')
+        self.refund_id = attributes[:'refund_id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'last_status_update')
+        self.last_status_update = attributes[:'last_status_update']
+      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 @refund_id.nil?
+        invalid_properties.push('invalid value for "refund_id", refund_id cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @last_status_update.nil?
+        invalid_properties.push('invalid value for "last_status_update", last_status_update 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 @refund_id.nil?
+      return false if @amount.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["PROCESSING", "INITIATED", "EXECUTED", "FAILED"])
+      return false unless status_validator.valid?(@status)
+      return false if @last_status_update.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["PROCESSING", "INITIATED", "EXECUTED", "FAILED"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          refund_id == o.refund_id &&
+          amount == o.amount &&
+          status == o.status &&
+          last_status_update == o.last_status_update
+    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
+      [refund_id, amount, status, last_status_update].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/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.20.6
+The version of the OpenAPI document: 2020-09-14_1.34.1
 
 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.20.6
+The version of the OpenAPI document: 2020-09-14_1.34.1
 
 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.20.6
+The version of the OpenAPI document: 2020-09-14_1.34.1
 
 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.20.6
+The version of the OpenAPI document: 2020-09-14_1.34.1
 
 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

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.20.6
+The version of the OpenAPI document: 2020-09-14_1.34.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -16,15 +16,25 @@ require 'time'
 module Plaid
   # An object representing data extracted from the end user's paystub.
   class Paystub
-    # The account identifier for the account associated with this paystub.
-    attr_accessor :account_id
+    attr_accessor :deductions
+
+    # 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
@@ -32,10 +42,15 @@ module Plaid
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'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'
       }
@@ -49,11 +64,16 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'account_id' => :'String',
+        :'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
@@ -61,7 +81,6 @@ module Plaid
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'account_id',
       ])
     end
 
@@ -80,8 +99,16 @@ module Plaid
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'account_id')
-        self.account_id = attributes[:'account_id']
+      if attributes.key?(:'deductions')
+        self.deductions = attributes[:'deductions']
+      end
+
+      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')
@@ -92,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')
@@ -148,10 +189,15 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          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
@@ -165,7 +211,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [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