modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/models/transaction_create_params.rbi

@@ -6,85 +6,59 @@ module ModernTreasury
       extend ModernTreasury::RequestParameters::Converter
       include ModernTreasury::RequestParameters
 
+      # Value in specified currency's smallest unit. e.g. $10 would be represented
+      #   as 1000.
       sig { returns(Integer) }
-      def amount
-      end
-
-      sig { params(_: Integer).returns(Integer) }
-      def amount=(_)
-      end
+      attr_accessor :amount
 
+      # The date on which the transaction occurred.
       sig { returns(T.nilable(Date)) }
-      def as_of_date
-      end
-
-      sig { params(_: T.nilable(Date)).returns(T.nilable(Date)) }
-      def as_of_date=(_)
-      end
+      attr_accessor :as_of_date
 
+      # Either `credit` or `debit`.
       sig { returns(String) }
-      def direction
-      end
-
-      sig { params(_: String).returns(String) }
-      def direction=(_)
-      end
+      attr_accessor :direction
 
+      # The ID of the relevant Internal Account.
       sig { returns(String) }
-      def internal_account_id
-      end
-
-      sig { params(_: String).returns(String) }
-      def internal_account_id=(_)
-      end
+      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)) }
-      def vendor_code
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def vendor_code=(_)
-      end
+      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)) }
-      def vendor_code_type
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def vendor_code_type=(_)
-      end
+      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])) }
-      def metadata
-      end
+      attr_reader :metadata
 
-      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
-      def metadata=(_)
-      end
+      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)) }
-      def posted
-      end
+      attr_reader :posted
 
-      sig { params(_: T::Boolean).returns(T::Boolean) }
-      def posted=(_)
-      end
-
-      sig { returns(T.nilable(Symbol)) }
-      def type
-      end
+      sig { params(posted: T::Boolean).void }
+      attr_writer :posted
 
-      sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
-      def type=(_)
-      end
+      # The type of the transaction. Examples could be
+      #   `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+      sig { returns(T.nilable(ModernTreasury::Models::TransactionCreateParams::Type::OrSymbol)) }
+      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)) }
-      def vendor_description
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def vendor_description=(_)
-      end
+      attr_accessor :vendor_description
 
       sig do
         params(
@@ -96,13 +70,13 @@ module ModernTreasury
           vendor_code_type: T.nilable(String),
           metadata: T::Hash[Symbol, String],
           posted: T::Boolean,
-          type: T.nilable(Symbol),
+          type: T.nilable(ModernTreasury::Models::TransactionCreateParams::Type::OrSymbol),
           vendor_description: T.nilable(String),
-          request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         amount:,
         as_of_date:,
         direction:,
@@ -129,7 +103,7 @@ module ModernTreasury
               vendor_code_type: T.nilable(String),
               metadata: T::Hash[Symbol, String],
               posted: T::Boolean,
-              type: T.nilable(Symbol),
+              type: T.nilable(ModernTreasury::Models::TransactionCreateParams::Type::OrSymbol),
               vendor_description: T.nilable(String),
               request_options: ModernTreasury::RequestOptions
             }
@@ -138,42 +112,48 @@ module ModernTreasury
       def to_hash
       end
 
