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

data/rbi/lib/modern_treasury/base_page.rbi

@@ -2,8 +2,6 @@
 
 module ModernTreasury
   module BasePage
-    abstract!
-
     Elem = type_member(:out)
 
     sig { overridable.returns(T::Boolean) }
@@ -22,18 +20,17 @@ module ModernTreasury
     def to_enum
     end
 
-    alias_method :enum_for, :to_enum
-
+    # @api private
     sig do
       params(
         client: ModernTreasury::BaseClient,
         req: ModernTreasury::BaseClient::RequestComponentsShape,
         headers: T.any(T::Hash[String, String], Net::HTTPHeader),
-        unwrapped: T.anything
+        page_data: T.anything
       )
         .void
     end
-    def initialize(client:, req:, headers:, unwrapped:)
+    def initialize(client:, req:, headers:, page_data:)
     end
   end
 end

data/rbi/lib/modern_treasury/client.rbi

@@ -11,165 +11,137 @@ module ModernTreasury
     DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
 
     sig { returns(String) }
-    def api_key
-    end
+    attr_reader :api_key
 
     sig { returns(String) }
-    def organization_id
-    end
+    attr_reader :organization_id
 
     sig { returns(ModernTreasury::Resources::Connections) }
-    def connections
-    end
+    attr_reader :connections
 
     sig { returns(ModernTreasury::Resources::Counterparties) }
-    def counterparties
-    end
+    attr_reader :counterparties
 
     sig { returns(ModernTreasury::Resources::Events) }
-    def events
-    end
+    attr_reader :events
 
     sig { returns(ModernTreasury::Resources::ExpectedPayments) }
-    def expected_payments
-    end
+    attr_reader :expected_payments
 
     sig { returns(ModernTreasury::Resources::ExternalAccounts) }
-    def external_accounts
-    end
+    attr_reader :external_accounts
 
     sig { returns(ModernTreasury::Resources::IncomingPaymentDetails) }
-    def incoming_payment_details
-    end
+    attr_reader :incoming_payment_details
 
     sig { returns(ModernTreasury::Resources::Invoices) }
-    def invoices
-    end
+    attr_reader :invoices
 
     sig { returns(ModernTreasury::Resources::Documents) }
-    def documents
-    end
+    attr_reader :documents
 
     sig { returns(ModernTreasury::Resources::AccountCollectionFlows) }
-    def account_collection_flows
-    end
+    attr_reader :account_collection_flows
 
     sig { returns(ModernTreasury::Resources::AccountDetails) }
-    def account_details
-    end
+    attr_reader :account_details
 
     sig { returns(ModernTreasury::Resources::RoutingDetails) }
-    def routing_details
-    end
+    attr_reader :routing_details
 
     sig { returns(ModernTreasury::Resources::InternalAccounts) }
-    def internal_accounts
-    end
+    attr_reader :internal_accounts
 
     sig { returns(ModernTreasury::Resources::Ledgers) }
-    def ledgers
-    end
+    attr_reader :ledgers
 
     sig { returns(ModernTreasury::Resources::LedgerableEvents) }
-    def ledgerable_events
-    end
+    attr_reader :ledgerable_events
 
     sig { returns(ModernTreasury::Resources::LedgerAccountCategories) }
-    def ledger_account_categories
-    end
+    attr_reader :ledger_account_categories
 
     sig { returns(ModernTreasury::Resources::LedgerAccounts) }
-    def ledger_accounts
-    end
+    attr_reader :ledger_accounts
 
     sig { returns(ModernTreasury::Resources::LedgerAccountBalanceMonitors) }
-    def ledger_account_balance_monitors
-    end
+    attr_reader :ledger_account_balance_monitors
 
     sig { returns(ModernTreasury::Resources::LedgerAccountStatements) }
-    def ledger_account_statements
-    end
+    attr_reader :ledger_account_statements
 
     sig { returns(ModernTreasury::Resources::LedgerEntries) }
-    def ledger_entries
-    end
+    attr_reader :ledger_entries
 
     sig { returns(ModernTreasury::Resources::LedgerEventHandlers) }
-    def ledger_event_handlers
-    end
+    attr_reader :ledger_event_handlers
 
     sig { returns(ModernTreasury::Resources::LedgerTransactions) }
-    def ledger_transactions
-    end
+    attr_reader :ledger_transactions
 
     sig { returns(ModernTreasury::Resources::LineItems) }
-    def line_items
-    end
+    attr_reader :line_items
 
     sig { returns(ModernTreasury::Resources::PaymentFlows) }
-    def payment_flows
-    end
+    attr_reader :payment_flows
 
     sig { returns(ModernTreasury::Resources::PaymentOrders) }
-    def payment_orders
-    end
+    attr_reader :payment_orders
 
     sig { returns(ModernTreasury::Resources::PaymentReferences) }
-    def payment_references
-    end
+    attr_reader :payment_references
 
     sig { returns(ModernTreasury::Resources::Returns) }
-    def returns
-    end
+    attr_reader :returns
 
     sig { returns(ModernTreasury::Resources::Transactions) }
