modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/models/transactions/transaction_line_item.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    module Transactions
+      class TransactionLineItem < ModernTreasury::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #   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]
+        required :amount, Integer
+
+        # @!attribute counterparty_id
+        #   The ID for the counterparty for this transaction line item.
+        #
+        #   @return [String, nil]
+        required :counterparty_id, String, nil?: true
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute description
+        #   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-information.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute discarded_at
+        #
+        #   @return [Time, nil]
+        required :discarded_at, Time, nil?: true
+
+        # @!attribute expected_payment_id
+        #   The ID of the reconciled Expected Payment, otherwise `null`.
+        #
+        #   @return [String, nil]
+        required :expected_payment_id, String, nil?: true
+
+        # @!attribute 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 [Boolean]
+        required :live_mode, ModernTreasury::BooleanModel
+
+        # @!attribute object
+        #
+        #   @return [String]
+        required :object, String
+
+        # @!attribute reconcilable
+        #   Describes whether this line item should be counted towards the corresponding
+        #     transaction’s reconciliation.
+        #
+        #   @return [Boolean]
+        required :reconcilable, ModernTreasury::BooleanModel
+
+        # @!attribute transactable_id
+        #   If a matching object exists in Modern Treasury, the ID will be populated here,
+        #     otherwise `null`.
+        #
+        #   @return [String, nil]
+        required :transactable_id, String, nil?: true
+
+        # @!attribute transactable_type
+        #   If a matching object exists in Modern Treasury, the type will be populated here,
+        #     otherwise `null`.
+        #
+        #   @return [Symbol, ModernTreasury::Models::Transactions::TransactionLineItem::TransactableType, nil]
+        required :transactable_type,
+                 enum: -> { ModernTreasury::Models::Transactions::TransactionLineItem::TransactableType },
+                 nil?: true
+
+        # @!attribute transaction_id
+        #   The ID of the parent transaction.
+        #
+        #   @return [String]
+        required :transaction_id, String
+
+        # @!attribute type
+        #   Indicates whether the line item is `originating` or `receiving` (see
+        #     https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
+        #
+        #   @return [Symbol, ModernTreasury::Models::Transactions::TransactionLineItem::Type]
+        required :type, enum: -> { ModernTreasury::Models::Transactions::TransactionLineItem::Type }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param amount [Integer]
+        #   # @param counterparty_id [String, nil]
+        #   # @param created_at [Time]
+        #   # @param description [String]
+        #   # @param discarded_at [Time, nil]
+        #   # @param expected_payment_id [String, nil]
+        #   # @param live_mode [Boolean]
+        #   # @param object [String]
+        #   # @param reconcilable [Boolean]
+        #   # @param transactable_id [String, nil]
+        #   # @param transactable_type [Symbol, ModernTreasury::Models::Transactions::TransactionLineItem::TransactableType, nil]
+        #   # @param transaction_id [String]
+        #   # @param type [Symbol, ModernTreasury::Models::Transactions::TransactionLineItem::Type]
+        #   # @param updated_at [Time]
+        #   #
+        #   def initialize(
+        #     id:,
+        #     amount:,
+        #     counterparty_id:,
+        #     created_at:,
+        #     description:,
+        #     discarded_at:,
+        #     expected_payment_id:,
+        #     live_mode:,
+        #     object:,
+        #     reconcilable:,
+        #     transactable_id:,
+        #     transactable_type:,
+        #     transaction_id:,
+        #     type:,
+        #     updated_at:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        # @abstract
+        #
+        # If a matching object exists in Modern Treasury, the type will be populated here,
+        #   otherwise `null`.
+        #
+        # @example
+        # ```ruby
+        # case transactable_type
+        # in :incoming_payment_detail
+        #   # ...
+        # in :paper_item
+        #   # ...
+        # in :payment_order
+        #   # ...
+        # in :payment_order_attempt
+        #   # ...
+        # in :return
+        #   # ...
+        # in ...
+        #   #...
+        # end
+        # ```
+        class TransactableType < ModernTreasury::Enum
+          INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
+          PAPER_ITEM = :paper_item
+          PAYMENT_ORDER = :payment_order
+          PAYMENT_ORDER_ATTEMPT = :payment_order_attempt
+          RETURN = :return
+          REVERSAL = :reversal
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+
+        # @abstract
+        #
+        # Indicates whether the line item is `originating` or `receiving` (see
+        #   https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
+        #
+        # @example
+        # ```ruby
+        # case type
+        # in :originating
+        #   # ...
+        # in :receiving
+        #   # ...
+        # end
+        # ```
+        class Type < ModernTreasury::Enum
+          ORIGINATING = :originating
+          RECEIVING = :receiving
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   #
+          #   def self.values; end
+        end
+      end
+    end
+
+    TransactionLineItem = Transactions::TransactionLineItem
+  end
+end