-      class Type < ModernTreasury::Enum
-        abstract!
-
-        ACH = T.let(:ach, T.nilable(Symbol))
-        AU_BECS = T.let(:au_becs, T.nilable(Symbol))
-        BACS = T.let(:bacs, T.nilable(Symbol))
-        BOOK = T.let(:book, T.nilable(Symbol))
-        CARD = T.let(:card, T.nilable(Symbol))
-        CHATS = T.let(:chats, T.nilable(Symbol))
-        CHECK = T.let(:check, T.nilable(Symbol))
-        CROSS_BORDER = T.let(:cross_border, T.nilable(Symbol))
-        DK_NETS = T.let(:dk_nets, T.nilable(Symbol))
-        EFT = T.let(:eft, T.nilable(Symbol))
-        HU_ICS = T.let(:hu_ics, T.nilable(Symbol))
-        INTERAC = T.let(:interac, T.nilable(Symbol))
-        MASAV = T.let(:masav, T.nilable(Symbol))
-        MX_CCEN = T.let(:mx_ccen, T.nilable(Symbol))
-        NEFT = T.let(:neft, T.nilable(Symbol))
-        NICS = T.let(:nics, T.nilable(Symbol))
-        NZ_BECS = T.let(:nz_becs, T.nilable(Symbol))
-        PL_ELIXIR = T.let(:pl_elixir, T.nilable(Symbol))
-        PROVXCHANGE = T.let(:provxchange, T.nilable(Symbol))
-        RO_SENT = T.let(:ro_sent, T.nilable(Symbol))
-        RTP = T.let(:rtp, T.nilable(Symbol))
-        SE_BANKGIROT = T.let(:se_bankgirot, T.nilable(Symbol))
-        SEN = T.let(:sen, T.nilable(Symbol))
-        SEPA = T.let(:sepa, T.nilable(Symbol))
-        SG_GIRO = T.let(:sg_giro, T.nilable(Symbol))
-        SIC = T.let(:sic, T.nilable(Symbol))
-        SIGNET = T.let(:signet, T.nilable(Symbol))
-        SKNBI = T.let(:sknbi, T.nilable(Symbol))
-        WIRE = T.let(:wire, T.nilable(Symbol))
-        ZENGIN = T.let(:zengin, T.nilable(Symbol))
-        OTHER = T.let(:other, T.nilable(Symbol))
-
-        sig { override.returns(T::Array[Symbol]) }
+      # The type of the transaction. Examples could be
+      #   `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+      module Type
+        extend ModernTreasury::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::TransactionCreateParams::Type) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol) }
+
+        ACH = T.let(:ach, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        AU_BECS = T.let(:au_becs, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        BACS = T.let(:bacs, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        BOOK = T.let(:book, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        CARD = T.let(:card, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        CHATS = T.let(:chats, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        CHECK = T.let(:check, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        CROSS_BORDER = T.let(:cross_border, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        DK_NETS = T.let(:dk_nets, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        EFT = T.let(:eft, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        HU_ICS = T.let(:hu_ics, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        INTERAC = T.let(:interac, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        MASAV = T.let(:masav, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        MX_CCEN = T.let(:mx_ccen, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        NEFT = T.let(:neft, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        NICS = T.let(:nics, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        NZ_BECS = T.let(:nz_becs, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        PL_ELIXIR = T.let(:pl_elixir, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        PROVXCHANGE = T.let(:provxchange, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        RO_SENT = T.let(:ro_sent, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        RTP = T.let(:rtp, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        SE_BANKGIROT = T.let(:se_bankgirot, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        SEN = T.let(:sen, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        SEPA = T.let(:sepa, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        SG_GIRO = T.let(:sg_giro, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        SIC = T.let(:sic, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        SIGNET = T.let(:signet, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        SKNBI = T.let(:sknbi, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        WIRE = T.let(:wire, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        ZENGIN = T.let(:zengin, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+        OTHER = T.let(:other, ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol)
+
+        sig { override.returns(T::Array[ModernTreasury::Models::TransactionCreateParams::Type::TaggedSymbol]) }
         def self.values
         end
       end

data/rbi/lib/modern_treasury/models/transaction_delete_params.rbi

@@ -6,8 +6,11 @@ module ModernTreasury
       extend ModernTreasury::RequestParameters::Converter
       include ModernTreasury::RequestParameters
 
-      sig { params(request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])).void }
-      def initialize(request_options: {})
+      sig do
+        params(request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
       end
 
       sig { override.returns({request_options: ModernTreasury::RequestOptions}) }

data/rbi/lib/modern_treasury/models/transaction_direction.rbi

@@ -2,13 +2,16 @@
 
 module ModernTreasury
   module Models
-    class TransactionDirection < ModernTreasury::Enum
-      abstract!
+    module TransactionDirection
+      extend ModernTreasury::Enum
 
-      CREDIT = :credit
-      DEBIT = :debit
+      TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::TransactionDirection) }
+      OrSymbol = T.type_alias { T.any(Symbol, ModernTreasury::Models::TransactionDirection::TaggedSymbol) }
 
-      sig { override.returns(T::Array[Symbol]) }
+      CREDIT = T.let(:credit, ModernTreasury::Models::TransactionDirection::TaggedSymbol)
+      DEBIT = T.let(:debit, ModernTreasury::Models::TransactionDirection::TaggedSymbol)
+
+      sig { override.returns(T::Array[ModernTreasury::Models::TransactionDirection::TaggedSymbol]) }
       def self.values
       end
     end

data/rbi/lib/modern_treasury/models/transaction_list_params.rbi

@@ -7,116 +7,98 @@ module ModernTreasury
       include ModernTreasury::RequestParameters
 
       sig { returns(T.nilable(String)) }
-      def after_cursor
-      end
-
-      sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-      def after_cursor=(_)
-      end
+      attr_accessor :after_cursor
 
+      # Filters transactions with an `as_of_date` starting on or before the specified
+      #   date (YYYY-MM-DD).
       sig { returns(T.nilable(Date)) }
-      def as_of_date_end
-      end
+      attr_reader :as_of_date_end
 
-      sig { params(_: Date).returns(Date) }
-      def as_of_date_end=(_)
-      end
+      sig { params(as_of_date_end: Date).void }
+      attr_writer :as_of_date_end
 
+      # Filters transactions with an `as_of_date` starting on or after the specified
+      #   date (YYYY-MM-DD).
       sig { returns(T.nilable(Date)) }
-      def as_of_date_start
-      end
+      attr_reader :as_of_date_start
 
-      sig { params(_: Date).returns(Date) }
-      def as_of_date_start=(_)
-      end
+      sig { params(as_of_date_start: Date).void }
+      attr_writer :as_of_date_start
 
       sig { returns(T.nilable(String)) }
-      def counterparty_id
-      end
+      attr_reader :counterparty_id
 
-      sig { params(_: String).returns(String) }
-      def counterparty_id=(_)
-      end
+      sig { params(counterparty_id: String).void }
+      attr_writer :counterparty_id
 
+      # Filters for transactions including the queried string in the description.
       sig { returns(T.nilable(String)) }
-      def description
-      end
+      attr_reader :description
 
-      sig { params(_: String).returns(String) }
-      def description=(_)
-      end
+      sig { params(description: String).void }
+      attr_writer :description
 
       sig { returns(T.nilable(String)) }
-      def direction
-      end
+      attr_reader :direction
 
-      sig { params(_: String).returns(String) }
-      def direction=(_)
-      end
+      sig { params(direction: String).void }
+      attr_writer :direction
 
+      # Specify `internal_account_id` if you wish to see transactions to/from a specific
+      #   account.
       sig { returns(T.nilable(String)) }
-      def internal_account_id
-      end
+      attr_reader :internal_account_id
 
-      sig { params(_: String).returns(String) }
-      def internal_account_id=(_)
-      end
+      sig { params(internal_account_id: String).void }
+      attr_writer :internal_account_id
 
+      # 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.
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
-      def metadata
-      end
+      attr_reader :metadata
 
-      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
-      def metadata=(_)
-      end
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
 
       sig { returns(T.nilable(String)) }
-      def payment_type
-      end
+      attr_reader :payment_type
 
-      sig { params(_: String).returns(String) }
-      def payment_type=(_)
-      end
+      sig { params(payment_type: String).void }
+      attr_writer :payment_type
 
       sig { returns(T.nilable(Integer)) }
-      def per_page
-      end
+      attr_reader :per_page
 
-      sig { params(_: Integer).returns(Integer) }
-      def per_page=(_)
-      end
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
 
+      # Either `true` or `false`.
       sig { returns(T.nilable(T::Boolean)) }
-      def posted
-      end
+      attr_reader :posted
 
-      sig { params(_: T::Boolean).returns(T::Boolean) }
-      def posted=(_)
-      end
+      sig { params(posted: T::Boolean).void }
+      attr_writer :posted
 
       sig { returns(T.nilable(String)) }
-      def transactable_type
-      end
+      attr_reader :transactable_type
 
-      sig { params(_: String).returns(String) }
-      def transactable_type=(_)
-      end
+      sig { params(transactable_type: String).void }
+      attr_writer :transactable_type
 
+      # Filters for transactions including the queried vendor id (an identifier given to
+      #   transactions by the bank).
       sig { returns(T.nilable(String)) }
-      def vendor_id
-      end
+      attr_reader :vendor_id
 
-      sig { params(_: String).returns(String) }
-      def vendor_id=(_)
-      end
+      sig { params(vendor_id: String).void }
+      attr_writer :vendor_id
 
       sig { returns(T.nilable(String)) }
-      def virtual_account_id
-      end
+      attr_reader :virtual_account_id
 
-      sig { params(_: String).returns(String) }
-      def virtual_account_id=(_)
-      end
+      sig { params(virtual_account_id: String).void }
+      attr_writer :virtual_account_id
 
       sig do
         params(
@@ -134,11 +116,11 @@ module ModernTreasury
           transactable_type: String,
           vendor_id: String,
           virtual_account_id: String,
-          request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(
+      def self.new(
         after_cursor: nil,
         as_of_date_end: nil,
         as_of_date_start: nil,

data/rbi/lib/modern_treasury/models/transaction_retrieve_params.rbi

@@ -6,8 +6,11 @@ module ModernTreasury
       extend ModernTreasury::RequestParameters::Converter
       include ModernTreasury::RequestParameters
 
-      sig { params(request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])).void }
-      def initialize(request_options: {})
+      sig do
+        params(request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+          .returns(T.attached_class)
+      end
+      def self.new(request_options: {})
       end
 
       sig { override.returns({request_options: ModernTreasury::RequestOptions}) }

data/rbi/lib/modern_treasury/models/transaction_update_params.rbi

@@ -6,22 +6,22 @@ module ModernTreasury
       extend ModernTreasury::RequestParameters::Converter
       include ModernTreasury::RequestParameters
 
+      # 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])) }
-      def metadata
-      end
+      attr_reader :metadata
 
-      sig { params(_: T::Hash[Symbol, String]).returns(T::Hash[Symbol, String]) }
-      def metadata=(_)
-      end
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
 
       sig do
         params(
           metadata: T::Hash[Symbol, String],
-          request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
         )
-          .void
+          .returns(T.attached_class)
       end
-      def initialize(metadata: nil, request_options: {})
+      def self.new(metadata: nil, request_options: {})
       end
 
       sig do

data/rbi/lib/modern_treasury/models/transactions/line_item_create_params.rbi

@@ -7,40 +7,29 @@ module ModernTreasury
         extend ModernTreasury::RequestParameters::Converter
         include ModernTreasury::RequestParameters
 
+        # 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) }
-        def amount
-        end
-
-        sig { params(_: Integer).returns(Integer) }
-        def amount=(_)
-        end
+        attr_accessor :amount
 
+        # The ID of the reconciled Expected Payment, otherwise `null`.
         sig { returns(String) }
-        def expected_payment_id
-        end
-
-        sig { params(_: String).returns(String) }
-        def expected_payment_id=(_)
-        end
+        attr_accessor :expected_payment_id
 
+        # The ID of the parent transaction.
         sig { returns(String) }
-        def transaction_id
-        end
-
-        sig { params(_: String).returns(String) }
-        def transaction_id=(_)
-        end
+        attr_accessor :transaction_id
 
         sig do
           params(
             amount: Integer,
             expected_payment_id: String,
             transaction_id: String,
-            request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])
+            request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(amount:, expected_payment_id:, transaction_id:, request_options: {})
+        def self.new(amount:, expected_payment_id:, transaction_id:, request_options: {})
         end
 
         sig do

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

@@ -8,9 +8,10 @@ module ModernTreasury
         include ModernTreasury::RequestParameters
 
         sig do
-          params(request_options: T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything])).void
+          params(request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
+            .returns(T.attached_class)
         end
-        def initialize(request_options: {})
+        def self.new(request_options: {})
         end
 
         sig { override.returns({request_options: ModernTreasury::RequestOptions}) }