-    def transactions
-    end
+    attr_reader :transactions
 
     sig { returns(ModernTreasury::Resources::Validations) }
-    def validations
-    end
+    attr_reader :validations
 
     sig { returns(ModernTreasury::Resources::PaperItems) }
-    def paper_items
-    end
+    attr_reader :paper_items
 
     sig { returns(ModernTreasury::Resources::VirtualAccounts) }
-    def virtual_accounts
-    end
+    attr_reader :virtual_accounts
 
     sig { returns(ModernTreasury::Resources::BulkRequests) }
-    def bulk_requests
-    end
+    attr_reader :bulk_requests
 
     sig { returns(ModernTreasury::Resources::BulkResults) }
-    def bulk_results
-    end
+    attr_reader :bulk_results
 
     sig { returns(ModernTreasury::Resources::LedgerAccountSettlements) }
-    def ledger_account_settlements
-    end
+    attr_reader :ledger_account_settlements
 
     sig { returns(ModernTreasury::Resources::ForeignExchangeQuotes) }
-    def foreign_exchange_quotes
-    end
+    attr_reader :foreign_exchange_quotes
 
     sig { returns(ModernTreasury::Resources::ConnectionLegalEntities) }
-    def connection_legal_entities
-    end
+    attr_reader :connection_legal_entities
 
     sig { returns(ModernTreasury::Resources::LegalEntities) }
-    def legal_entities
-    end
+    attr_reader :legal_entities
 
     sig { returns(ModernTreasury::Resources::LegalEntityAssociations) }
-    def legal_entity_associations
+    attr_reader :legal_entity_associations
+
+    # A test endpoint often used to confirm credentials and headers are being passed
+    #   in correctly.
+    sig do
+      params(request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash)))
+        .returns(ModernTreasury::Models::PingResponse)
+    end
+    def ping(request_options: {})
     end
 
+    # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers
     end
 
+    # Creates and returns a new client for interacting with the API.
     sig do
       params(
         base_url: T.nilable(String),
@@ -181,12 +153,16 @@ module ModernTreasury
         max_retry_delay: Float,
         idempotency_header: String
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(
+    def self.new(
+      # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
       base_url: nil,
+      # Defaults to `ENV["MODERN_TREASURY_API_KEY"]`
       api_key: ENV["MODERN_TREASURY_API_KEY"],
+      # Defaults to `ENV["MODERN_TREASURY_ORGANIZATION_ID"]`
       organization_id: ENV["MODERN_TREASURY_ORGANIZATION_ID"],
+      # Max number of retries to attempt after a failed retryable request.
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,

data/rbi/lib/modern_treasury/errors.rbi

@@ -3,8 +3,7 @@
 module ModernTreasury
   class Error < StandardError
     sig { returns(T.nilable(StandardError)) }
-    def cause
-    end
+    attr_accessor :cause
   end
 
   class ConversionError < ModernTreasury::Error
@@ -12,17 +11,15 @@ module ModernTreasury
 
   class APIError < ModernTreasury::Error
     sig { returns(URI::Generic) }
-    def url
-    end
+    attr_accessor :url
 
     sig { returns(T.nilable(Integer)) }
-    def status
-    end
+    attr_accessor :status
 
     sig { returns(T.nilable(T.anything)) }
-    def body
-    end
+    attr_accessor :body
 
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -32,21 +29,20 @@ module ModernTreasury
         response: NilClass,
         message: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+    def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
     end
   end
 
   class APIConnectionError < ModernTreasury::APIError
     sig { void }
-    def status
-    end
+    attr_accessor :status
 
     sig { void }
-    def body
-    end
+    attr_accessor :body
 
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -56,13 +52,14 @@ module ModernTreasury
         response: NilClass,
         message: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+    def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
     end
   end
 
   class APITimeoutError < ModernTreasury::APIConnectionError
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -72,30 +69,32 @@ module ModernTreasury
         response: NilClass,
         message: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+    def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
     end
   end
 
   class APIStatusError < ModernTreasury::APIError
+    # @api private
     sig do
       params(
         url: URI::Generic,
         status: Integer,
         body: T.nilable(Object),
         request: NilClass,
-        response: NilClass
+        response: NilClass,
+        message: T.nilable(String)
       )
         .returns(T.attached_class)
     end
-    def self.for(url:, status:, body:, request:, response:)
+    def self.for(url:, status:, body:, request:, response:, message: nil)
     end
 
     sig { returns(Integer) }
-    def status
-    end
+    attr_accessor :status
 
+    # @api private
     sig do
       params(
         url: URI::Generic,
@@ -105,9 +104,9 @@ module ModernTreasury
         response: NilClass,
         message: T.nilable(String)
       )
-        .void
+        .returns(T.attached_class)
     end
-    def initialize(url:, status:, body:, request:, response:, message: nil)
+    def self.new(url:, status:, body:, request:, response:, message: nil)
     end
   end
 

data/rbi/lib/modern_treasury/extern.rbi

@@ -1,7 +1,7 @@
 # typed: strong
 
 module ModernTreasury
+  # @api private
   module Extern
-    abstract!
   end
 end