apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/transaction_base.rb

@@ -0,0 +1,285 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A representation of a transaction
+  class TransactionBase < 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_type
+        pending_transaction_id
+        category_id
+        category
+        location
+        payment_meta
+        account_owner
+        name
+        original_description
+      ]
+    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
+      ]
+    end
+
+    def initialize(account_id:, amount:, iso_currency_code:,
+                   unofficial_currency_code:, date:, pending:, transaction_id:,
+                   transaction_type: SKIP, pending_transaction_id: SKIP,
+                   category_id: SKIP, category: SKIP, location: SKIP,
+                   payment_meta: SKIP, account_owner: SKIP, name: SKIP,
+                   original_description: 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 unless pending_transaction_id == SKIP
+      @category_id = category_id unless category_id == SKIP
+      @category = category unless category == SKIP
+      @location = location unless location == SKIP
+      @payment_meta = payment_meta unless payment_meta == SKIP
+      @account_owner = account_owner unless account_owner == SKIP
+      @name = name unless name == SKIP
+      @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
+      @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.
+      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
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+      pending_transaction_id =
+        hash.key?('pending_transaction_id') ? hash['pending_transaction_id'] : SKIP
+      category_id = hash.key?('category_id') ? hash['category_id'] : SKIP
+      category = hash.key?('category') ? hash['category'] : SKIP
+      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'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      original_description =
+        hash.key?('original_description') ? hash['original_description'] : SKIP
+
+      # 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.
+      TransactionBase.new(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,
+                          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,
+                          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} 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}, 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}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transaction_code.rb

@@ -0,0 +1,87 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # 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
+  class TransactionCode
+    TRANSACTION_CODE = [
+      # TODO: Write general description for ADJUSTMENT
+      ADJUSTMENT = 'adjustment'.freeze,
+
+      # TODO: Write general description for ATM
+      ATM = 'atm'.freeze,
+
+      # TODO: Write general description for ENUM_BANK_CHARGE
+      ENUM_BANK_CHARGE = 'bank charge'.freeze,
+
+      # TODO: Write general description for ENUM_BILL_PAYMENT
+      ENUM_BILL_PAYMENT = 'bill payment'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze,
+
+      # TODO: Write general description for CASHBACK
+      CASHBACK = 'cashback'.freeze,
+
+      # TODO: Write general description for CHEQUE
+      CHEQUE = 'cheque'.freeze,
+
+      # TODO: Write general description for ENUM_DIRECT_DEBIT
+      ENUM_DIRECT_DEBIT = 'direct debit'.freeze,
+
+      # TODO: Write general description for INTEREST
+      INTEREST = 'interest'.freeze,
+
+      # TODO: Write general description for PURCHASE
+      PURCHASE = 'purchase'.freeze,
+
+      # TODO: Write general description for ENUM_STANDING_ORDER
+      ENUM_STANDING_ORDER = 'standing order'.freeze,
+
+      # TODO: Write general description for TRANSFER
+      TRANSFER = 'transfer'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ADJUSTMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'adjustment' then ADJUSTMENT
+      when 'atm' then ATM
+      when 'enum_bank_charge' then ENUM_BANK_CHARGE
+      when 'enum_bill_payment' then ENUM_BILL_PAYMENT
+      when 'cash' then CASH
+      when 'cashback' then CASHBACK
+      when 'cheque' then CHEQUE
+      when 'enum_direct_debit' then ENUM_DIRECT_DEBIT
+      when 'interest' then INTEREST
+      when 'purchase' then PURCHASE
+      when 'enum_standing_order' then ENUM_STANDING_ORDER
+      when 'transfer' then TRANSFER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/transaction_data.rb

@@ -0,0 +1,112 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Information about the matched direct deposit transaction used to verify a
+  # user's payroll information.
+  class TransactionData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The description of the transaction.
+    # @return [String]
+    attr_accessor :description
+
+    # The amount of the transaction.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The date of the transaction, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").
+    # @return [Date]
+    attr_accessor :date
+
+    # A unique identifier for the end user's account.
+    # @return [String]
+    attr_accessor :account_id
+
+    # A unique identifier for the transaction.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['amount'] = 'amount'
+      @_hash['date'] = 'date'
+      @_hash['account_id'] = 'account_id'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description:, amount:, date:, account_id:, transaction_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @description = description
+      @amount = amount
+      @date = date
+      @account_id = account_id
+      @transaction_id = transaction_id
+      @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.
+      description = hash.key?('description') ? hash['description'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      date = hash.key?('date') ? hash['date'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : nil
+
+      # 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.
+      TransactionData.new(description: description,
+                          amount: amount,
+                          date: date,
+                          account_id: account_id,
+                          transaction_id: transaction_id,
+                          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} description: #{@description}, amount: #{@amount}, date: #{@date},"\
+      " account_id: #{@account_id}, transaction_id: #{@transaction_id}, 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} description: #{@description.inspect}, amount: #{@amount.inspect}, date:"\
+      " #{@date.inspect}, account_id: #{@account_id.inspect}, transaction_id:"\
+      " #{@transaction_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transaction_location.rb

@@ -0,0 +1,143 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A representation of where a transaction took place
+  class TransactionLocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The street address where the transaction occurred.
+    # @return [String]
+    attr_accessor :address
+
+    # The city where the transaction occurred.
+    # @return [String]
+    attr_accessor :city
+
+    # The region or state where the transaction occurred.
+    # @return [String]
+    attr_accessor :region
+
+    # The postal code where the transaction occurred.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The ISO 3166-1 alpha-2 country code where the transaction occurred.
+    # @return [String]
+    attr_accessor :country
+
+    # The latitude where the transaction occurred.
+    # @return [Float]
+    attr_accessor :lat
+
+    # The longitude where the transaction occurred.
+    # @return [Float]
+    attr_accessor :lon
+
+    # The merchant defined store number where the transaction occurred.
+    # @return [String]
+    attr_accessor :store_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['city'] = 'city'
+      @_hash['region'] = 'region'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country'] = 'country'
+      @_hash['lat'] = 'lat'
+      @_hash['lon'] = 'lon'
+      @_hash['store_number'] = 'store_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        address
+        city
+        region
+        postal_code
+        country
+        lat
+        lon
+        store_number
+      ]
+    end
+
+    def initialize(address:, city:, region:, postal_code:, country:, lat:, lon:,
+                   store_number:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @address = address
+      @city = city
+      @region = region
+      @postal_code = postal_code
+      @country = country
+      @lat = lat
+      @lon = lon
+      @store_number = store_number
+      @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.
+      address = hash.key?('address') ? hash['address'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      region = hash.key?('region') ? hash['region'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      lat = hash.key?('lat') ? hash['lat'] : nil
+      lon = hash.key?('lon') ? hash['lon'] : nil
+      store_number = hash.key?('store_number') ? hash['store_number'] : nil
+
+      # 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.
+      TransactionLocation.new(address: address,
+                              city: city,
+                              region: region,
+                              postal_code: postal_code,
+                              country: country,
+                              lat: lat,
+                              lon: lon,
+                              store_number: store_number,
+                              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} address: #{@address}, city: #{@city}, region: #{@region}, postal_code:"\
+      " #{@postal_code}, country: #{@country}, lat: #{@lat}, lon: #{@lon}, store_number:"\
+      " #{@store_number}, 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} address: #{@address.inspect}, city: #{@city.inspect}, region:"\
+      " #{@region.inspect}, postal_code: #{@postal_code.inspect}, country: #{@country.inspect},"\
+      " lat: #{@lat.inspect}, lon: #{@lon.inspect}, store_number: #{@store_number.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end