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

data/rbi/lib/modern_treasury/resources/connection_legal_entities.rbi

@@ -3,47 +3,72 @@
 module ModernTreasury
   module Resources
     class ConnectionLegalEntities
+      # Create a connection legal entity.
       sig do
         params(
           connection_id: String,
-          legal_entity: ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity,
+          legal_entity: T.any(
+            ModernTreasury::Models::ConnectionLegalEntityCreateParams::LegalEntity,
+            ModernTreasury::Util::AnyHash
+          ),
           legal_entity_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::ConnectionLegalEntity)
       end
-      def create(connection_id:, legal_entity: nil, legal_entity_id: nil, request_options: {})
+      def create(
+        # The ID of the connection.
+        connection_id:,
+        # The legal entity.
+        legal_entity: nil,
+        # The ID of the legal entity.
+        legal_entity_id: nil,
+        request_options: {}
+      )
       end
 
+      # Get details on a single connection legal entity.
       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::ConnectionLegalEntity)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The id of an existing connection legal entity.
+        id,
+        request_options: {}
+      )
       end
 
+      # Update a connection legal entity.
       sig do
         params(
           id: String,
-          status: Symbol,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          status: ModernTreasury::Models::ConnectionLegalEntityUpdateParams::Status::OrSymbol,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Models::ConnectionLegalEntity)
       end
-      def update(id, status: nil, request_options: {})
+      def update(
+        # The id of an existing connection legal entity.
+        id,
+        # The status of the connection legal entity.
+        status: nil,
+        request_options: {}
+      )
       end
 
+      # Get a list of all connection legal entities.
       sig do
         params(
           after_cursor: T.nilable(String),
           connection_id: String,
           legal_entity_id: String,
           per_page: Integer,
-          status: Symbol,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          status: ModernTreasury::Models::ConnectionLegalEntityListParams::Status::OrSymbol,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Page[ModernTreasury::Models::ConnectionLegalEntity])
       end
@@ -57,8 +82,8 @@ module ModernTreasury
       )
       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/connections.rbi

@@ -3,21 +3,30 @@
 module ModernTreasury
   module Resources
     class Connections
+      # Get a list of all connections.
       sig do
         params(
           after_cursor: T.nilable(String),
           entity: String,
           per_page: Integer,
           vendor_customer_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::Connection])
       end
-      def list(after_cursor: nil, entity: nil, per_page: nil, vendor_customer_id: nil, request_options: {})
+      def list(
+        after_cursor: nil,
+        # A string code representing the vendor (i.e. bank).
+        entity: nil,
+        per_page: nil,
+        # An identifier assigned by the vendor to your organization.
+        vendor_customer_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/counterparties.rbi

@@ -3,49 +3,68 @@
 module ModernTreasury
   module Resources
     class Counterparties
+      # Create a new counterparty.
       sig do
         params(
           name: T.nilable(String),
-          accounting: ModernTreasury::Models::CounterpartyCreateParams::Accounting,
-          accounts: T::Array[ModernTreasury::Models::CounterpartyCreateParams::Account],
+          accounting: T.any(ModernTreasury::Models::CounterpartyCreateParams::Accounting, ModernTreasury::Util::AnyHash),
+          accounts: T::Array[T.any(ModernTreasury::Models::CounterpartyCreateParams::Account, ModernTreasury::Util::AnyHash)],
           email: T.nilable(String),
-          ledger_type: Symbol,
-          legal_entity: ModernTreasury::Models::CounterpartyCreateParams::LegalEntity,
+          ledger_type: ModernTreasury::Models::CounterpartyCreateParams::LedgerType::OrSymbol,
+          legal_entity: T.any(ModernTreasury::Models::CounterpartyCreateParams::LegalEntity, ModernTreasury::Util::AnyHash),
           legal_entity_id: T.nilable(String),
           metadata: T::Hash[Symbol, String],
           send_remittance_advice: T::Boolean,
           taxpayer_identifier: String,
-          verification_status: Symbol,
-          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, T::Hash[Symbol, T.anything]))
+          verification_status: ModernTreasury::Models::CounterpartyCreateParams::VerificationStatus::OrSymbol,
+          request_options: T.nilable(T.any(ModernTreasury::RequestOptions, ModernTreasury::Util::AnyHash))
         )
           .returns(ModernTreasury::Models::Counterparty)
       end
       def create(
+        # A human friendly name for this counterparty.
         name:,
         accounting: nil,
+        # The accounts for this counterparty.
         accounts: nil,
+        # The counterparty's email.
         email: nil,
+        # An optional type to auto-sync the counterparty to your ledger. Either `customer`
+        #   or `vendor`.
         ledger_type: nil,
         legal_entity: nil,
+        # The id of the legal entity.
         legal_entity_id: nil,
+        # Additional data represented as key-value pairs. Both the key and value must be
+        #   strings.
         metadata: nil,
+        # Send an email to the counterparty whenever an associated payment order is sent
+        #   to the bank.
         send_remittance_advice: nil,
+        # Either a valid SSN or EIN.
         taxpayer_identifier: nil,
+        # The verification status of the counterparty.
         verification_status: nil,
         request_options: {}
       )
       end
 
+      # Get details on a single counterparty.
       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::Counterparty)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The id of an existing counterparty.
+        id,
+        request_options: {}
+      )
       end
 
