apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/total.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing both the current pay period and year to date amount
+  # for a category.
+  class Total < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Commonly used term to describe the line item.
+    # @return [CanonicalDescription]
+    attr_accessor :canonical_description
+
+    # Text of the line item as printed on the paystub.
+    # @return [String]
+    attr_accessor :description
+
+    # An object representing a monetary amount.
+    # @return [Pay]
+    attr_accessor :current_pay
+
+    # An object representing a monetary amount.
+    # @return [Pay]
+    attr_accessor :ytd_pay
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['canonical_description'] = 'canonical_description'
+      @_hash['description'] = 'description'
+      @_hash['current_pay'] = 'current_pay'
+      @_hash['ytd_pay'] = 'ytd_pay'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        canonical_description
+        description
+        current_pay
+        ytd_pay
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(canonical_description: SKIP, description: SKIP,
+                   current_pay: SKIP, ytd_pay: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @canonical_description = canonical_description unless canonical_description == SKIP
+      @description = description unless description == SKIP
+      @current_pay = current_pay unless current_pay == SKIP
+      @ytd_pay = ytd_pay unless ytd_pay == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      canonical_description =
+        hash.key?('canonical_description') ? hash['canonical_description'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      current_pay = Pay.from_hash(hash['current_pay']) if hash['current_pay']
+      ytd_pay = Pay.from_hash(hash['ytd_pay']) if hash['ytd_pay']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Total.new(canonical_description: canonical_description,
+                description: description,
+                current_pay: current_pay,
+                ytd_pay: ytd_pay,
+                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} canonical_description: #{@canonical_description}, description:"\
+      " #{@description}, current_pay: #{@current_pay}, ytd_pay: #{@ytd_pay},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} canonical_description: #{@canonical_description.inspect}, description:"\
+      " #{@description.inspect}, current_pay: #{@current_pay.inspect}, ytd_pay:"\
+      " #{@ytd_pay.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transaction.rb

@@ -0,0 +1,426 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # A representation of a transaction
+  class Transaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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.
+    # @return [TransactionType]
+    attr_accessor :transaction_type
+
+    # The ID of a posted transaction's associated pending transaction, where
+    # applicable.
+    # @return [String]
+    attr_accessor :pending_transaction_id
+
+    # 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.
+    # @return [String]
+    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.
+    # @return [Array[String]]
+    attr_accessor :category
+
+    # A representation of where a transaction took place
+    # @return [TransactionLocation]
+    attr_accessor :location
+
+    # Transaction information specific to inter-bank transfers. If the
+    # transaction was not an inter-bank transfer, all fields will be `null`.
+    # If the `transactions` object was returned by a Transactions endpoint such
+    # as `/transactions/get`, the `payment_meta` key will always appear, but no
+    # data elements are guaranteed. 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.
+    # @return [PaymentMeta]
+    attr_accessor :payment_meta
+
+    # The name of the account owner. This field is not typically populated and
+    # only relevant when dealing with sub-accounts.
+    # @return [String]
+    attr_accessor :account_owner
+
+    # 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.
+    # @return [String]
+    attr_accessor :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`.
+    # @return [String]
+    attr_accessor :original_description
+
+    # The ID of the account in which this transaction occurred.
+    # @return [String]
+    attr_accessor :account_id
+
+    # 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.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The ISO-4217 currency code of the transaction. Always `null` if
+    # `unofficial_currency_code` is non-null.
+    # @return [String]
+    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.
+    # @return [String]
+    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` ).
+    # @return [Date]
+    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.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :pending
+
+    # The unique ID of the transaction. Like all Plaid identifiers, the
+    # `transaction_id` is case sensitive.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # 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.
+    # @return [PaymentChannel]
+    attr_accessor :payment_channel
+
+    # The merchant name, as extracted by Plaid from the `name` field.
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # The date that the transaction was authorized. Dates are returned in an
+    # [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ).
+    # @return [Date]
+    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 only populated for UK institutions. For institutions in
+    # other countries, will be `null`.
+    # @return [DateTime]
+    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 only populated for UK institutions. For institutions in
+    # other countries, will be `null`.
+    # @return [DateTime]
+    attr_accessor :datetime
+
+    # The check number of the transaction. This field is only populated for
+    # check transactions.
+    # @return [String]
+    attr_accessor :check_number
+
+    # An identifier classifying the transaction type.
+    # This field is only populated for European institutions. For institutions
+    # in the US and Canada, this field is set to `null`.
+    # `adjustment:` Bank adjustment
+    # `atm:` Cash deposit or withdrawal via an automated teller machine
+    # `bank charge:` Charge or fee levied by the institution
+    # `bill payment`: Payment of a bill
+    # `cash:` Cash deposit or withdrawal
+    # `cashback:` Cash withdrawal while making a debit card purchase
+    # `cheque:` Document ordering the payment of money to another person or
+    # organization
+    # `direct debit:` Automatic withdrawal of funds initiated by a third party
+    # at a regular interval
+    # `interest:` Interest earned or incurred
+    # `purchase:` Purchase made with a debit or credit card
+    # `standing order:` Payment instructed by the account holder to a third
+    # party at a regular interval
+    # `transfer:` Transfer of money between accounts
+    # @return [TransactionCode]
+    attr_accessor :transaction_code
+
+    # An identifier classifying the transaction type.
+    # This field is only populated for European institutions. For institutions
+    # in the US and Canada, this field is set to `null`.
+    # `adjustment:` Bank adjustment
+    # `atm:` Cash deposit or withdrawal via an automated teller machine
+    # `bank charge:` Charge or fee levied by the institution
+    # `bill payment`: Payment of a bill
+    # `cash:` Cash deposit or withdrawal
+    # `cashback:` Cash withdrawal while making a debit card purchase
+    # `cheque:` Document ordering the payment of money to another person or
+    # organization
+    # `direct debit:` Automatic withdrawal of funds initiated by a third party
+    # at a regular interval
+    # `interest:` Interest earned or incurred
+    # `purchase:` Purchase made with a debit or credit card
+    # `standing order:` Payment instructed by the account holder to a third
+    # party at a regular interval
+    # `transfer:` Transfer of money between accounts
+    # @return [PersonalFinanceCategory2]
+    attr_accessor :personal_finance_category
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['pending_transaction_id'] = 'pending_transaction_id'
+      @_hash['category_id'] = 'category_id'
+      @_hash['category'] = 'category'
+      @_hash['location'] = 'location'
+      @_hash['payment_meta'] = 'payment_meta'
+      @_hash['account_owner'] = 'account_owner'
+      @_hash['name'] = 'name'
+      @_hash['original_description'] = 'original_description'
+      @_hash['account_id'] = 'account_id'
+      @_hash['amount'] = 'amount'
+      @_hash['iso_currency_code'] = 'iso_currency_code'
+      @_hash['unofficial_currency_code'] = 'unofficial_currency_code'
+      @_hash['date'] = 'date'
+      @_hash['pending'] = 'pending'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['payment_channel'] = 'payment_channel'
+      @_hash['merchant_name'] = 'merchant_name'
+      @_hash['authorized_date'] = 'authorized_date'
+      @_hash['authorized_datetime'] = 'authorized_datetime'
+      @_hash['datetime'] = 'datetime'
+      @_hash['check_number'] = 'check_number'
+      @_hash['transaction_code'] = 'transaction_code'
+      @_hash['personal_finance_category'] = 'personal_finance_category'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_type
+        original_description
+        personal_finance_category
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        pending_transaction_id
+        category_id
+        category
+        account_owner
+        original_description
+        iso_currency_code
+        unofficial_currency_code
+        merchant_name
+        authorized_date
+        authorized_datetime
+        datetime
+        check_number
+      ]
+    end
+
+    def initialize(pending_transaction_id:, category_id:, category:, location:,
+                   payment_meta:, account_owner:, name:, 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:, transaction_type: SKIP,
+                   original_description: SKIP, personal_finance_category: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @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 unless original_description == SKIP
+      @account_id = account_id
+      @amount = amount
+      @iso_currency_code = iso_currency_code
+      @unofficial_currency_code = unofficial_currency_code
+      @date = date
+      @pending = pending
+      @transaction_id = transaction_id
+      @payment_channel = payment_channel
+      @merchant_name = merchant_name
+      @authorized_date = authorized_date
+      @authorized_datetime = authorized_datetime
+      @datetime = datetime
+      @check_number = check_number
+      @transaction_code = transaction_code
+      unless personal_finance_category == SKIP
+        @personal_finance_category =
+          personal_finance_category
+      end
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      pending_transaction_id =
+        hash.key?('pending_transaction_id') ? hash['pending_transaction_id'] : nil
+      category_id = hash.key?('category_id') ? hash['category_id'] : nil
+      category = hash.key?('category') ? hash['category'] : nil
+      location = TransactionLocation.from_hash(hash['location']) if hash['location']
+      payment_meta = PaymentMeta.from_hash(hash['payment_meta']) if hash['payment_meta']
+      account_owner = hash.key?('account_owner') ? hash['account_owner'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      iso_currency_code =
+        hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
+      unofficial_currency_code =
+        hash.key?('unofficial_currency_code') ? hash['unofficial_currency_code'] : nil
+      date = hash.key?('date') ? hash['date'] : nil
+      pending = hash.key?('pending') ? hash['pending'] : nil
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : nil
+      payment_channel =
+        hash.key?('payment_channel') ? hash['payment_channel'] : nil
+      merchant_name = hash.key?('merchant_name') ? hash['merchant_name'] : nil
+      authorized_date =
+        hash.key?('authorized_date') ? hash['authorized_date'] : nil
+      authorized_datetime = if hash.key?('authorized_datetime')
+                              (DateTimeHelper.from_rfc3339(hash['authorized_datetime']) if hash['authorized_datetime'])
+                            end
+      datetime = if hash.key?('datetime')
+                   (DateTimeHelper.from_rfc3339(hash['datetime']) if hash['datetime'])
+                 end
+      check_number = hash.key?('check_number') ? hash['check_number'] : nil
+      transaction_code =
+        hash.key?('transaction_code') ? hash['transaction_code'] : nil
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+      original_description =
+        hash.key?('original_description') ? hash['original_description'] : SKIP
+      if hash['personal_finance_category']
+        personal_finance_category = PersonalFinanceCategory2.from_hash(hash['personal_finance_category'])
+      end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Transaction.new(pending_transaction_id: pending_transaction_id,
+                      category_id: category_id,
+                      category: category,
+                      location: location,
+                      payment_meta: payment_meta,
+                      account_owner: account_owner,
+                      name: name,
+                      account_id: account_id,
+                      amount: amount,
+                      iso_currency_code: iso_currency_code,
+                      unofficial_currency_code: unofficial_currency_code,
+                      date: date,
+                      pending: pending,
+                      transaction_id: transaction_id,
+                      payment_channel: payment_channel,
+                      merchant_name: merchant_name,
+                      authorized_date: authorized_date,
+                      authorized_datetime: authorized_datetime,
+                      datetime: datetime,
+                      check_number: check_number,
+                      transaction_code: transaction_code,
+                      transaction_type: transaction_type,
+                      original_description: original_description,
+                      personal_finance_category: personal_finance_category,
+                      additional_properties: additional_properties)
+    end
+
+    def to_custom_authorized_datetime
+      DateTimeHelper.to_rfc3339(authorized_datetime)
+    end
+
+    def to_custom_datetime
+      DateTimeHelper.to_rfc3339(datetime)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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}, date: #{@date}, pending:"\
+      " #{@pending}, transaction_id: #{@transaction_id}, payment_channel: #{@payment_channel},"\
+      " merchant_name: #{@merchant_name}, authorized_date: #{@authorized_date},"\
+      " authorized_datetime: #{@authorized_datetime}, datetime: #{@datetime}, check_number:"\
+      " #{@check_number}, transaction_code: #{@transaction_code}, personal_finance_category:"\
+      " #{@personal_finance_category}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_type: #{@transaction_type.inspect}, pending_transaction_id:"\
+      " #{@pending_transaction_id.inspect}, category_id: #{@category_id.inspect}, category:"\
+      " #{@category.inspect}, location: #{@location.inspect}, payment_meta:"\
+      " #{@payment_meta.inspect}, account_owner: #{@account_owner.inspect}, name:"\
+      " #{@name.inspect}, original_description: #{@original_description.inspect}, account_id:"\
+      " #{@account_id.inspect}, amount: #{@amount.inspect}, iso_currency_code:"\
+      " #{@iso_currency_code.inspect}, unofficial_currency_code:"\
+      " #{@unofficial_currency_code.inspect}, date: #{@date.inspect}, pending:"\
+      " #{@pending.inspect}, transaction_id: #{@transaction_id.inspect}, payment_channel:"\
+      " #{@payment_channel.inspect}, merchant_name: #{@merchant_name.inspect}, authorized_date:"\
+      " #{@authorized_date.inspect}, authorized_datetime: #{@authorized_datetime.inspect},"\
+      " datetime: #{@datetime.inspect}, check_number: #{@check_number.inspect}, transaction_code:"\
+      " #{@transaction_code.inspect}, personal_finance_category:"\
+      " #{@personal_finance_category.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end