plaid 15.11.0 → 18.0.0

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.161.5
+The version of the OpenAPI document: 2020-09-14_1.343.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -16,74 +16,86 @@ require 'time'
 module Plaid
   # A representation of a transaction
   class Transaction
-    # 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 ID of the account in which this transaction occurred.
+    attr_accessor :account_id
 
-    # The ID of a posted transaction's associated pending transaction, where applicable.
-    attr_accessor :pending_transaction_id
+    # The settled value of the transaction, denominated in the transactions'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 category to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget).  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
+    # 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 `iso_currency_code`s.
+    attr_accessor :unofficial_currency_code
 
     # 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).  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
 
-    attr_accessor :location
+    # 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).  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
 
-    attr_accessor :payment_meta
+    # The check number of the transaction. This field is only populated for check transactions.
+    attr_accessor :check_number
 
-    # The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
-    attr_accessor :account_owner
+    # 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
+
+    attr_accessor :location
 
     # 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 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
+
     # The string returned by the financial institution to describe the transaction. For transactions returned by `/transactions/get`, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set `options.include_original_description` to `true`.
     attr_accessor :original_description
 
-    # The ID of the account in which this transaction occurred.
-    attr_accessor :account_id
-
-    # The settled value of the transaction, denominated in the transactions'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 `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](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ).
-    attr_accessor :date
+    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 ID of a posted transaction's associated pending transaction, where applicable.
+    attr_accessor :pending_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 unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive.
     attr_accessor :transaction_id
 
-    # The merchant name, as extracted by Plaid from the `name` field.
-    attr_accessor :merchant_name
+    # 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 check number of the transaction. This field is only populated for check transactions.
-    attr_accessor :check_number
+    # The logo associated with the merchant, if available. Formatted as a 100x100 pixels PNG file path.
+    attr_accessor :logo_url
 
-    # 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
+    # The website associated with the merchant, if available.
+    attr_accessor :website
 
-    # The date that the transaction was authorized. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ). The `authorized_date` field uses machine learning to determine a transaction date for transactions where the `date_transacted` is not available. If the `date_transacted` field is present and not `null`, the `authorized_date` field will have the same value as the `date_transacted` field.
+    # 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](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DDTHH:mm:ssZ` ).  This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00).
+    # 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 returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.
     attr_accessor :authorized_datetime
 
-    # 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 returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00).
+    # 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 returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.
     attr_accessor :datetime
 
-    attr_accessor :transaction_code
+    # 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 :personal_finance_category
 
+    attr_accessor :transaction_code
+
+    # A link to the icon associated with the primary personal finance category. The logo will always be 100x100 pixels.
+    attr_accessor :personal_finance_category_icon_url
+
+    # The counterparties present in the transaction. Counterparties, such as the financial institutions, are extracted by Plaid from the raw description.
+    attr_accessor :counterparties
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -109,30 +121,34 @@ module Plaid
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'transaction_type' => :'transaction_type',
-        :'pending_transaction_id' => :'pending_transaction_id',
-        :'category_id' => :'category_id',
-        :'category' => :'category',
-        :'location' => :'location',
-        :'payment_meta' => :'payment_meta',
-        :'account_owner' => :'account_owner',
-        :'name' => :'name',
-        :'original_description' => :'original_description',
         :'account_id' => :'account_id',
         :'amount' => :'amount',
         :'iso_currency_code' => :'iso_currency_code',
         :'unofficial_currency_code' => :'unofficial_currency_code',
+        :'category' => :'category',
+        :'category_id' => :'category_id',
+        :'check_number' => :'check_number',
         :'date' => :'date',
+        :'location' => :'location',
+        :'name' => :'name',
+        :'merchant_name' => :'merchant_name',
+        :'original_description' => :'original_description',
+        :'payment_meta' => :'payment_meta',
         :'pending' => :'pending',
+        :'pending_transaction_id' => :'pending_transaction_id',
+        :'account_owner' => :'account_owner',
         :'transaction_id' => :'transaction_id',
-        :'merchant_name' => :'merchant_name',
-        :'check_number' => :'check_number',
-        :'payment_channel' => :'payment_channel',
+        :'transaction_type' => :'transaction_type',
+        :'logo_url' => :'logo_url',
+        :'website' => :'website',
         :'authorized_date' => :'authorized_date',
         :'authorized_datetime' => :'authorized_datetime',
         :'datetime' => :'datetime',
+        :'payment_channel' => :'payment_channel',
+        :'personal_finance_category' => :'personal_finance_category',
         :'transaction_code' => :'transaction_code',
-        :'personal_finance_category' => :'personal_finance_category'
+        :'personal_finance_category_icon_url' => :'personal_finance_category_icon_url',
+        :'counterparties' => :'counterparties'
       }
     end
 
