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

data/rbi/lib/modern_treasury/resources/incoming_payment_details.rbi

@@ -3,85 +3,124 @@
 module ModernTreasury
   module Resources
     class IncomingPaymentDetails
+      # Get an existing Incoming Payment Detail.
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Models::IncomingPaymentDetail)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The unique identifier of the incoming payment detail.
+        id,
+        request_options: {}
+      )
       end
 
+      # Update an existing Incoming Payment Detail.
       sig do
         params(
           id: String,
           metadata: T::Hash[Symbol, String],
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Models::IncomingPaymentDetail)
       end
-      def update(id, metadata: nil, request_options: {})
+      def update(
+        # The unique identifier of the incoming payment detail.
+        id,
+        # 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
 
+      # Get a list of Incoming Payment Details.
       sig do
         params(
           after_cursor: T.nilable(String),
           as_of_date_end: Date,
           as_of_date_start: Date,
-          direction: Symbol,
+          direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
           metadata: T::Hash[Symbol, String],
           per_page: Integer,
-          status: Symbol,
-          type: Symbol,
+          status: ModernTreasury::Models::IncomingPaymentDetailListParams::Status::OrSymbol,
+          type: ModernTreasury::Models::IncomingPaymentDetailListParams::Type::OrSymbol,
           virtual_account_id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Page[ModernTreasury::Models::IncomingPaymentDetail])
       end
       def list(
         after_cursor: nil,
+        # Filters incoming payment details with an as_of_date starting on or before the
+        #   specified date (YYYY-MM-DD).
         as_of_date_end: nil,
+        # Filters incoming payment details with an as_of_date starting on or after the
+        #   specified date (YYYY-MM-DD).
         as_of_date_start: nil,
+        # One of `credit` or `debit`.
         direction: 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,
         per_page: nil,
+        # The current status of the incoming payment order. One of `pending`, `completed`,
+        #   or `returned`.
         status: nil,
+        # One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
+        #   `wire`.
         type: nil,
+        # If the incoming payment detail is in a virtual account, the ID of the Virtual
+        #   Account.
         virtual_account_id: nil,
         request_options: {}
       )
       end
 
+      # Simulate Incoming Payment Detail
       sig do
         params(
           amount: Integer,
           as_of_date: T.nilable(Date),
-          currency: T.nilable(Symbol),
+          currency: T.nilable(ModernTreasury::Models::Currency::OrSymbol),
           description: T.nilable(String),
-          direction: Symbol,
+          direction: ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction::OrSymbol,
           internal_account_id: String,
-          type: Symbol,
+          type: ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Type::OrSymbol,
           virtual_account_id: T.nilable(String),
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Models::AsyncResponse)
       end
       def create_async(
+        # Value in specified currency's smallest unit. e.g. $10 would be represented
+        #   as 1000.
         amount: nil,
+        # Defaults to today.
         as_of_date: nil,
+        # Defaults to the currency of the originating account.
         currency: nil,
+        # Defaults to a random description.
         description: nil,
+        # One of `credit`, `debit`.
         direction: nil,
+        # The ID of one of your internal accounts.
         internal_account_id: nil,
+        # One of `ach`, `wire`, `check`.
         type: nil,
+        # An optional parameter to associate the incoming payment detail to a virtual
+        #   account.
         virtual_account_id: nil,
         request_options: {}
       )
       end
 
-      sig { params(client: ModernTreasury::Client).void }
-      def initialize(client:)
+      sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/modern_treasury/resources/internal_accounts/balance_reports.rbi

@@ -4,72 +4,101 @@ module ModernTreasury
   module Resources
     class InternalAccounts
       class BalanceReports
+        # create balance reports
         sig do
           params(
             internal_account_id: String,
             as_of_date: Date,
             as_of_time: String,
-            balance_report_type: Symbol,
-            balances: T::Array[ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance],
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            balance_report_type: ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::BalanceReportType::OrSymbol,
+            balances: T::Array[
+            T.any(
+              ModernTreasury::Models::InternalAccounts::BalanceReportCreateParams::Balance,
+              ModernTreasury::Util::AnyHash
+            )
+            ],
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
           )
             .returns(ModernTreasury::Models::InternalAccounts::BalanceReport)
         end
         def create(
           internal_account_id,
+          # The date of the balance report in local time.
           as_of_date:,
+          # The time (24-hour clock) of the balance report in local time.
           as_of_time:,
+          # The specific type of balance report. One of `intraday`, `previous_day`,
+          #   `real_time`, or `other`.
           balance_report_type:,
+          # An array of `Balance` objects.
           balances:,
           request_options: {}
         )
         end
 
+        # Get a single balance report for a given internal account.
         sig do
           params(
             id: String,
             internal_account_id: String,
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
           )
             .returns(ModernTreasury::Models::InternalAccounts::BalanceReport)
         end
-        def retrieve(id, internal_account_id:, request_options: {})
+        def retrieve(
+          # Either the unique identifier of the balance report or latest for the latest
+          #   balance report.
+          id,
+          internal_account_id:,
+          request_options: {}
+        )
         end
 
+        # Get all balance reports for a given internal account.
         sig do
           params(
             internal_account_id: String,
             after_cursor: T.nilable(String),
             as_of_date: Date,
-            balance_report_type: Symbol,
+            balance_report_type: ModernTreasury::Models::InternalAccounts::BalanceReportListParams::BalanceReportType::OrSymbol,
             per_page: Integer,
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
           )
             .returns(ModernTreasury::Page[ModernTreasury::Models::InternalAccounts::BalanceReport])
         end
         def list(
           internal_account_id,
           after_cursor: nil,
+          # The date of the balance report in local time.
           as_of_date: nil,
+          # The specific type of balance report. One of `intraday`, `previous_day`,
+          #   `real_time`, or `other`.
           balance_report_type: nil,
           per_page: nil,
           request_options: {}
         )
         end
 
+        # Deletes a given balance report.
         sig do
           params(
             id: String,
             internal_account_id: String,
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
           )
             .void
         end
-        def delete(id, internal_account_id:, request_options: {})
+        def delete(
+          # Either the unique identifier of the balance report or latest for the latest
+          #   balance report.
+          id,
+          internal_account_id:,
+          request_options: {}
+        )
         end
 
-        sig { params(client: ModernTreasury::Client).void }
-        def initialize(client:)
+        sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+        def self.new(client:)
         end
       end
     end

data/rbi/lib/modern_treasury/resources/internal_accounts.rbi

@@ -4,48 +4,65 @@ module ModernTreasury
   module Resources
     class InternalAccounts
       sig { returns(ModernTreasury::Resources::InternalAccounts::BalanceReports) }
-      def balance_reports
-      end
+      attr_reader :balance_reports
 
+      # create internal account
       sig do
         params(
           connection_id: String,
-          currency: Symbol,
+          currency: ModernTreasury::Models::InternalAccountCreateParams::Currency::OrSymbol,
           name: String,
           party_name: String,
           counterparty_id: String,
           legal_entity_id: String,
           parent_account_id: String,
-          party_address: ModernTreasury::Models::InternalAccountCreateParams::PartyAddress,
+          party_address: T.any(ModernTreasury::Models::InternalAccountCreateParams::PartyAddress, ModernTreasury::Util::AnyHash),
           vendor_attributes: T::Hash[Symbol, String],
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Models::InternalAccount)
       end
       def create(
+        # The identifier of the financial institution the account belongs to.
         connection_id:,
+        # Either "USD" or "CAD". Internal accounts created at Increase only supports
+        #   "USD".
         currency:,
+        # The nickname of the account.
         name:,
+        # The legal name of the entity which owns the account.
         party_name:,
+        # The Counterparty associated to this account.
         counterparty_id: nil,
+        # The LegalEntity associated to this account.
         legal_entity_id: nil,
+        # The parent internal account of this new account.
         parent_account_id: nil,
+        # The address associated with the owner or null.
         party_address: nil,
+        # A hash of vendor specific attributes that will be used when creating the account
+        #   at the vendor specified by the given connection.
         vendor_attributes: nil,
         request_options: {}
       )
       end
 
+      # get internal account
       sig do
         params(
           id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Models::InternalAccount)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # Unique identifier for the account.
+        id,
+        request_options: {}
+      )
       end
 
