plaid 21.0.0 → 21.1.0

data/lib/plaid/models/base_report_transaction.rb

@@ -0,0 +1,404 @@
+=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.410.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # A transaction on the Base Report
+  class BaseReportTransaction
+    # The settled value of the transaction, denominated in the transaction's currency, as stated in `iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.
+    attr_accessor :amount
+
+    # The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null.
+    attr_accessor :iso_currency_code
+
+    # 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 `unofficial_currency_code`s.
+    attr_accessor :unofficial_currency_code
+
+    # The string returned by the financial institution to describe the transaction.
+    attr_accessor :original_description
+
+    # A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget).
+    attr_accessor :category
+
+    # The ID of the category to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget).
+    attr_accessor :category_id
+
+    attr_accessor :credit_category
+
+    # The check number of the transaction. This field is only populated for check transactions.
+    attr_accessor :check_number
+
+    # 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
+
+    # The date on which the transaction took place, in IS0 8601 format.
+    attr_accessor :date_transacted
+
+    attr_accessor :location
+
+    # The merchant name or transaction description.
+    attr_accessor :name
+
+    # The merchant name, as enriched by Plaid from the `name` field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be `null`.
+    attr_accessor :merchant_name
+
+    attr_accessor :payment_meta
+
+    # When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
+    attr_accessor :pending
+
+    # The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
+    attr_accessor :account_owner
+
+    attr_accessor :transaction_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount' => :'amount',
+        :'iso_currency_code' => :'iso_currency_code',
+        :'unofficial_currency_code' => :'unofficial_currency_code',
+        :'original_description' => :'original_description',
+        :'category' => :'category',
+        :'category_id' => :'category_id',
+        :'credit_category' => :'credit_category',
+        :'check_number' => :'check_number',
+        :'date' => :'date',
+        :'date_transacted' => :'date_transacted',
+        :'location' => :'location',
+        :'name' => :'name',
+        :'merchant_name' => :'merchant_name',
+        :'payment_meta' => :'payment_meta',
+        :'pending' => :'pending',
+        :'account_owner' => :'account_owner',
+        :'transaction_type' => :'transaction_type'
+      }
+    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
+      {
+        :'amount' => :'Float',
+        :'iso_currency_code' => :'String',
+        :'unofficial_currency_code' => :'String',
+        :'original_description' => :'String',
+        :'category' => :'Array<String>',
+        :'category_id' => :'String',
+        :'credit_category' => :'CreditCategory',
+        :'check_number' => :'String',
+        :'date' => :'Date',
+        :'date_transacted' => :'String',
+        :'location' => :'Location',
+        :'name' => :'String',
+        :'merchant_name' => :'String',
+        :'payment_meta' => :'PaymentMeta',
+        :'pending' => :'Boolean',
+        :'account_owner' => :'String',
+        :'transaction_type' => :'BaseReportTransactionType'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'iso_currency_code',
+        :'unofficial_currency_code',
+        :'original_description',
+        :'category',
+        :'category_id',
+        :'credit_category',
+        :'check_number',
+        :'date_transacted',
+        :'merchant_name',
+        :'account_owner',
+      ])
+    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::BaseReportTransaction` 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::BaseReportTransaction`. 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?(:'amount')
+        self.amount = attributes[:'amount']
+      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?(:'original_description')
+        self.original_description = attributes[:'original_description']
+      end
+
+      if attributes.key?(:'category')
+        if (value = attributes[:'category']).is_a?(Array)
+          self.category = value
+        end
+      end
+
+      if attributes.key?(:'category_id')
+        self.category_id = attributes[:'category_id']
+      end
+
+      if attributes.key?(:'credit_category')
+        self.credit_category = attributes[:'credit_category']
+      end
+
+      if attributes.key?(:'check_number')
+        self.check_number = attributes[:'check_number']
+      end
+
+      if attributes.key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.key?(:'date_transacted')
+        self.date_transacted = attributes[:'date_transacted']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'merchant_name')
+        self.merchant_name = attributes[:'merchant_name']
+      end
+
+      if attributes.key?(:'payment_meta')
+        self.payment_meta = attributes[:'payment_meta']
+      end
+
+      if attributes.key?(:'pending')
+        self.pending = attributes[:'pending']
+      end
+
+      if attributes.key?(:'account_owner')
+        self.account_owner = attributes[:'account_owner']
+      end
+
+      if attributes.key?(:'transaction_type')
+        self.transaction_type = attributes[:'transaction_type']
+      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 @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @date.nil?
+        invalid_properties.push('invalid value for "date", date cannot be nil.')
+      end
+
+      if @pending.nil?
+        invalid_properties.push('invalid value for "pending", pending 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 @amount.nil?
+      return false if @date.nil?
+      return false if @pending.nil?
+      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 &&
+          amount == o.amount &&
+          iso_currency_code == o.iso_currency_code &&
+          unofficial_currency_code == o.unofficial_currency_code &&
+          original_description == o.original_description &&
+          category == o.category &&
+          category_id == o.category_id &&
+          credit_category == o.credit_category &&
+          check_number == o.check_number &&
+          date == o.date &&
+          date_transacted == o.date_transacted &&
+          location == o.location &&
+          name == o.name &&
+          merchant_name == o.merchant_name &&
+          payment_meta == o.payment_meta &&
+          pending == o.pending &&
+          account_owner == o.account_owner &&
+          transaction_type == o.transaction_type
+    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
+      [amount, iso_currency_code, unofficial_currency_code, original_description, category, category_id, credit_category, check_number, date, date_transacted, location, name, merchant_name, payment_meta, pending, account_owner, transaction_type].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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/base_report_transaction_type.rb

@@ -0,0 +1,41 @@
+=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.410.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class BaseReportTransactionType
+    DIGITAL = "digital".freeze
+    PLACE = "place".freeze
+    SPECIAL = "special".freeze
+    UNRESOLVED = "unresolved".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