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

data/rbi/modern_treasury/models/transaction_create_params.rbi

@@ -0,0 +1,326 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class TransactionCreateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::TransactionCreateParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # Value in specified currency's smallest unit. e.g. $10 would be represented
+      # as 1000.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # The date on which the transaction occurred.
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :as_of_date
+
+      # Either `credit` or `debit`.
+      sig { returns(String) }
+      attr_accessor :direction
+
+      # The ID of the relevant Internal Account.
+      sig { returns(String) }
+      attr_accessor :internal_account_id
+
+      # When applicable, the bank-given code that determines the transaction's category.
+      # For most banks this is the BAI2/BTRS transaction code.
+      sig { returns(T.nilable(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`, `us_bank`, or others.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :vendor_code_type
+
+      # Additional data represented as key-value pairs. Both the key and value must be
+      # strings.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      # This field will be `true` if the transaction has posted to the account.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :posted
+
+      sig { params(posted: T::Boolean).void }
+      attr_writer :posted
+
+      # The type of the transaction. Examples could be
+      # `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+      sig do
+        returns(
+          T.nilable(ModernTreasury::TransactionCreateParams::Type::OrSymbol)
+        )
+      end
+      attr_accessor :type
+
+      # The transaction detail text that often appears in on your bank statement and in
+      # your banking portal.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :vendor_description
+
+      sig do
+        params(
+          amount: Integer,
+          as_of_date: T.nilable(Date),
+          direction: String,
+          internal_account_id: String,
+          vendor_code: T.nilable(String),
+          vendor_code_type: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          posted: T::Boolean,
+          type:
+            T.nilable(ModernTreasury::TransactionCreateParams::Type::OrSymbol),
+          vendor_description: T.nilable(String),
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Value in specified currency's smallest unit. e.g. $10 would be represented
+        # as 1000.
+        amount:,
+        # The date on which the transaction occurred.
+        as_of_date:,
+        # Either `credit` or `debit`.
+        direction:,
+        # The ID of the relevant Internal Account.
+        internal_account_id:,
+        # When applicable, the bank-given code that determines the transaction's category.
+        # For most banks this is the BAI2/BTRS transaction code.
+        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`, `us_bank`, or others.
+        vendor_code_type:,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        # strings.
+        metadata: nil,
+        # This field will be `true` if the transaction has posted to the account.
+        posted: nil,
+        # The type of the transaction. Examples could be
+        # `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+        type: nil,
+        # The transaction detail text that often appears in on your bank statement and in
+        # your banking portal.
+        vendor_description: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            amount: Integer,
+            as_of_date: T.nilable(Date),
+            direction: String,
+            internal_account_id: String,
+            vendor_code: T.nilable(String),
+            vendor_code_type: T.nilable(String),
+            metadata: T::Hash[Symbol, String],
+            posted: T::Boolean,
+            type:
+              T.nilable(
+                ModernTreasury::TransactionCreateParams::Type::OrSymbol
+              ),
+            vendor_description: T.nilable(String),
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The type of the transaction. Examples could be
+      # `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+      module Type
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::TransactionCreateParams::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACH =
+          T.let(
+            :ach,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        AU_BECS =
+          T.let(
+            :au_becs,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        BACS =
+          T.let(
+            :bacs,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        BOOK =
+          T.let(
+            :book,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        CARD =
+          T.let(
+            :card,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        CHATS =
+          T.let(
+            :chats,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        CHECK =
+          T.let(
+            :check,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        CROSS_BORDER =
+          T.let(
+            :cross_border,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        DK_NETS =
+          T.let(
+            :dk_nets,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        EFT =
+          T.let(
+            :eft,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        HU_ICS =
+          T.let(
+            :hu_ics,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        INTERAC =
+          T.let(
+            :interac,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        MASAV =
+          T.let(
+            :masav,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        MX_CCEN =
+          T.let(
+            :mx_ccen,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        NEFT =
+          T.let(
+            :neft,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        NICS =
+          T.let(
+            :nics,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        NZ_BECS =
+          T.let(
+            :nz_becs,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        PL_ELIXIR =
+          T.let(
+            :pl_elixir,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        PROVXCHANGE =
+          T.let(
+            :provxchange,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        RO_SENT =
+          T.let(
+            :ro_sent,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        RTP =
+          T.let(
+            :rtp,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        SE_BANKGIROT =
+          T.let(
+            :se_bankgirot,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        SEN =
+          T.let(
+            :sen,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        SEPA =
+          T.let(
+            :sepa,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        SG_GIRO =
+          T.let(
+            :sg_giro,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        SIC =
+          T.let(
+            :sic,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        SIGNET =
+          T.let(
+            :signet,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        SKNBI =
+          T.let(
+            :sknbi,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        WIRE =
+          T.let(
+            :wire,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        ZENGIN =
+          T.let(
+            :zengin,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+        OTHER =
+          T.let(
+            :other,
+            ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::TransactionCreateParams::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/transaction_delete_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class TransactionDeleteParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::TransactionDeleteParams,
+            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

data/rbi/modern_treasury/models/transaction_direction.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module TransactionDirection
+      extend ModernTreasury::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, ModernTreasury::TransactionDirection) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      CREDIT =
+        T.let(:credit, ModernTreasury::TransactionDirection::TaggedSymbol)
+      DEBIT = T.let(:debit, ModernTreasury::TransactionDirection::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[ModernTreasury::TransactionDirection::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/{lib/modern_treasury → modern_treasury}/models/transaction_list_params.rbi

@@ -6,6 +6,14 @@ module ModernTreasury
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::TransactionListParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       sig { returns(T.nilable(String)) }
       attr_accessor :after_cursor
 
@@ -116,50 +124,64 @@ module ModernTreasury
           transactable_type: String,
           vendor_id: String,
           virtual_account_id: String,
-          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
       def self.new(
         after_cursor: nil,
+        # Filters transactions with an `as_of_date` starting on or before the specified
+        # date (YYYY-MM-DD).
         as_of_date_end: nil,
+        # Filters transactions with an `as_of_date` starting on or after the specified
+        # date (YYYY-MM-DD).
         as_of_date_start: nil,
         counterparty_id: nil,
+        # Filters for transactions including the queried string in the description.
         description: nil,
         direction: nil,
+        # Specify `internal_account_id` if you wish to see transactions to/from a specific
+        # account.
         internal_account_id: nil,
+        # For example, if you want to query for records with metadata key `Type` and value
+        # `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+        # parameters.
         metadata: nil,
         payment_type: nil,
         per_page: nil,
+        # Either `true` or `false`.
         posted: nil,
         transactable_type: nil,
+        # Filters for transactions including the queried vendor id (an identifier given to
+        # transactions by the bank).
         vendor_id: nil,
         virtual_account_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              after_cursor: T.nilable(String),
-              as_of_date_end: Date,
-              as_of_date_start: Date,
-              counterparty_id: String,
-              description: String,
-              direction: String,
-              internal_account_id: String,
-              metadata: T::Hash[Symbol, String],
-              payment_type: String,
-              per_page: Integer,
-              posted: T::Boolean,
-              transactable_type: String,
-              vendor_id: String,
-              virtual_account_id: String,
-              request_options: ModernTreasury::RequestOptions
-            }
-          )
+        override.returns(
+          {
+            after_cursor: T.nilable(String),
+            as_of_date_end: Date,
+            as_of_date_start: Date,
+            counterparty_id: String,
+            description: String,
+            direction: String,
+            internal_account_id: String,
+            metadata: T::Hash[Symbol, String],
+            payment_type: String,
+            per_page: Integer,
+            posted: T::Boolean,
+            transactable_type: String,
+            vendor_id: String,
+            virtual_account_id: String,
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/modern_treasury/models/transaction_retrieve_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class TransactionRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::TransactionRetrieveParams,
+            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

data/rbi/{lib/modern_treasury → modern_treasury}/models/transaction_update_params.rbi

@@ -6,6 +6,14 @@ module ModernTreasury
       extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::TransactionUpdateParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
       # Additional data in the form of key-value pairs. Pairs can be removed by passing
       # an empty string or `null` as the value.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -17,16 +25,27 @@ module ModernTreasury
       sig do
         params(
           metadata: T::Hash[Symbol, String],
-          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
-        )
-          .returns(T.attached_class)
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Additional data in the form of key-value pairs. Pairs can be removed by passing
+        # an empty string or `null` as the value.
+        metadata: nil,
+        request_options: {}
+      )
       end
-      def self.new(metadata: nil, request_options: {}); end
 
       sig do
-        override.returns({metadata: T::Hash[Symbol, String], request_options: ModernTreasury::RequestOptions})
+        override.returns(
+          {
+            metadata: T::Hash[Symbol, String],
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
     end
   end
 end

data/rbi/{lib/modern_treasury → modern_treasury}/models/transactions/line_item_create_params.rbi

@@ -7,6 +7,14 @@ module ModernTreasury
         extend ModernTreasury::Internal::Type::RequestParameters::Converter
         include ModernTreasury::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::Transactions::LineItemCreateParams,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
         # 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) }
@@ -25,24 +33,33 @@ module ModernTreasury
             amount: Integer,
             expected_payment_id: String,
             transaction_id: String,
-            request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            request_options: ModernTreasury::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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 of the reconciled Expected Payment, otherwise `null`.
+          expected_payment_id:,
+          # The ID of the parent transaction.
+          transaction_id:,
+          request_options: {}
+        )
         end
-        def self.new(amount:, expected_payment_id:, transaction_id:, request_options: {}); end
 
         sig do
-          override
-            .returns(
-              {
-                amount: Integer,
-                expected_payment_id: String,
-                transaction_id: String,
-                request_options: ModernTreasury::RequestOptions
-              }
-            )
+          override.returns(
+            {
+              amount: Integer,
+              expected_payment_id: String,
+              transaction_id: String,
+              request_options: ModernTreasury::RequestOptions
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
       end
     end
   end

data/rbi/modern_treasury/models/transactions/line_item_delete_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module Transactions
+      class LineItemDeleteParams < ModernTreasury::Internal::Type::BaseModel
+        extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::Transactions::LineItemDeleteParams,
+              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