@@ -144,50 +160,56 @@ module Plaid
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'transaction_type' => :'String',
-        :'pending_transaction_id' => :'String',
-        :'category_id' => :'String',
-        :'category' => :'Array<String>',
-        :'location' => :'Location',
-        :'payment_meta' => :'PaymentMeta',
-        :'account_owner' => :'String',
-        :'name' => :'String',
-        :'original_description' => :'String',
         :'account_id' => :'String',
         :'amount' => :'Float',
         :'iso_currency_code' => :'String',
         :'unofficial_currency_code' => :'String',
+        :'category' => :'Array<String>',
+        :'category_id' => :'String',
+        :'check_number' => :'String',
         :'date' => :'Date',
+        :'location' => :'Location',
+        :'name' => :'String',
+        :'merchant_name' => :'String',
+        :'original_description' => :'String',
+        :'payment_meta' => :'PaymentMeta',
         :'pending' => :'Boolean',
+        :'pending_transaction_id' => :'String',
+        :'account_owner' => :'String',
         :'transaction_id' => :'String',
-        :'merchant_name' => :'String',
-        :'check_number' => :'String',
-        :'payment_channel' => :'String',
+        :'transaction_type' => :'String',
+        :'logo_url' => :'String',
+        :'website' => :'String',
         :'authorized_date' => :'Date',
         :'authorized_datetime' => :'Time',
         :'datetime' => :'Time',
+        :'payment_channel' => :'String',
+        :'personal_finance_category' => :'PersonalFinanceCategory',
         :'transaction_code' => :'TransactionCode',
-        :'personal_finance_category' => :'PersonalFinanceCategory'
+        :'personal_finance_category_icon_url' => :'String',
+        :'counterparties' => :'Array<TransactionCounterparty>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'pending_transaction_id',
-        :'category_id',
-        :'category',
-        :'account_owner',
-        :'original_description',
         :'iso_currency_code',
         :'unofficial_currency_code',
-        :'merchant_name',
+        :'category',
+        :'category_id',
         :'check_number',
+        :'merchant_name',
+        :'original_description',
+        :'pending_transaction_id',
+        :'account_owner',
+        :'logo_url',
+        :'website',
         :'authorized_date',
         :'authorized_datetime',
         :'datetime',
+        :'personal_finance_category',
         :'transaction_code',
-        :'personal_finance_category'
       ])
     end
 
@@ -214,16 +236,20 @@ module Plaid
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'transaction_type')
-        self.transaction_type = attributes[:'transaction_type']
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
       end
 
-      if attributes.key?(:'pending_transaction_id')
-        self.pending_transaction_id = attributes[:'pending_transaction_id']
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
       end
 
-      if attributes.key?(:'category_id')
-        self.category_id = attributes[:'category_id']
+      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?(:'category')
@@ -232,64 +258,64 @@ module Plaid
         end
       end
 
-      if attributes.key?(:'location')
-        self.location = attributes[:'location']
+      if attributes.key?(:'category_id')
+        self.category_id = attributes[:'category_id']
       end
 
-      if attributes.key?(:'payment_meta')
-        self.payment_meta = attributes[:'payment_meta']
+      if attributes.key?(:'check_number')
+        self.check_number = attributes[:'check_number']
       end
 
-      if attributes.key?(:'account_owner')
-        self.account_owner = attributes[:'account_owner']
+      if attributes.key?(:'date')
+        self.date = attributes[:'date']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
       end
 
-      if attributes.key?(:'original_description')
-        self.original_description = attributes[:'original_description']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.key?(:'account_id')
-        self.account_id = attributes[:'account_id']
+      if attributes.key?(:'merchant_name')
+        self.merchant_name = attributes[:'merchant_name']
       end
 
-      if attributes.key?(:'amount')
-        self.amount = attributes[:'amount']
+      if attributes.key?(:'original_description')
+        self.original_description = attributes[:'original_description']
       end
 
-      if attributes.key?(:'iso_currency_code')
-        self.iso_currency_code = attributes[:'iso_currency_code']
+      if attributes.key?(:'payment_meta')
+        self.payment_meta = attributes[:'payment_meta']
       end
 
-      if attributes.key?(:'unofficial_currency_code')
-        self.unofficial_currency_code = attributes[:'unofficial_currency_code']
+      if attributes.key?(:'pending')
+        self.pending = attributes[:'pending']
       end
 
-      if attributes.key?(:'date')
-        self.date = attributes[:'date']
+      if attributes.key?(:'pending_transaction_id')
+        self.pending_transaction_id = attributes[:'pending_transaction_id']
       end
 
-      if attributes.key?(:'pending')
-        self.pending = attributes[:'pending']
+      if attributes.key?(:'account_owner')
+        self.account_owner = attributes[:'account_owner']
       end
 
       if attributes.key?(:'transaction_id')
         self.transaction_id = attributes[:'transaction_id']
       end
 
-      if attributes.key?(:'merchant_name')
-        self.merchant_name = attributes[:'merchant_name']
+      if attributes.key?(:'transaction_type')
+        self.transaction_type = attributes[:'transaction_type']
       end
 
-      if attributes.key?(:'check_number')
-        self.check_number = attributes[:'check_number']
+      if attributes.key?(:'logo_url')
+        self.logo_url = attributes[:'logo_url']
       end
 
