plaid 14.0.0 → 14.1.0

data/lib/plaid/models/total.rb

@@ -0,0 +1,284 @@
+=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.26.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # An object representing both the current pay period and year to date amount for a category.
+  class Total
+    # 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
+
+    attr_accessor :current_pay
+
+    attr_accessor :ytd_pay
+
+    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',
+        :'description' => :'description',
+        :'current_pay' => :'current_pay',
+        :'ytd_pay' => :'ytd_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
+      {
+        :'canonical_description' => :'String',
+        :'description' => :'String',
+        :'current_pay' => :'Pay',
+        :'ytd_pay' => :'Pay'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'canonical_description',
+        :'description',
+      ])
+    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::Total` 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::Total`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'current_pay')
+        self.current_pay = attributes[:'current_pay']
+      end
+
+      if attributes.key?(:'ytd_pay')
+        self.ytd_pay = attributes[:'ytd_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?
+      canonical_description_validator = EnumAttributeValidator.new('String', ["Bonus", "Commission", "Overtime", "Paid Time Off", "Regular Pay", "Vacation", "Employee Medicare", "FICA", "Social Security Employee Tax", "Medical", "Vision", "Dental"])
+      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", "Employee Medicare", "FICA", "Social Security Employee Tax", "Medical", "Vision", "Dental"])
+      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 &&
+          description == o.description &&
+          current_pay == o.current_pay &&
+          ytd_pay == o.ytd_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
+      [canonical_description, description, current_pay, ytd_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/transaction.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.26.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -53,7 +53,7 @@ module Plaid
     # The unofficial currency code associated with the transaction. 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
 
-    # For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ).
+    # For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ).
     attr_accessor :date
 
     # When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
@@ -68,15 +68,18 @@ module Plaid
     # The merchant name, as extracted by Plaid from the `name` field.
     attr_accessor :merchant_name
 
-    # The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ).
+    # The date that the transaction was authorized. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ).
     attr_accessor :authorized_date
 
-    # Date and time when a transaction was authorized in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`.
+    # Date and time when a transaction was authorized in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`.
     attr_accessor :authorized_datetime
 
-    # Date and time when a transaction was posted in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`.
+    # Date and time when a transaction was posted in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`.
     attr_accessor :datetime
 
+    # The check number of the transaction. This field is only populated for check transactions.
+    attr_accessor :check_number
+
     attr_accessor :transaction_code
 
     class EnumAttributeValidator
@@ -125,6 +128,7 @@ module Plaid
         :'authorized_date' => :'authorized_date',
         :'authorized_datetime' => :'authorized_datetime',
         :'datetime' => :'datetime',
+        :'check_number' => :'check_number',
         :'transaction_code' => :'transaction_code'
       }
     end
@@ -158,6 +162,7 @@ module Plaid
         :'authorized_date' => :'Date',
         :'authorized_datetime' => :'Time',
         :'datetime' => :'Time',
+        :'check_number' => :'String',
         :'transaction_code' => :'TransactionCode'
       }
     end
@@ -176,6 +181,7 @@ module Plaid
         :'authorized_date',
         :'authorized_datetime',
         :'datetime',
+        :'check_number',
         :'transaction_code'
       ])
     end
@@ -289,6 +295,10 @@ module Plaid
         self.datetime = attributes[:'datetime']
       end
 
+      if attributes.key?(:'check_number')
+        self.check_number = attributes[:'check_number']
+      end
+
       if attributes.key?(:'transaction_code')
         self.transaction_code = attributes[:'transaction_code']
       end
@@ -402,6 +412,7 @@ module Plaid
           authorized_date == o.authorized_date &&
           authorized_datetime == o.authorized_datetime &&
           datetime == o.datetime &&
+          check_number == o.check_number &&
           transaction_code == o.transaction_code
     end
 
@@ -414,7 +425,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [transaction_type, pending_transaction_id, category_id, category, location, payment_meta, account_owner, name, original_description, account_id, amount, iso_currency_code, unofficial_currency_code, date, pending, transaction_id, payment_channel, merchant_name, authorized_date, authorized_datetime, datetime, transaction_code].hash
+      [transaction_type, pending_transaction_id, category_id, category, location, payment_meta, account_owner, name, original_description, account_id, amount, iso_currency_code, unofficial_currency_code, date, pending, transaction_id, payment_channel, merchant_name, authorized_date, authorized_datetime, datetime, check_number, transaction_code].hash
     end
 
     # Builds the object from hash

data/lib/plaid/models/transaction_all_of.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.26.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -21,15 +21,18 @@ module Plaid
     # The merchant name, as extracted by Plaid from the `name` field.
     attr_accessor :merchant_name
 
-    # The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ).
+    # The date that the transaction was authorized. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ).
     attr_accessor :authorized_date
 
-    # Date and time when a transaction was authorized in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`.
+    # Date and time when a transaction was authorized in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`.
     attr_accessor :authorized_datetime
 
-    # Date and time when a transaction was posted in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`.
+    # Date and time when a transaction was posted in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is only populated for UK institutions. For institutions in other countries, will be `null`.
     attr_accessor :datetime
 
+    # The check number of the transaction. This field is only populated for check transactions.
+    attr_accessor :check_number
+
     attr_accessor :transaction_code
 
     class EnumAttributeValidator
@@ -62,6 +65,7 @@ module Plaid
         :'authorized_date' => :'authorized_date',
         :'authorized_datetime' => :'authorized_datetime',
         :'datetime' => :'datetime',
+        :'check_number' => :'check_number',
         :'transaction_code' => :'transaction_code'
       }
     end
@@ -79,6 +83,7 @@ module Plaid
         :'authorized_date' => :'Date',
         :'authorized_datetime' => :'Time',
         :'datetime' => :'Time',
+        :'check_number' => :'String',
         :'transaction_code' => :'TransactionCode'
       }
     end
@@ -90,6 +95,7 @@ module Plaid
         :'authorized_date',
         :'authorized_datetime',
         :'datetime',
+        :'check_number',
         :'transaction_code'
       ])
     end
@@ -129,6 +135,10 @@ module Plaid
         self.datetime = attributes[:'datetime']
       end
 
+      if attributes.key?(:'check_number')
+        self.check_number = attributes[:'check_number']
+      end
+
       if attributes.key?(:'transaction_code')
         self.transaction_code = attributes[:'transaction_code']
       end
@@ -174,6 +184,7 @@ module Plaid
           authorized_date == o.authorized_date &&
           authorized_datetime == o.authorized_datetime &&
           datetime == o.datetime &&
+          check_number == o.check_number &&
           transaction_code == o.transaction_code
     end
 
@@ -186,7 +197,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [payment_channel, merchant_name, authorized_date, authorized_datetime, datetime, transaction_code].hash
+      [payment_channel, merchant_name, authorized_date, authorized_datetime, datetime, check_number, transaction_code].hash
     end
 
     # Builds the object from hash