modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

data/rbi/modern_treasury/models/transactions/line_item_list_params.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module Transactions
+      class LineItemListParams < ModernTreasury::Internal::Type::BaseModel
+        extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::Transactions::LineItemListParams,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :id
+
+        sig { params(id: T::Hash[Symbol, String]).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :after_cursor
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :per_page
+
+        sig { params(per_page: Integer).void }
+        attr_writer :per_page
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :transaction_id
+
+        sig { params(transaction_id: String).void }
+        attr_writer :transaction_id
+
+        sig do
+          returns(
+            T.nilable(
+              ModernTreasury::Transactions::LineItemListParams::Type::OrSymbol
+            )
+          )
+        end
+        attr_accessor :type
+
+        sig do
+          params(
+            id: T::Hash[Symbol, String],
+            after_cursor: T.nilable(String),
+            per_page: Integer,
+            transaction_id: String,
+            type:
+              T.nilable(
+                ModernTreasury::Transactions::LineItemListParams::Type::OrSymbol
+              ),
+            request_options: ModernTreasury::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          after_cursor: nil,
+          per_page: nil,
+          transaction_id: nil,
+          type: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: T::Hash[Symbol, String],
+              after_cursor: T.nilable(String),
+              per_page: Integer,
+              transaction_id: String,
+              type:
+                T.nilable(
+                  ModernTreasury::Transactions::LineItemListParams::Type::OrSymbol
+                ),
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend ModernTreasury::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModernTreasury::Transactions::LineItemListParams::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ORIGINATING =
+            T.let(
+              :originating,
+              ModernTreasury::Transactions::LineItemListParams::Type::TaggedSymbol
+            )
+          RECEIVING =
+            T.let(
+              :receiving,
+              ModernTreasury::Transactions::LineItemListParams::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModernTreasury::Transactions::LineItemListParams::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/transactions/line_item_retrieve_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module Transactions
+      class LineItemRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+        extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::Transactions::LineItemRetrieveParams,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(
+            request_options: ModernTreasury::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(request_options: {})
+        end
+
+        sig do
+          override.returns({ request_options: ModernTreasury::RequestOptions })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/transactions/transaction_line_item.rbi

@@ -0,0 +1,276 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    TransactionLineItem = Transactions::TransactionLineItem
+
+    module Transactions
+      class TransactionLineItem < ModernTreasury::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::Transactions::TransactionLineItem,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # If a matching object exists in Modern Treasury, `amount` will be populated.
+        # Value in specified currency's smallest unit (taken from parent Transaction).
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # The ID for the counterparty for this transaction line item.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :counterparty_id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # 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.
+        sig { returns(String) }
+        attr_accessor :description
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :discarded_at
+
+        # The ID of the reconciled Expected Payment, otherwise `null`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :expected_payment_id
+
+        # This field will be true if this object exists in the live environment, or false
+        # if it exists in the test environment.
+        sig { returns(T::Boolean) }
+        attr_accessor :live_mode
+
+        sig { returns(String) }
+        attr_accessor :object
+
+        # Describes whether this line item should be counted towards the corresponding
+        # transaction’s reconciliation.
+        sig { returns(T::Boolean) }
+        attr_accessor :reconcilable
+
+        # If a matching object exists in Modern Treasury, the ID will be populated here,
+        # otherwise `null`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :transactable_id
+
+        # If a matching object exists in Modern Treasury, the type will be populated here,
+        # otherwise `null`.
+        sig do
+          returns(
+            T.nilable(
+              ModernTreasury::Transactions::TransactionLineItem::TransactableType::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :transactable_type
+
+        # The ID of the parent transaction.
+        sig { returns(String) }
+        attr_accessor :transaction_id
+
+        # Indicates whether the line item is `originating` or `receiving` (see
+        # https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
+        sig do
+          returns(
+            ModernTreasury::Transactions::TransactionLineItem::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        sig do
+          params(
+            id: String,
+            amount: Integer,
+            counterparty_id: T.nilable(String),
+            created_at: Time,
+            description: String,
+            discarded_at: T.nilable(Time),
+            expected_payment_id: T.nilable(String),
+            live_mode: T::Boolean,
+            object: String,
+            reconcilable: T::Boolean,
+            transactable_id: T.nilable(String),
+            transactable_type:
+              T.nilable(
+                ModernTreasury::Transactions::TransactionLineItem::TransactableType::OrSymbol
+              ),
+            transaction_id: String,
+            type:
+              ModernTreasury::Transactions::TransactionLineItem::Type::OrSymbol,
+            updated_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # If a matching object exists in Modern Treasury, `amount` will be populated.
+          # Value in specified currency's smallest unit (taken from parent Transaction).
+          amount:,
+          # The ID for the counterparty for this transaction line item.
+          counterparty_id:,
+          created_at:,
+          # 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.
+          description:,
+          discarded_at:,
+          # The ID of the reconciled Expected Payment, otherwise `null`.
+          expected_payment_id:,
+          # This field will be true if this object exists in the live environment, or false
+          # if it exists in the test environment.
+          live_mode:,
+          object:,
+          # Describes whether this line item should be counted towards the corresponding
+          # transaction’s reconciliation.
+          reconcilable:,
+          # If a matching object exists in Modern Treasury, the ID will be populated here,
+          # otherwise `null`.
+          transactable_id:,
+          # If a matching object exists in Modern Treasury, the type will be populated here,
+          # otherwise `null`.
+          transactable_type:,
+          # The ID of the parent transaction.
+          transaction_id:,
+          # Indicates whether the line item is `originating` or `receiving` (see
+          # https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
+          type:,
+          updated_at:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              amount: Integer,
+              counterparty_id: T.nilable(String),
+              created_at: Time,
+              description: String,
+              discarded_at: T.nilable(Time),
+              expected_payment_id: T.nilable(String),
+              live_mode: T::Boolean,
+              object: String,
+              reconcilable: T::Boolean,
+              transactable_id: T.nilable(String),
+              transactable_type:
+                T.nilable(
+                  ModernTreasury::Transactions::TransactionLineItem::TransactableType::TaggedSymbol
+                ),
+              transaction_id: String,
+              type:
+                ModernTreasury::Transactions::TransactionLineItem::Type::TaggedSymbol,
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # If a matching object exists in Modern Treasury, the type will be populated here,
+        # otherwise `null`.
+        module TransactableType
+          extend ModernTreasury::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModernTreasury::Transactions::TransactionLineItem::TransactableType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INCOMING_PAYMENT_DETAIL =
+            T.let(
+              :incoming_payment_detail,
+              ModernTreasury::Transactions::TransactionLineItem::TransactableType::TaggedSymbol
+            )
+          PAPER_ITEM =
+            T.let(
+              :paper_item,
+              ModernTreasury::Transactions::TransactionLineItem::TransactableType::TaggedSymbol
+            )
+          PAYMENT_ORDER =
+            T.let(
+              :payment_order,
+              ModernTreasury::Transactions::TransactionLineItem::TransactableType::TaggedSymbol
+            )
+          PAYMENT_ORDER_ATTEMPT =
+            T.let(
+              :payment_order_attempt,
+              ModernTreasury::Transactions::TransactionLineItem::TransactableType::TaggedSymbol
+            )
+          RETURN =
+            T.let(
+              :return,
+              ModernTreasury::Transactions::TransactionLineItem::TransactableType::TaggedSymbol
+            )
+          REVERSAL =
+            T.let(
+              :reversal,
+              ModernTreasury::Transactions::TransactionLineItem::TransactableType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModernTreasury::Transactions::TransactionLineItem::TransactableType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Indicates whether the line item is `originating` or `receiving` (see
+        # https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
+        module Type
+          extend ModernTreasury::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModernTreasury::Transactions::TransactionLineItem::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ORIGINATING =
+            T.let(
+              :originating,
+              ModernTreasury::Transactions::TransactionLineItem::Type::TaggedSymbol
+            )
+          RECEIVING =
+            T.let(
+              :receiving,
+              ModernTreasury::Transactions::TransactionLineItem::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModernTreasury::Transactions::TransactionLineItem::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/validation_validate_routing_number_params.rbi

@@ -0,0 +1,199 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class ValidationValidateRoutingNumberParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::ValidationValidateRoutingNumberParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # The routing number that is being validated.
+      sig { returns(String) }
+      attr_accessor :routing_number
+
+      # 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.
+      sig do
+        returns(
+          ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::OrSymbol
+        )
+      end
+      attr_accessor :routing_number_type
+
+      sig do
+        params(
+          routing_number: String,
+          routing_number_type:
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::OrSymbol,
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The routing number that is being validated.
+        routing_number:,
+        # 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.
+        routing_number_type:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            routing_number: String,
+            routing_number_type:
+              ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::OrSymbol,
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # 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.
+      module RoutingNumberType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ABA =
+          T.let(
+            :aba,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        AU_BSB =
+          T.let(
+            :au_bsb,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        BR_CODIGO =
+          T.let(
+            :br_codigo,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        CA_CPA =
+          T.let(
+            :ca_cpa,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        CHIPS =
+          T.let(
+            :chips,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        CNAPS =
+          T.let(
+            :cnaps,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        DK_INTERBANK_CLEARING_CODE =
+          T.let(
+            :dk_interbank_clearing_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        GB_SORT_CODE =
+          T.let(
+            :gb_sort_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        HK_INTERBANK_CLEARING_CODE =
+          T.let(
+            :hk_interbank_clearing_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        HU_INTERBANK_CLEARING_CODE =
+          T.let(
+            :hu_interbank_clearing_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        ID_SKNBI_CODE =
+          T.let(
+            :id_sknbi_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        IN_IFSC =
+          T.let(
+            :in_ifsc,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        JP_ZENGIN_CODE =
+          T.let(
+            :jp_zengin_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        MX_BANK_IDENTIFIER =
+          T.let(
+            :mx_bank_identifier,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        MY_BRANCH_CODE =
+          T.let(
+            :my_branch_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        NZ_NATIONAL_CLEARING_CODE =
+          T.let(
+            :nz_national_clearing_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        PL_NATIONAL_CLEARING_CODE =
+          T.let(
+            :pl_national_clearing_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        SE_BANKGIRO_CLEARING_CODE =
+          T.let(
+            :se_bankgiro_clearing_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        SG_INTERBANK_CLEARING_CODE =
+          T.let(
+            :sg_interbank_clearing_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        SWIFT =
+          T.let(
+            :swift,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+        ZA_NATIONAL_CLEARING_CODE =
+          T.let(
+            :za_national_clearing_code,
+            ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::ValidationValidateRoutingNumberParams::RoutingNumberType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end