+      # update internal account
       sig do
         params(
           id: String,
@@ -54,50 +71,66 @@ module ModernTreasury
           metadata: T::Hash[Symbol, String],
           name: String,
           parent_account_id: String,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Models::InternalAccount)
       end
       def update(
+        # Unique identifier for the account.
         id,
+        # The Counterparty associated to this account.
         counterparty_id: nil,
+        # The Ledger Account associated to this account.
         ledger_account_id: nil,
+        # 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,
+        # The nickname for the internal account.
         name: nil,
+        # The parent internal account for this account.
         parent_account_id: nil,
         request_options: {}
       )
       end
 
+      # list internal accounts
       sig do
         params(
           after_cursor: T.nilable(String),
           counterparty_id: String,
-          currency: Symbol,
+          currency: ModernTreasury::Models::Currency::OrSymbol,
           legal_entity_id: String,
           metadata: T::Hash[Symbol, String],
-          payment_direction: Symbol,
-          payment_type: Symbol,
+          payment_direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
+          payment_type: ModernTreasury::Models::InternalAccountListParams::PaymentType::OrSymbol,
           per_page: Integer,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Page[ModernTreasury::Models::InternalAccount])
       end
       def list(
         after_cursor: nil,
+        # Only return internal accounts associated with this counterparty.
         counterparty_id: nil,
+        # Only return internal accounts with this currency.
         currency: nil,
+        # Only return internal accounts associated with this legal entity.
         legal_entity_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,
+        # Only return internal accounts that can originate payments with this direction.
         payment_direction: nil,
+        # Only return internal accounts that can make this type of payment.
         payment_type: nil,
         per_page: nil,
         request_options: {}
       )
       end
 
