modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

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

@@ -0,0 +1,162 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class TransactionCreateParams < ModernTreasury::BaseModel
+      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) }
+      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 { 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)) }
+      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::Models::TransactionCreateParams::Type::OrSymbol),
+          vendor_description: T.nilable(String),
+          request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        amount:,
+        as_of_date:,
+        direction:,
+        internal_account_id:,
+        vendor_code:,
+        vendor_code_type:,
+        metadata: nil,
+        posted: nil,
+        type: nil,
+        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::Models::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::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
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class TransactionDeleteParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      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}) }
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module TransactionDirection
+      extend ModernTreasury::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, ModernTreasury::Models::TransactionDirection) }
+      OrSymbol = T.type_alias { T.any(Symbol, ModernTreasury::Models::TransactionDirection::TaggedSymbol) }
+
+      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
+  end
+end

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

@@ -0,0 +1,168 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class TransactionListParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      sig { returns(T.nilable(String)) }
+      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)) }
+      attr_reader :as_of_date_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)) }
+      attr_reader :as_of_date_start
+
+      sig { params(as_of_date_start: Date).void }
+      attr_writer :as_of_date_start
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :counterparty_id
+
+      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)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :direction
+
+      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)) }
+      attr_reader :internal_account_id
+
+      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])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :payment_type
+
+      sig { params(payment_type: String).void }
+      attr_writer :payment_type
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      # Either `true` or `false`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :posted
+
+      sig { params(posted: T::Boolean).void }
+      attr_writer :posted
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :transactable_type
+
+      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)) }
+      attr_reader :vendor_id
+
+      sig { params(vendor_id: String).void }
+      attr_writer :vendor_id
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :virtual_account_id
+
+      sig { params(virtual_account_id: String).void }
+      attr_writer :virtual_account_id
+
+      sig do
+        params(
+          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: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        after_cursor: nil,
+        as_of_date_end: nil,
+        as_of_date_start: nil,
+        counterparty_id: nil,
+        description: nil,
+        direction: nil,
+        internal_account_id: nil,
+        metadata: nil,
+        payment_type: nil,
+        per_page: nil,
+        posted: nil,
+        transactable_type: nil,
+        vendor_id: nil,
+        virtual_account_id: nil,
+        request_options: {}
+      )
+      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
+            }
+          )
+      end
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class TransactionRetrieveParams < ModernTreasury::BaseModel
+      extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      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}) }
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class TransactionUpdateParams < ModernTreasury::BaseModel
+      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])) }
+      attr_reader :metadata
+
+      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, ModernTreasury::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(metadata: nil, request_options: {})
+      end
+
+      sig do
+        override.returns({metadata: T::Hash[Symbol, String], request_options: ModernTreasury::RequestOptions})
+      end
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module Transactions
+      class LineItemCreateParams < ModernTreasury::BaseModel
+        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) }
+        attr_accessor :amount
+
+        # The ID of the reconciled Expected Payment, otherwise `null`.
+        sig { returns(String) }
+        attr_accessor :expected_payment_id
+
+        # The ID of the parent transaction.
+        sig { returns(String) }
+        attr_accessor :transaction_id
+
+        sig do
+          params(
+            amount: Integer,
+            expected_payment_id: String,
+            transaction_id: String,
+            request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+          )
+            .returns(T.attached_class)
+        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
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module Transactions
+      class LineItemDeleteParams < ModernTreasury::BaseModel
+        extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        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}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module Transactions
+      class LineItemListParams < ModernTreasury::BaseModel
+        extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        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 { returns(T.nilable(ModernTreasury::Models::Transactions::LineItemListParams::Type::OrSymbol)) }
+        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::Models::Transactions::LineItemListParams::Type::OrSymbol),
+            request_options: T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)
+          )
+            .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::Models::Transactions::LineItemListParams::Type::OrSymbol),
+                request_options: ModernTreasury::RequestOptions
+              }
+            )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend ModernTreasury::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, ModernTreasury::Models::Transactions::LineItemListParams::Type) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, ModernTreasury::Models::Transactions::LineItemListParams::Type::TaggedSymbol) }
+
+          ORIGINATING =
+            T.let(:originating, ModernTreasury::Models::Transactions::LineItemListParams::Type::TaggedSymbol)
+          RECEIVING =
+            T.let(:receiving, ModernTreasury::Models::Transactions::LineItemListParams::Type::TaggedSymbol)
+
+          sig { override.returns(T::Array[ModernTreasury::Models::Transactions::LineItemListParams::Type::TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    module Transactions
+      class LineItemRetrieveParams < ModernTreasury::BaseModel
+        extend ModernTreasury::RequestParameters::Converter
+        include ModernTreasury::RequestParameters
+
+        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}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end