plaid 13.2.0 → 14.0.0.beta.5

data/lib/plaid/models/asset_report_transaction.rb

@@ -0,0 +1,533 @@
+=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.16.6
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  class AssetReportTransaction
+    # Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.  `digital:` transactions that took place online.  `place:` transactions that were made at a physical location.  `special:` transactions that relate to banks, e.g. fees or deposits.  `unresolved:` transactions that do not fit into the other three types. 
+    attr_accessor :transaction_type
+
+    # The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive.
+    attr_accessor :transaction_id
+
+    # The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
+    attr_accessor :account_owner
+
+    # The ID of a posted transaction's associated pending transaction, where applicable.
+    attr_accessor :pending_transaction_id
+
+    # 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 channel used to make a payment. `online:` transactions that took place online.  `in store:` transactions that were made at a physical location.  `other:` transactions that relate to banks, e.g. fees or deposits.  This field replaces the `transaction_type` field. 
+    attr_accessor :payment_channel
+
+    attr_accessor :payment_meta
+
+    # The merchant name or transaction description.  If the `transactions` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
+    attr_accessor :name
+
+    # The merchant name, as extracted by Plaid from the `name` field.
+    attr_accessor :merchant_name
+
+    attr_accessor :location
+
+    # The date that the transaction was authorized. Dates are returned in an 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`.
+    attr_accessor :authorized_datetime
+
+    # 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` ).
+    attr_accessor :date
+
+    # 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`.
+    attr_accessor :datetime
+
+    # The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).  If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
+    attr_accessor :category_id
+
+    # A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).  If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
+    attr_accessor :category
+
+    # 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](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
+    attr_accessor :unofficial_currency_code
+
+    # The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null.
+    attr_accessor :iso_currency_code
+
+    # The settled value of the transaction, denominated in the account'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 ID of the account in which this transaction occurred.
+    attr_accessor :account_id
+
+    attr_accessor :transaction_code
+
+    # The date on which the transaction took place, in IS0 8601 format.
+    attr_accessor :date_transacted
+
+    # The string returned by the financial institution to describe the transaction
+    attr_accessor :original_description
+
+    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
+      {
+        :'transaction_type' => :'transaction_type',
+        :'transaction_id' => :'transaction_id',
+        :'account_owner' => :'account_owner',
+        :'pending_transaction_id' => :'pending_transaction_id',
+        :'pending' => :'pending',
+        :'payment_channel' => :'payment_channel',
+        :'payment_meta' => :'payment_meta',
+        :'name' => :'name',
+        :'merchant_name' => :'merchant_name',
+        :'location' => :'location',
+        :'authorized_date' => :'authorized_date',
+        :'authorized_datetime' => :'authorized_datetime',
+        :'date' => :'date',
+        :'datetime' => :'datetime',
+        :'category_id' => :'category_id',
+        :'category' => :'category',
+        :'unofficial_currency_code' => :'unofficial_currency_code',
+        :'iso_currency_code' => :'iso_currency_code',
+        :'amount' => :'amount',
+        :'account_id' => :'account_id',
+        :'transaction_code' => :'transaction_code',
+        :'date_transacted' => :'date_transacted',
+        :'original_description' => :'original_description'
+      }
+    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
+      {
+        :'transaction_type' => :'String',
+        :'transaction_id' => :'String',
+        :'account_owner' => :'String',
+        :'pending_transaction_id' => :'String',
+        :'pending' => :'Boolean',
+        :'payment_channel' => :'String',
+        :'payment_meta' => :'PaymentMeta',
+        :'name' => :'String',
+        :'merchant_name' => :'String',
+        :'location' => :'Location',
+        :'authorized_date' => :'String',
+        :'authorized_datetime' => :'String',
+        :'date' => :'String',
+        :'datetime' => :'String',
+        :'category_id' => :'String',
+        :'category' => :'Array<String>',
+        :'unofficial_currency_code' => :'String',
+        :'iso_currency_code' => :'String',
+        :'amount' => :'Float',
+        :'account_id' => :'String',
+        :'transaction_code' => :'TransactionCode',
+        :'date_transacted' => :'String',
+        :'original_description' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'account_owner',
+        :'pending_transaction_id',
+        :'merchant_name',
+        :'authorized_date',
+        :'authorized_datetime',
+        :'datetime',
+        :'category',
+        :'unofficial_currency_code',
+        :'iso_currency_code',
+        :'transaction_code',
+        :'date_transacted',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'AssetReportTransactionAllOf',
+      :'Transaction'
+      ]
+    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::AssetReportTransaction` 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::AssetReportTransaction`. 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?(:'transaction_type')
+        self.transaction_type = attributes[:'transaction_type']
+      end
+
+      if attributes.key?(:'transaction_id')
+        self.transaction_id = attributes[:'transaction_id']
+      end
+
+      if attributes.key?(:'account_owner')
+        self.account_owner = attributes[:'account_owner']
+      end
+
+      if attributes.key?(:'pending_transaction_id')
+        self.pending_transaction_id = attributes[:'pending_transaction_id']
+      end
+
+      if attributes.key?(:'pending')
+        self.pending = attributes[:'pending']
+      end
+
+      if attributes.key?(:'payment_channel')
+        self.payment_channel = attributes[:'payment_channel']
+      end
+
+      if attributes.key?(:'payment_meta')
+        self.payment_meta = attributes[:'payment_meta']
+      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?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'authorized_date')
+        self.authorized_date = attributes[:'authorized_date']
+      end
+
+      if attributes.key?(:'authorized_datetime')
+        self.authorized_datetime = attributes[:'authorized_datetime']
+      end
+
+      if attributes.key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.key?(:'datetime')
+        self.datetime = attributes[:'datetime']
+      end
+
+      if attributes.key?(:'category_id')
+        self.category_id = attributes[:'category_id']
+      end
+
+      if attributes.key?(:'category')
+        if (value = attributes[:'category']).is_a?(Array)
+          self.category = value
+        end
+      end
+
+      if attributes.key?(:'unofficial_currency_code')
+        self.unofficial_currency_code = attributes[:'unofficial_currency_code']
+      end
+
+      if attributes.key?(:'iso_currency_code')
+        self.iso_currency_code = attributes[:'iso_currency_code']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'transaction_code')
+        self.transaction_code = attributes[:'transaction_code']
+      end
+
+      if attributes.key?(:'date_transacted')
+        self.date_transacted = attributes[:'date_transacted']
+      end
+
+      if attributes.key?(:'original_description')
+        self.original_description = attributes[:'original_description']
+      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 @transaction_id.nil?
+        invalid_properties.push('invalid value for "transaction_id", transaction_id cannot be nil.')
+      end
+
+      if @pending.nil?
+        invalid_properties.push('invalid value for "pending", pending cannot be nil.')
+      end
+
+      if @date.nil?
+        invalid_properties.push('invalid value for "date", date cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @original_description.nil?
+        invalid_properties.push('invalid value for "original_description", original_description 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?
+      transaction_type_validator = EnumAttributeValidator.new('String', ["digital", "place", "special", "unresolved"])
+      return false unless transaction_type_validator.valid?(@transaction_type)
+      return false if @transaction_id.nil?
+      return false if @pending.nil?
+      payment_channel_validator = EnumAttributeValidator.new('String', ["online", "in store", "other"])
+      return false unless payment_channel_validator.valid?(@payment_channel)
+      return false if @date.nil?
+      return false if @amount.nil?
+      return false if @account_id.nil?
+      return false if @original_description.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] transaction_type Object to be assigned
+    def transaction_type=(transaction_type)
+      validator = EnumAttributeValidator.new('String', ["digital", "place", "special", "unresolved"])
+      unless validator.valid?(transaction_type)
+        fail ArgumentError, "invalid value for \"transaction_type\", must be one of #{validator.allowable_values}."
+      end
+      @transaction_type = transaction_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] payment_channel Object to be assigned
+    def payment_channel=(payment_channel)
+      validator = EnumAttributeValidator.new('String', ["online", "in store", "other"])
+      unless validator.valid?(payment_channel)
+        fail ArgumentError, "invalid value for \"payment_channel\", must be one of #{validator.allowable_values}."
+      end
+      @payment_channel = payment_channel
+    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 &&
+          transaction_type == o.transaction_type &&
+          transaction_id == o.transaction_id &&
+          account_owner == o.account_owner &&
+          pending_transaction_id == o.pending_transaction_id &&
+          pending == o.pending &&
+          payment_channel == o.payment_channel &&
+          payment_meta == o.payment_meta &&
+          name == o.name &&
+          merchant_name == o.merchant_name &&
+          location == o.location &&
+          authorized_date == o.authorized_date &&
+          authorized_datetime == o.authorized_datetime &&
+          date == o.date &&
+          datetime == o.datetime &&
+          category_id == o.category_id &&
+          category == o.category &&
+          unofficial_currency_code == o.unofficial_currency_code &&
+          iso_currency_code == o.iso_currency_code &&
+          amount == o.amount &&
+          account_id == o.account_id &&
+          transaction_code == o.transaction_code &&
+          date_transacted == o.date_transacted &&
+          original_description == o.original_description
+    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
+      [transaction_type, transaction_id, account_owner, pending_transaction_id, pending, payment_channel, payment_meta, name, merchant_name, location, authorized_date, authorized_datetime, date, datetime, category_id, category, unofficial_currency_code, iso_currency_code, amount, account_id, transaction_code, date_transacted, original_description].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