-      sig { params(client: ModernTreasury::Client).void }
-      def initialize(client:)
+      sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/modern_treasury/resources/invoices/line_items.rbi

@@ -4,6 +4,7 @@ module ModernTreasury
   module Resources
     class Invoices
       class LineItems
+        # create invoice_line_item
         sig do
           params(
             invoice_id: String,
@@ -14,34 +15,57 @@ module ModernTreasury
             metadata: T::Hash[Symbol, String],
             quantity: Integer,
             unit_amount_decimal: String,
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
           )
             .returns(ModernTreasury::Models::Invoices::InvoiceLineItem)
         end
         def create(
+          # invoice_id
           invoice_id,
+          # The name of the line item, typically a product or SKU name.
           name:,
+          # The cost per unit of the product or service that this line item is for,
+          #   specified in the invoice currency's smallest unit.
           unit_amount:,
+          # An optional free-form description of the line item.
           description: nil,
+          # Either `debit` or `credit`. `debit` indicates that a client owes the business
+          #   money and increases the invoice's `total_amount` due. `credit` has the opposite
+          #   intention and effect.
           direction: nil,
+          # Additional data represented as key-value pairs. Both the key and value must be
+          #   strings.
           metadata: nil,
+          # The number of units of a product or service that this line item is for. Must be
+          #   a whole number. Defaults to 1 if not provided.
           quantity: nil,
+          # The cost per unit of the product or service that this line item is for,
+          #   specified in the invoice currency's smallest unit. Accepts decimal strings with
+          #   up to 12 decimals
           unit_amount_decimal: nil,
           request_options: {}
         )
         end
 
+        # get invoice_line_item
         sig do
           params(
             id: String,
             invoice_id: String,
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
           )
             .returns(ModernTreasury::Models::Invoices::InvoiceLineItem)
         end
-        def retrieve(id, invoice_id:, request_options: {})
+        def retrieve(
+          # id
+          id,
+          # invoice_id
+          invoice_id:,
+          request_options: {}
+        )
         end
 
+        # update invoice_line_item
         sig do
           params(
             id: String,
@@ -53,49 +77,79 @@ module ModernTreasury
             quantity: Integer,
             unit_amount: Integer,
             unit_amount_decimal: String,
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
           )
             .returns(ModernTreasury::Models::Invoices::InvoiceLineItem)
         end
         def update(
+          # Path param: id
           id,
+          # Path param: invoice_id
           invoice_id:,
+          # Body param: An optional free-form description of the line item.
           description: nil,
+          # Body param: Either `debit` or `credit`. `debit` indicates that a client owes the
+          #   business money and increases the invoice's `total_amount` due. `credit` has the
+          #   opposite intention and effect.
           direction: nil,
+          # Body param: Additional data represented as key-value pairs. Both the key and
+          #   value must be strings.
           metadata: nil,
+          # Body param: The name of the line item, typically a product or SKU name.
           name: nil,
+          # Body param: The number of units of a product or service that this line item is
+          #   for. Must be a whole number. Defaults to 1 if not provided.
           quantity: nil,
+          # Body param: The cost per unit of the product or service that this line item is
+          #   for, specified in the invoice currency's smallest unit.
           unit_amount: nil,
+          # Body param: The cost per unit of the product or service that this line item is
+          #   for, specified in the invoice currency's smallest unit. Accepts decimal strings
+          #   with up to 12 decimals
           unit_amount_decimal: nil,
           request_options: {}
         )
         end
 
+        # list invoice_line_items
         sig do
           params(
             invoice_id: String,
             after_cursor: T.nilable(String),
             per_page: Integer,
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
           )
             .returns(ModernTreasury::Page[ModernTreasury::Models::Invoices::InvoiceLineItem])
         end
-        def list(invoice_id, after_cursor: nil, per_page: nil, request_options: {})
+        def list(
+          # invoice_id
+          invoice_id,
+          after_cursor: nil,
+          per_page: nil,
+          request_options: {}
+        )
         end
 
+        # delete invoice_line_item
         sig do
           params(
             id: String,
             invoice_id: String,
-            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
           )
             .returns(ModernTreasury::Models::Invoices::InvoiceLineItem)
         end
-        def delete(id, invoice_id:, request_options: {})
+        def delete(
+          # id
+          id,
+          # invoice_id
+          invoice_id:,
+          request_options: {}
+        )
         end
 
-        sig { params(client: ModernTreasury::Client).void }
-        def initialize(client:)
+        sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
+        def self.new(client:)
         end
       end
     end