-      if attributes.key?(:'payment_channel')
-        self.payment_channel = attributes[:'payment_channel']
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
       end
 
       if attributes.key?(:'authorized_date')
@@ -304,31 +330,33 @@ module Plaid
         self.datetime = attributes[:'datetime']
       end
 
-      if attributes.key?(:'transaction_code')
-        self.transaction_code = attributes[:'transaction_code']
+      if attributes.key?(:'payment_channel')
+        self.payment_channel = attributes[:'payment_channel']
       end
 
       if attributes.key?(:'personal_finance_category')
         self.personal_finance_category = attributes[:'personal_finance_category']
       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 @location.nil?
-        invalid_properties.push('invalid value for "location", location cannot be nil.')
+      if attributes.key?(:'transaction_code')
+        self.transaction_code = attributes[:'transaction_code']
       end
 
-      if @payment_meta.nil?
-        invalid_properties.push('invalid value for "payment_meta", payment_meta cannot be nil.')
+      if attributes.key?(:'personal_finance_category_icon_url')
+        self.personal_finance_category_icon_url = attributes[:'personal_finance_category_icon_url']
       end
 
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      if attributes.key?(:'counterparties')
+        if (value = attributes[:'counterparties']).is_a?(Array)
+          self.counterparties = value
+        end
       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 @account_id.nil?
         invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
       end
@@ -341,6 +369,18 @@ module Plaid
         invalid_properties.push('invalid value for "date", date cannot be nil.')
       end
 
+      if @location.nil?
+        invalid_properties.push('invalid value for "location", location cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @payment_meta.nil?
+        invalid_properties.push('invalid value for "payment_meta", payment_meta cannot be nil.')
+      end
+
       if @pending.nil?
         invalid_properties.push('invalid value for "pending", pending cannot be nil.')
       end
@@ -359,16 +399,16 @@ module Plaid
     # 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 @location.nil?
-      return false if @payment_meta.nil?
-      return false if @name.nil?
       return false if @account_id.nil?
       return false if @amount.nil?
       return false if @date.nil?
+      return false if @location.nil?
+      return false if @name.nil?
+      return false if @payment_meta.nil?
       return false if @pending.nil?
       return false if @transaction_id.nil?
+      transaction_type_validator = EnumAttributeValidator.new('String', ["digital", "place", "special", "unresolved"])
+      return false unless transaction_type_validator.valid?(@transaction_type)
       return false if @payment_channel.nil?
       payment_channel_validator = EnumAttributeValidator.new('String', ["online", "in store", "other"])
       return false unless payment_channel_validator.valid?(@payment_channel)
@@ -400,30 +440,34 @@ module Plaid
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          transaction_type == o.transaction_type &&
-          pending_transaction_id == o.pending_transaction_id &&
-          category_id == o.category_id &&
-          category == o.category &&
-          location == o.location &&
-          payment_meta == o.payment_meta &&
-          account_owner == o.account_owner &&
-          name == o.name &&
-          original_description == o.original_description &&
           account_id == o.account_id &&
           amount == o.amount &&
           iso_currency_code == o.iso_currency_code &&
           unofficial_currency_code == o.unofficial_currency_code &&
+          category == o.category &&
+          category_id == o.category_id &&
+          check_number == o.check_number &&
           date == o.date &&
+          location == o.location &&
+          name == o.name &&
+          merchant_name == o.merchant_name &&
+          original_description == o.original_description &&
+          payment_meta == o.payment_meta &&
           pending == o.pending &&
+          pending_transaction_id == o.pending_transaction_id &&
+          account_owner == o.account_owner &&
           transaction_id == o.transaction_id &&
-          merchant_name == o.merchant_name &&
-          check_number == o.check_number &&
-          payment_channel == o.payment_channel &&
+          transaction_type == o.transaction_type &&
+          logo_url == o.logo_url &&
+          website == o.website &&
           authorized_date == o.authorized_date &&
           authorized_datetime == o.authorized_datetime &&
           datetime == o.datetime &&
+          payment_channel == o.payment_channel &&
+          personal_finance_category == o.personal_finance_category &&
           transaction_code == o.transaction_code &&
-          personal_finance_category == o.personal_finance_category
+          personal_finance_category_icon_url == o.personal_finance_category_icon_url &&
+          counterparties == o.counterparties
     end
 
     # @see the `==` method
@@ -435,7 +479,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, merchant_name, check_number, payment_channel, authorized_date, authorized_datetime, datetime, transaction_code, personal_finance_category].hash
+      [account_id, amount, iso_currency_code, unofficial_currency_code, category, category_id, check_number, date, location, name, merchant_name, original_description, payment_meta, pending, pending_transaction_id, account_owner, transaction_id, transaction_type, logo_url, website, authorized_date, authorized_datetime, datetime, payment_channel, personal_finance_category, transaction_code, personal_finance_category_icon_url, counterparties].hash
     end
 
     # Builds the object from hash