plaid 14.4.0 → 14.8.0

data/lib/plaid/models/distribution_breakdown.rb

@@ -0,0 +1,296 @@
+=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.46.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Information about the accounts that the payment was distributed to.
+  class DistributionBreakdown
+    # Name of the account for the given distribution.
+    attr_accessor :account_name
+
+    # The name of the bank that the payment is being deposited to.
+    attr_accessor :bank_name
+
+    # The amount distributed to this account.
+    attr_accessor :current_amount
+
+    # The ISO-4217 currency code of the net pay. Always `null` if `unofficial_currency_code` is non-null.
+    attr_accessor :iso_currency_code
+
+    # The last 2-4 alphanumeric characters of an account's official account number.
+    attr_accessor :mask
+
+    # Type of the account that the paystub was sent to (e.g. 'checking').
+    attr_accessor :type
+
+    # The unofficial currency code associated with the net pay. 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
+
+    attr_accessor :current_pay
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_name' => :'account_name',
+        :'bank_name' => :'bank_name',
+        :'current_amount' => :'current_amount',
+        :'iso_currency_code' => :'iso_currency_code',
+        :'mask' => :'mask',
+        :'type' => :'type',
+        :'unofficial_currency_code' => :'unofficial_currency_code',
+        :'current_pay' => :'current_pay'
+      }
+    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
+      {
+        :'account_name' => :'String',
+        :'bank_name' => :'String',
+        :'current_amount' => :'Float',
+        :'iso_currency_code' => :'String',
+        :'mask' => :'String',
+        :'type' => :'String',
+        :'unofficial_currency_code' => :'String',
+        :'current_pay' => :'Pay'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'account_name',
+        :'bank_name',
+        :'current_amount',
+        :'iso_currency_code',
+        :'mask',
+        :'type',
+        :'unofficial_currency_code',
+      ])
+    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::DistributionBreakdown` 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::DistributionBreakdown`. 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?(:'account_name')
+        self.account_name = attributes[:'account_name']
+      end
+
+      if attributes.key?(:'bank_name')
+        self.bank_name = attributes[:'bank_name']
+      end
+
+      if attributes.key?(:'current_amount')
+        self.current_amount = attributes[:'current_amount']
+      end
+
+      if attributes.key?(:'iso_currency_code')
+        self.iso_currency_code = attributes[:'iso_currency_code']
+      end
+
+      if attributes.key?(:'mask')
+        self.mask = attributes[:'mask']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'unofficial_currency_code')
+        self.unofficial_currency_code = attributes[:'unofficial_currency_code']
+      end
+
+      if attributes.key?(:'current_pay')
+        self.current_pay = attributes[:'current_pay']
+      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 &&
+          account_name == o.account_name &&
+          bank_name == o.bank_name &&
+          current_amount == o.current_amount &&
+          iso_currency_code == o.iso_currency_code &&
+          mask == o.mask &&
+          type == o.type &&
+          unofficial_currency_code == o.unofficial_currency_code &&
+          current_pay == o.current_pay
+    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
+      [account_name, bank_name, current_amount, iso_currency_code, mask, type, unofficial_currency_code, current_pay].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/doc_type.rb

@@ -0,0 +1,45 @@
+=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.46.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class DocType
+    UNKNOWN = "UNKNOWN".freeze
+    DOCUMENT_TYPE_PAYSTUB = "DOCUMENT_TYPE_PAYSTUB".freeze
+    DOCUMENT_TYPE_BANK_STATEMENT = "DOCUMENT_TYPE_BANK_STATEMENT".freeze
+    DOCUMENT_TYPE_US_TAX_W2 = "DOCUMENT_TYPE_US_TAX_W2".freeze
+    DOCUMENT_TYPE_US_MILITARY_ERAS = "DOCUMENT_TYPE_US_MILITARY_ERAS".freeze
+    DOCUMENT_TYPE_US_MILITARY_LES = "DOCUMENT_TYPE_US_MILITARY_LES".freeze
+    DOCUMENT_TYPE_US_MILITARY_CLES = "DOCUMENT_TYPE_US_MILITARY_CLES".freeze
+    DOCUMENT_TYPE_GIG = "DOCUMENT_TYPE_GIG".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # 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/document_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.34.1
+The version of the OpenAPI document: 2020-09-14_1.46.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -25,12 +25,15 @@ module Plaid
     # An identifier of the document that is also present in the paystub response.
     attr_accessor :doc_id
 
+    attr_accessor :doc_type
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'status' => :'status',
-        :'doc_id' => :'doc_id'
+        :'doc_id' => :'doc_id',
+        :'doc_type' => :'doc_type'
       }
     end
 
@@ -44,7 +47,8 @@ module Plaid
       {
         :'name' => :'String',
         :'status' => :'String',
-        :'doc_id' => :'String'
+        :'doc_id' => :'String',
+        :'doc_type' => :'DocType'
       }
     end
 
@@ -80,6 +84,10 @@ module Plaid
       if attributes.key?(:'doc_id')
         self.doc_id = attributes[:'doc_id']
       end
+
+      if attributes.key?(:'doc_type')
+        self.doc_type = attributes[:'doc_type']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -102,7 +110,8 @@ module Plaid
       self.class == o.class &&
           name == o.name &&
           status == o.status &&
-          doc_id == o.doc_id
+          doc_id == o.doc_id &&
+          doc_type == o.doc_type
     end
 
     # @see the `==` method
@@ -114,7 +123,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, status, doc_id].hash
+      [name, status, doc_id, doc_type].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/earnings.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.34.1
+The version of the OpenAPI document: 2020-09-14_1.46.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -20,11 +20,17 @@ module Plaid
 
     attr_accessor :totals
 
+    attr_accessor :breakdown
+
+    attr_accessor :total
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'subtotals' => :'subtotals',
-        :'totals' => :'totals'
+        :'totals' => :'totals',
+        :'breakdown' => :'breakdown',
+        :'total' => :'total'
       }
     end
 
@@ -37,7 +43,9 @@ module Plaid
     def self.openapi_types
       {
         :'subtotals' => :'Array<EarningsTotal>',
-        :'totals' => :'Array<EarningsTotal>'
+        :'totals' => :'Array<EarningsTotal>',
+        :'breakdown' => :'Array<EarningsBreakdown>',
+        :'total' => :'EarningsTotal'
       }
     end
 
@@ -73,6 +81,16 @@ module Plaid
           self.totals = value
         end
       end
+
+      if attributes.key?(:'breakdown')
+        if (value = attributes[:'breakdown']).is_a?(Array)
+          self.breakdown = value
+        end
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,7 +112,9 @@ module Plaid
       return true if self.equal?(o)
       self.class == o.class &&
           subtotals == o.subtotals &&
-          totals == o.totals
+          totals == o.totals &&
+          breakdown == o.breakdown &&
+          total == o.total
     end
 
     # @see the `==` method
@@ -106,7 +126,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subtotals, totals].hash
+      [subtotals, totals, breakdown, total].hash
     end
 
     # Builds the object from hash