+      # Updates a given counterparty with new information.
       sig do
         params(
           id: String,
@@ -55,22 +74,32 @@ module ModernTreasury
           name: String,
           send_remittance_advice: T::Boolean,
           taxpayer_identifier: 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::Counterparty)
       end
       def update(
+        # The id of an existing counterparty.
         id,
+        # A new email for the counterparty.
         email: nil,
+        # The id of the legal entity.
         legal_entity_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,
+        # A new name for the counterparty. Will only update if passed.
         name: nil,
+        # If this is `true`, Modern Treasury will send an email to the counterparty
+        #   whenever an associated payment order is sent to the bank.
         send_remittance_advice: nil,
+        # Either a valid SSN or EIN.
         taxpayer_identifier: nil,
         request_options: {}
       )
       end
 
+      # Get a paginated list of all counterparties.
       sig do
         params(
           after_cursor: T.nilable(String),
@@ -81,56 +110,88 @@ module ModernTreasury
           metadata: T::Hash[Symbol, String],
           name: 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::Counterparty])
       end
       def list(
         after_cursor: nil,
+        # Used to return counterparties created after some datetime.
         created_at_lower_bound: nil,
+        # Used to return counterparties created before some datetime.
         created_at_upper_bound: nil,
+        # Performs a partial string match of the email field. This is also case
+        #   insensitive.
         email: nil,
+        # Filters for counterparties with the given legal entity ID.
         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,
+        # Performs a partial string match of the name field. This is also case
+        #   insensitive.
         name: nil,
         per_page: nil,
         request_options: {}
       )
       end
 
+      # Deletes a given counterparty.
       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))
         )
           .void
       end
-      def delete(id, request_options: {})
+      def delete(
+        # The id of an existing counterparty.
+        id,
+        request_options: {}
+      )
       end
 
+      # Send an email requesting account details.
       sig do
         params(
           id: String,
-          direction: Symbol,
+          direction: ModernTreasury::Models::TransactionDirection::OrSymbol,
           custom_redirect: String,
-          fields: T::Array[Symbol],
+          fields: T::Array[ModernTreasury::Models::CounterpartyCollectAccountParams::Field::OrSymbol],
           send_email: T::Boolean,
-          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::CounterpartyCollectAccountResponse)
       end
       def collect_account(
+        # counterparty id
         id,
+        # One of `credit` or `debit`. Use `credit` when you want to pay a counterparty.
+        #   Use `debit` when you need to charge a counterparty. This field helps us send a
+        #   more tailored email to your counterparties."
         direction:,
+        # The URL you want your customer to visit upon filling out the form. By default,
+        #   they will be sent to a Modern Treasury landing page. This must be a valid HTTPS
+        #   URL if set.
         custom_redirect: nil,
+        # The list of fields you want on the form. This field is optional and if it is not
+        #   set, will default to [\"nameOnAccount\", \"accountType\", \"accountNumber\",
+        #   \"routingNumber\", \"address\"]. The full list of options is [\"name\",
+        #   \"nameOnAccount\", \"taxpayerIdentifier\", \"accountType\", \"accountNumber\",
+        #   \"routingNumber\", \"address\", \"ibanNumber\", \"swiftCode\"].
         fields: nil,
+        # By default, Modern Treasury will send an email to your counterparty that
+        #   includes a link to the form they must fill out. However, if you would like to
+        #   send the counterparty the link, you can set this parameter to `false`. The JSON
+        #   body will include the link to the secure Modern Treasury form.
         send_email: 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/documents.rbi

@@ -3,50 +3,69 @@
 module ModernTreasury
   module Resources
     class Documents
+      # Create a document.
       sig do
         params(
           documentable_id: String,
-          documentable_type: Symbol,
+          documentable_type: ModernTreasury::Models::DocumentCreateParams::DocumentableType::OrSymbol,
           file: T.any(IO, StringIO),
           document_type: 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::Document)
       end
-      def create(documentable_id:, documentable_type:, file:, document_type: nil, request_options: {})
+      def create(
+        # The unique identifier for the associated object.
+        documentable_id:,
+        documentable_type:,
+        file:,
+        # A category given to the document, can be `null`.
+        document_type: nil,
+        request_options: {}
+      )
       end
 
+      # Get an existing document.
       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::Document)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # The ID of the document.
+        id,
+        request_options: {}
+      )
       end
 
+      # Get a list of documents.
       sig do
         params(
           after_cursor: T.nilable(String),
           documentable_id: String,
-          documentable_type: Symbol,
+          documentable_type: ModernTreasury::Models::DocumentListParams::DocumentableType::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::Document])
       end
       def list(
         after_cursor: nil,
+        # The unique identifier for the associated object.
         documentable_id: nil,
+        # The type of the associated object. Currently can be one of `payment_order`,
+        #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
+        #   `case`, `internal_account`, `decision`, or `external_account`.
         documentable_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/events.rbi

@@ -3,16 +3,22 @@
 module ModernTreasury
   module Resources
     class Events
+      # get event
       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::Event)
       end
-      def retrieve(id, request_options: {})
+      def retrieve(
+        # event id
+        id,
+        request_options: {}
+      )
       end
 
+      # list events
       sig do
         params(
           after_cursor: T.nilable(String),
@@ -22,7 +28,7 @@ module ModernTreasury
           event_time_start: Time,
           per_page: Integer,
           resource: 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::Event])
       end
@@ -30,7 +36,9 @@ module ModernTreasury
         after_cursor: nil,
         entity_id: nil,
         event_name: nil,
+        # An inclusive upper bound for when the event occurred
         event_time_end: nil,
+        # An inclusive lower bound for when the event occurred
         event_time_start: nil,
         per_page: nil,
         resource: nil,
@@ -38,8 +46,8 @@ module ModernTreasury
       )
       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