mt-sdk 0.0.1

data/lib/modern_treasury/models/transactable_type_enum.rb

@@ -0,0 +1,53 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # If a matching object exists in Modern Treasury, the type will be populated
+  # here, otherwise `null`.
+  class TransactableTypeEnum
+    TRANSACTABLE_TYPE_ENUM = [
+      # TODO: Write general description for INCOMING_PAYMENT_DETAIL
+      INCOMING_PAYMENT_DETAIL = 'incoming_payment_detail'.freeze,
+
+      # TODO: Write general description for PAPER_ITEM
+      PAPER_ITEM = 'paper_item'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER
+      PAYMENT_ORDER = 'payment_order'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER_ATTEMPT
+      PAYMENT_ORDER_ATTEMPT = 'payment_order_attempt'.freeze,
+
+      # TODO: Write general description for ENUM_RETURN
+      ENUM_RETURN = 'return'.freeze,
+
+      # TODO: Write general description for REVERSAL
+      REVERSAL = 'reversal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSACTABLE_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = INCOMING_PAYMENT_DETAIL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'incoming_payment_detail' then INCOMING_PAYMENT_DETAIL
+      when 'paper_item' then PAPER_ITEM
+      when 'payment_order' then PAYMENT_ORDER
+      when 'payment_order_attempt' then PAYMENT_ORDER_ATTEMPT
+      when 'enum_return' then ENUM_RETURN
+      when 'reversal' then REVERSAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/transaction.rb

@@ -0,0 +1,311 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # Transaction Model.
+  class Transaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :live_mode
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :discarded_at
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Three-letter ISO currency code.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # Either `credit` or `debit`.
+    # @return [String]
+    attr_accessor :direction
+
+    # The transaction detail text that often appears in on your bank statement
+    # and in your banking portal.
+    # @return [String]
+    attr_accessor :vendor_description
+
+    # When applicable, the bank-given code that determines the transaction's
+    # category. For most banks this is the BAI2/BTRS transaction code.
+    # @return [String]
+    attr_accessor :vendor_code
+
+    # The type of `vendor_code` being reported. Can be one of `bai2`,
+    # `bankprov`, `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`,
+    # `dc_bank`, `dwolla`, `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`,
+    # `signet`, `silvergate`, `swift`, or `us_bank`.
+    # @return [VendorCodeType1Enum]
+    attr_accessor :vendor_code_type
+
+    # An identifier given to this transaction by the bank.
+    # @return [String]
+    attr_accessor :vendor_id
+
+    # The date on which the transaction occurred.
+    # @return [Date]
+    attr_accessor :as_of_date
+
+    # The time on which the transaction occurred. Depending on the granularity
+    # of the timestamp information received from the bank, it may be `null`.
+    # @return [DateTime]
+    attr_accessor :as_of_time
+
+    # The ID of the relevant Internal Account.
+    # @return [UUID | String]
+    attr_accessor :internal_account_id
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # This field will be `true` if the transaction has posted to the account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :posted
+
+    # An identifier given to this transaction by the bank, often `null`.
+    # @return [String]
+    attr_accessor :vendor_customer_id
+
+    # This field will be `true` if a transaction is reconciled by the Modern
+    # Treasury system. This means that it has transaction line items that sum up
+    # to the transaction's amount.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reconciled
+
+    # This field contains additional information that the bank provided about
+    # the transaction. This is structured data. Some of the data in here might
+    # overlap with what is in the `vendor_description`. For example, the OBI
+    # could be a part of the vendor description, and it would also be included
+    # in here. The attributes that are passed through the details field will
+    # vary based on your banking partner. Currently, the following keys may be
+    # in the details object: `originator_name`,
+    # `originator_to_beneficiary_information`.
+    # @return [Hash[String, String]]
+    attr_accessor :details
+
+    # The type of the transaction. Can be one of `ach`, `wire`, `check`, `rtp`,
+    # `book`, or `sen`.
+    # @return [Type11Enum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['object'] = 'object'
+      @_hash['live_mode'] = 'live_mode'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['discarded_at'] = 'discarded_at'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['direction'] = 'direction'
+      @_hash['vendor_description'] = 'vendor_description'
+      @_hash['vendor_code'] = 'vendor_code'
+      @_hash['vendor_code_type'] = 'vendor_code_type'
+      @_hash['vendor_id'] = 'vendor_id'
+      @_hash['as_of_date'] = 'as_of_date'
+      @_hash['as_of_time'] = 'as_of_time'
+      @_hash['internal_account_id'] = 'internal_account_id'
+      @_hash['metadata'] = 'metadata'
+      @_hash['posted'] = 'posted'
+      @_hash['vendor_customer_id'] = 'vendor_customer_id'
+      @_hash['reconciled'] = 'reconciled'
+      @_hash['details'] = 'details'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        discarded_at
+        vendor_description
+        vendor_code
+        vendor_code_type
+        vendor_id
+        as_of_date
+        as_of_time
+        vendor_customer_id
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, discarded_at = nil, amount = nil,
+                   currency = nil, direction = nil, vendor_description = nil,
+                   vendor_code = nil, vendor_code_type = nil, vendor_id = nil,
+                   as_of_date = nil, as_of_time = nil,
+                   internal_account_id = nil, metadata = nil, posted = nil,
+                   vendor_customer_id = nil, reconciled = nil, details = nil,
+                   type = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @discarded_at = discarded_at
+      @amount = amount
+      @currency = currency
+      @direction = direction
+      @vendor_description = vendor_description
+      @vendor_code = vendor_code
+      @vendor_code_type = vendor_code_type
+      @vendor_id = vendor_id
+      @as_of_date = as_of_date
+      @as_of_time = as_of_time
+      @internal_account_id = internal_account_id
+      @metadata = metadata
+      @posted = posted
+      @vendor_customer_id = vendor_customer_id
+      @reconciled = reconciled
+      @details = details
+      @type = type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      object = hash.key?('object') ? hash['object'] : nil
+      live_mode = hash.key?('live_mode') ? hash['live_mode'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      discarded_at = if hash.key?('discarded_at')
+                       (DateTimeHelper.from_rfc3339(hash['discarded_at']) if hash['discarded_at'])
+                     end
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+      vendor_description =
+        hash.key?('vendor_description') ? hash['vendor_description'] : nil
+      vendor_code = hash.key?('vendor_code') ? hash['vendor_code'] : nil
+      vendor_code_type =
+        hash.key?('vendor_code_type') ? hash['vendor_code_type'] : nil
+      vendor_id = hash.key?('vendor_id') ? hash['vendor_id'] : nil
+      as_of_date = hash.key?('as_of_date') ? hash['as_of_date'] : nil
+      as_of_time = if hash.key?('as_of_time')
+                     (DateTimeHelper.from_rfc3339(hash['as_of_time']) if hash['as_of_time'])
+                   end
+      internal_account_id =
+        hash.key?('internal_account_id') ? hash['internal_account_id'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      posted = hash.key?('posted') ? hash['posted'] : nil
+      vendor_customer_id =
+        hash.key?('vendor_customer_id') ? hash['vendor_customer_id'] : nil
+      reconciled = hash.key?('reconciled') ? hash['reconciled'] : nil
+      details = hash.key?('details') ? hash['details'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+
+      # Create object from extracted values.
+      Transaction.new(id,
+                      object,
+                      live_mode,
+                      created_at,
+                      updated_at,
+                      discarded_at,
+                      amount,
+                      currency,
+                      direction,
+                      vendor_description,
+                      vendor_code,
+                      vendor_code_type,
+                      vendor_id,
+                      as_of_date,
+                      as_of_time,
+                      internal_account_id,
+                      metadata,
+                      posted,
+                      vendor_customer_id,
+                      reconciled,
+                      details,
+                      type)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    def to_custom_discarded_at
+      DateTimeHelper.to_rfc3339(discarded_at)
+    end
+
+    def to_custom_as_of_time
+      DateTimeHelper.to_rfc3339(as_of_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, object: #{@object}, live_mode: #{@live_mode}, created_at:"\
+      " #{@created_at}, updated_at: #{@updated_at}, discarded_at: #{@discarded_at}, amount:"\
+      " #{@amount}, currency: #{@currency}, direction: #{@direction}, vendor_description:"\
+      " #{@vendor_description}, vendor_code: #{@vendor_code}, vendor_code_type:"\
+      " #{@vendor_code_type}, vendor_id: #{@vendor_id}, as_of_date: #{@as_of_date}, as_of_time:"\
+      " #{@as_of_time}, internal_account_id: #{@internal_account_id}, metadata: #{@metadata},"\
+      " posted: #{@posted}, vendor_customer_id: #{@vendor_customer_id}, reconciled:"\
+      " #{@reconciled}, details: #{@details}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, object: #{@object.inspect}, live_mode:"\
+      " #{@live_mode.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, discarded_at: #{@discarded_at.inspect}, amount:"\
+      " #{@amount.inspect}, currency: #{@currency.inspect}, direction: #{@direction.inspect},"\
+      " vendor_description: #{@vendor_description.inspect}, vendor_code: #{@vendor_code.inspect},"\
+      " vendor_code_type: #{@vendor_code_type.inspect}, vendor_id: #{@vendor_id.inspect},"\
+      " as_of_date: #{@as_of_date.inspect}, as_of_time: #{@as_of_time.inspect},"\
+      " internal_account_id: #{@internal_account_id.inspect}, metadata: #{@metadata.inspect},"\
+      " posted: #{@posted.inspect}, vendor_customer_id: #{@vendor_customer_id.inspect},"\
+      " reconciled: #{@reconciled.inspect}, details: #{@details.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/transaction_line_item.rb

@@ -0,0 +1,211 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # TransactionLineItem Model.
+  class TransactionLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object
+
+    # This field will be true if this object exists in the live environment, or
+    # false if it exists in the test environment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :live_mode
+
+    # This field will be true if this object exists in the live environment, or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # This field will be true if this object exists in the live environment, or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # This field will be true if this object exists in the live environment, or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :discarded_at
+
+    # Indicates whether the line item is `originating` or `receiving` (see
+    # https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
+    # @return [Type12Enum]
+    attr_accessor :type
+
+    # If a matching object exists in Modern Treasury, the type will be populated
+    # here, otherwise `null`.
+    # @return [TransactableTypeEnum]
+    attr_accessor :transactable_type
+
+    # If a matching object exists in Modern Treasury, the ID will be populated
+    # here, otherwise `null`.
+    # @return [String]
+    attr_accessor :transactable_id
+
+    # If a matching object exists in Modern Treasury, `amount` will be
+    # populated. Value in specified currency's smallest unit (taken from parent
+    # Transaction).
+    # @return [Integer]
+    attr_accessor :amount
+
+    # If no matching object is found, `description` will be a free-form text
+    # field describing the line item. This field may contain personally
+    # identifiable information (PII) and is not included in API responses by
+    # default. Learn more about changing your settings at
+    # https://docs.moderntreasury.com/reference/personally-identifiable-informat
+    # ion.
+    # @return [String]
+    attr_accessor :description
+
+    # The ID for the counterparty for this transaction line item.
+    # @return [String]
+    attr_accessor :counterparty_id
+
+    # The ID of the reconciled Expected Payment, otherwise `null`.
+    # @return [String]
+    attr_accessor :expected_payment_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['object'] = 'object'
+      @_hash['live_mode'] = 'live_mode'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['discarded_at'] = 'discarded_at'
+      @_hash['type'] = 'type'
+      @_hash['transactable_type'] = 'transactable_type'
+      @_hash['transactable_id'] = 'transactable_id'
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash['counterparty_id'] = 'counterparty_id'
+      @_hash['expected_payment_id'] = 'expected_payment_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        discarded_at
+        transactable_type
+        transactable_id
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, discarded_at = nil, type = nil,
+                   transactable_type = nil, transactable_id = nil, amount = nil,
+                   description = nil, counterparty_id = nil,
+                   expected_payment_id = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @discarded_at = discarded_at
+      @type = type
+      @transactable_type = transactable_type
+      @transactable_id = transactable_id
+      @amount = amount
+      @description = description
+      @counterparty_id = counterparty_id
+      @expected_payment_id = expected_payment_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      object = hash.key?('object') ? hash['object'] : nil
+      live_mode = hash.key?('live_mode') ? hash['live_mode'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      discarded_at = if hash.key?('discarded_at')
+                       (DateTimeHelper.from_rfc3339(hash['discarded_at']) if hash['discarded_at'])
+                     end
+      type = hash.key?('type') ? hash['type'] : nil
+      transactable_type =
+        hash.key?('transactable_type') ? hash['transactable_type'] : nil
+      transactable_id =
+        hash.key?('transactable_id') ? hash['transactable_id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      counterparty_id =
+        hash.key?('counterparty_id') ? hash['counterparty_id'] : nil
+      expected_payment_id =
+        hash.key?('expected_payment_id') ? hash['expected_payment_id'] : nil
+
+      # Create object from extracted values.
+      TransactionLineItem.new(id,
+                              object,
+                              live_mode,
+                              created_at,
+                              updated_at,
+                              discarded_at,
+                              type,
+                              transactable_type,
+                              transactable_id,
+                              amount,
+                              description,
+                              counterparty_id,
+                              expected_payment_id)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    def to_custom_discarded_at
+      DateTimeHelper.to_rfc3339(discarded_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, object: #{@object}, live_mode: #{@live_mode}, created_at:"\
+      " #{@created_at}, updated_at: #{@updated_at}, discarded_at: #{@discarded_at}, type:"\
+      " #{@type}, transactable_type: #{@transactable_type}, transactable_id: #{@transactable_id},"\
+      " amount: #{@amount}, description: #{@description}, counterparty_id: #{@counterparty_id},"\
+      " expected_payment_id: #{@expected_payment_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, object: #{@object.inspect}, live_mode:"\
+      " #{@live_mode.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, discarded_at: #{@discarded_at.inspect}, type: #{@type.inspect},"\
+      " transactable_type: #{@transactable_type.inspect}, transactable_id:"\
+      " #{@transactable_id.inspect}, amount: #{@amount.inspect}, description:"\
+      " #{@description.inspect}, counterparty_id: #{@counterparty_id.inspect},"\
+      " expected_payment_id: #{@expected_payment_id.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/type10_enum.rb

@@ -0,0 +1,64 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # One of `ach`, `wire`, `check`.
+  class Type10Enum
+    TYPE10_ENUM = [
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for BOOK
+      BOOK = 'book'.freeze,
+
+      # TODO: Write general description for CHECK
+      CHECK = 'check'.freeze,
+
+      # TODO: Write general description for EFT
+      EFT = 'eft'.freeze,
+
+      # TODO: Write general description for INTERAC
+      INTERAC = 'interac'.freeze,
+
+      # TODO: Write general description for RTP
+      RTP = 'rtp'.freeze,
+
+      # TODO: Write general description for SEPA
+      SEPA = 'sepa'.freeze,
+
+      # TODO: Write general description for SIGNET
+      SIGNET = 'signet'.freeze,
+
+      # TODO: Write general description for WIRE
+      WIRE = 'wire'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE10_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ach' then ACH
+      when 'book' then BOOK
+      when 'check' then CHECK
+      when 'eft' then EFT
+      when 'interac' then INTERAC
+      when 'rtp' then RTP
+      when 'sepa' then SEPA
+      when 'signet' then SIGNET
+      when 'wire' then WIRE
+      else
+        default_value
+      end
+    end
+  end
+end