data/lib/modern_treasury/models/validation_validate_routing_number_params.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ValidationValidateRoutingNumberParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute routing_number
+      #   The routing number that is being validated.
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!attribute routing_number_type
+      #   The type of routing number. See
+      #     https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #     more details. In sandbox mode we currently only support `aba` and `swift` with
+      #     routing numbers '123456789' and 'GRINUST0XXX' respectively.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ValidationValidateRoutingNumberParams::RoutingNumberType]
+      required :routing_number_type,
+               enum: -> { ModernTreasury::Models::ValidationValidateRoutingNumberParams::RoutingNumberType }
+
+      # @!parse
+      #   # @param routing_number [String]
+      #   # @param routing_number_type [Symbol, ModernTreasury::Models::ValidationValidateRoutingNumberParams::RoutingNumberType]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(routing_number:, routing_number_type:, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # The type of routing number. See
+      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #   more details. In sandbox mode we currently only support `aba` and `swift` with
+      #   routing numbers '123456789' and 'GRINUST0XXX' respectively.
+      #
+      # @example
+      # ```ruby
+      # case routing_number_type
+      # in :aba
+      #   # ...
+      # in :au_bsb
+      #   # ...
+      # in :br_codigo
+      #   # ...
+      # in :ca_cpa
+      #   # ...
+      # in :chips
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class RoutingNumberType < ModernTreasury::Enum
+        ABA = :aba
+        AU_BSB = :au_bsb
+        BR_CODIGO = :br_codigo
+        CA_CPA = :ca_cpa
+        CHIPS = :chips
+        CNAPS = :cnaps
+        DK_INTERBANK_CLEARING_CODE = :dk_interbank_clearing_code
+        GB_SORT_CODE = :gb_sort_code
+        HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
+        HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
+        ID_SKNBI_CODE = :id_sknbi_code
+        IN_IFSC = :in_ifsc
+        JP_ZENGIN_CODE = :jp_zengin_code
+        MX_BANK_IDENTIFIER = :mx_bank_identifier
+        MY_BRANCH_CODE = :my_branch_code
+        NZ_NATIONAL_CLEARING_CODE = :nz_national_clearing_code
+        PL_NATIONAL_CLEARING_CODE = :pl_national_clearing_code
+        SE_BANKGIRO_CLEARING_CODE = :se_bankgiro_clearing_code
+        SG_INTERBANK_CLEARING_CODE = :sg_interbank_clearing_code
+        SWIFT = :swift
+        ZA_NATIONAL_CLEARING_CODE = :za_national_clearing_code
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/virtual_account.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class VirtualAccount < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_details
+      #   An array of account detail objects.
+      #
+      #   @return [Array<ModernTreasury::Models::AccountDetail>]
+      required :account_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::AccountDetail] }
+
+      # @!attribute counterparty_id
+      #   The ID of a counterparty that the virtual account belongs to. Optional.
+      #
+      #   @return [String, nil]
+      required :counterparty_id, String, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute credit_ledger_account_id
+      #   The ID of a credit normal ledger account. When money enters the virtual account,
+      #     this ledger account will be credited. Must be accompanied by a
+      #     debit_ledger_account_id if present.
+      #
+      #   @return [String, nil]
+      required :credit_ledger_account_id, String, nil?: true
+
+      # @!attribute debit_ledger_account_id
+      #   The ID of a debit normal ledger account. When money enters the virtual account,
+      #     this ledger account will be debited. Must be accompanied by a
+      #     credit_ledger_account_id if present.
+      #
+      #   @return [String, nil]
+      required :debit_ledger_account_id, String, nil?: true
+
+      # @!attribute description
+      #   An optional free-form description for internal use.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute discarded_at
+      #
+      #   @return [Time, nil]
+      required :discarded_at, Time, nil?: true
+
+      # @!attribute internal_account_id
+      #   The ID of the internal account that the virtual account is in.
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!attribute ledger_account_id
+      #   If the virtual account links to a ledger account in Modern Treasury, the id of
+      #     the ledger account will be populated here.
+      #
+      #   @return [String, nil]
+      required :ledger_account_id, String, nil?: true
+
+      # @!attribute 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 [Boolean]
+      required :live_mode, ModernTreasury::BooleanModel
+
+      # @!attribute metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, ModernTreasury::HashOf[String]
+
+      # @!attribute name
+      #   The name of the virtual account.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute routing_details
+      #   An array of routing detail objects. These will be the routing details of the
+      #     internal account.
+      #
+      #   @return [Array<ModernTreasury::Models::RoutingDetail>]
+      required :routing_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::RoutingDetail] }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param account_details [Array<ModernTreasury::Models::AccountDetail>]
+      #   # @param counterparty_id [String, nil]
+      #   # @param created_at [Time]
+      #   # @param credit_ledger_account_id [String, nil]
+      #   # @param debit_ledger_account_id [String, nil]
+      #   # @param description [String, nil]
+      #   # @param discarded_at [Time, nil]
+      #   # @param internal_account_id [String]
+      #   # @param ledger_account_id [String, nil]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param name [String]
+      #   # @param object [String]
+      #   # @param routing_details [Array<ModernTreasury::Models::RoutingDetail>]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     account_details:,
+      #     counterparty_id:,
+      #     created_at:,
+      #     credit_ledger_account_id:,
+      #     debit_ledger_account_id:,
+      #     description:,
+      #     discarded_at:,
+      #     internal_account_id:,
+      #     ledger_account_id:,
+      #     live_mode:,
+      #     metadata:,
+      #     name:,
+      #     object:,
+      #     routing_details:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end