modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/rbi/modern_treasury/models/external_account_create_params.rbi

@@ -17,6 +17,10 @@ module ModernTreasury
       sig { returns(T.nilable(String)) }
       attr_accessor :counterparty_id
 
+      # An optional user-defined 180 character unique identifier.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :body_external_id
+
       sig do
         returns(
           T.nilable(
@@ -46,20 +50,14 @@ module ModernTreasury
       attr_writer :account_type
 
       sig do
-        returns(
-          T.nilable(
-            T::Array[ModernTreasury::ExternalAccountCreateParams::ContactDetail]
-          )
-        )
+        returns(T.nilable(T::Array[ModernTreasury::ContactDetailCreateRequest]))
       end
       attr_reader :contact_details
 
       sig do
         params(
           contact_details:
-            T::Array[
-              ModernTreasury::ExternalAccountCreateParams::ContactDetail::OrHash
-            ]
+            T::Array[ModernTreasury::ContactDetailCreateRequest::OrHash]
         ).void
       end
       attr_writer :contact_details
@@ -69,17 +67,12 @@ module ModernTreasury
       # auto-ledgering Payment objects. See
       # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
       # for more details.
-      sig do
-        returns(
-          T.nilable(ModernTreasury::ExternalAccountCreateParams::LedgerAccount)
-        )
-      end
+      sig { returns(T.nilable(ModernTreasury::LedgerAccountCreateRequest)) }
       attr_reader :ledger_account
 
       sig do
         params(
-          ledger_account:
-            ModernTreasury::ExternalAccountCreateParams::LedgerAccount::OrHash
+          ledger_account: ModernTreasury::LedgerAccountCreateRequest::OrHash
         ).void
       end
       attr_writer :ledger_account
@@ -98,19 +91,10 @@ module ModernTreasury
       attr_accessor :name
 
       # Required if receiving wire payments.
-      sig do
-        returns(
-          T.nilable(ModernTreasury::ExternalAccountCreateParams::PartyAddress)
-        )
-      end
+      sig { returns(T.nilable(ModernTreasury::AddressRequest)) }
       attr_reader :party_address
 
-      sig do
-        params(
-          party_address:
-            ModernTreasury::ExternalAccountCreateParams::PartyAddress::OrHash
-        ).void
-      end
+      sig { params(party_address: ModernTreasury::AddressRequest::OrHash).void }
       attr_writer :party_address
 
       sig { returns(T.nilable(String)) }
@@ -166,21 +150,18 @@ module ModernTreasury
       sig do
         params(
           counterparty_id: T.nilable(String),
+          body_external_id: T.nilable(String),
           account_details:
             T::Array[
               ModernTreasury::ExternalAccountCreateParams::AccountDetail::OrHash
             ],
           account_type: ModernTreasury::ExternalAccountType::OrSymbol,
           contact_details:
-            T::Array[
-              ModernTreasury::ExternalAccountCreateParams::ContactDetail::OrHash
-            ],
-          ledger_account:
-            ModernTreasury::ExternalAccountCreateParams::LedgerAccount::OrHash,
+            T::Array[ModernTreasury::ContactDetailCreateRequest::OrHash],
+          ledger_account: ModernTreasury::LedgerAccountCreateRequest::OrHash,
           metadata: T::Hash[Symbol, String],
           name: T.nilable(String),
-          party_address:
-            ModernTreasury::ExternalAccountCreateParams::PartyAddress::OrHash,
+          party_address: ModernTreasury::AddressRequest::OrHash,
           party_identifier: String,
           party_name: String,
           party_type:
@@ -197,6 +178,8 @@ module ModernTreasury
       end
       def self.new(
         counterparty_id:,
+        # An optional user-defined 180 character unique identifier.
+        body_external_id: nil,
         account_details: nil,
         # Can be `checking`, `savings` or `other`.
         account_type: nil,
@@ -232,21 +215,18 @@ module ModernTreasury
         override.returns(
           {
             counterparty_id: T.nilable(String),
+            body_external_id: T.nilable(String),
             account_details:
               T::Array[
                 ModernTreasury::ExternalAccountCreateParams::AccountDetail
               ],
             account_type: ModernTreasury::ExternalAccountType::OrSymbol,
             contact_details:
-              T::Array[
-                ModernTreasury::ExternalAccountCreateParams::ContactDetail
-              ],
-            ledger_account:
-              ModernTreasury::ExternalAccountCreateParams::LedgerAccount,
+              T::Array[ModernTreasury::ContactDetailCreateRequest],
+            ledger_account: ModernTreasury::LedgerAccountCreateRequest,
             metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
-            party_address:
-              ModernTreasury::ExternalAccountCreateParams::PartyAddress,
+            party_address: ModernTreasury::AddressRequest,
             party_identifier: String,
             party_name: String,
             party_type:
@@ -411,366 +391,6 @@ module ModernTreasury
         end
       end
 
-      class ContactDetail < ModernTreasury::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModernTreasury::ExternalAccountCreateParams::ContactDetail,
-              ModernTreasury::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :contact_identifier
-
-        sig { params(contact_identifier: String).void }
-        attr_writer :contact_identifier
-
-        sig do
-          returns(
-            T.nilable(
-              ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType::OrSymbol
-            )
-          )
-        end
-        attr_reader :contact_identifier_type
-
-        sig do
-          params(
-            contact_identifier_type:
-              ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType::OrSymbol
-          ).void
-        end
-        attr_writer :contact_identifier_type
-
-        sig do
-          params(
-            contact_identifier: String,
-            contact_identifier_type:
-              ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(contact_identifier: nil, contact_identifier_type: nil)
-        end
-
-        sig do
-          override.returns(
-            {
-              contact_identifier: String,
-              contact_identifier_type:
-                ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType::OrSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module ContactIdentifierType
-          extend ModernTreasury::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          EMAIL =
-            T.let(
-              :email,
-              ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType::TaggedSymbol
-            )
-          PHONE_NUMBER =
-            T.let(
-              :phone_number,
-              ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType::TaggedSymbol
-            )
-          WEBSITE =
-            T.let(
-              :website,
-              ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ModernTreasury::ExternalAccountCreateParams::ContactDetail::ContactIdentifierType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
-      class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModernTreasury::ExternalAccountCreateParams::LedgerAccount,
-              ModernTreasury::Internal::AnyHash
-            )
-          end
-
-        # The currency of the ledger account.
-        sig { returns(String) }
-        attr_accessor :currency
-
-        # The id of the ledger that this account belongs to.
-        sig { returns(String) }
-        attr_accessor :ledger_id
-
-        # The name of the ledger account.
-        sig { returns(String) }
-        attr_accessor :name
-
-        # The normal balance of the ledger account.
-        sig { returns(ModernTreasury::TransactionDirection::OrSymbol) }
-        attr_accessor :normal_balance
-
-        # The currency exponent of the ledger account.
-        sig { returns(T.nilable(Integer)) }
-        attr_accessor :currency_exponent
-
-        # The description of the ledger account.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :description
-
-        # The array of ledger account category ids that this ledger account should be a
-        # child of.
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_reader :ledger_account_category_ids
-
-        sig { params(ledger_account_category_ids: T::Array[String]).void }
-        attr_writer :ledger_account_category_ids
-
-        # If the ledger account links to another object in Modern Treasury, the id will be
-        # populated here, otherwise null.
-        sig { returns(T.nilable(String)) }
-        attr_reader :ledgerable_id
-
-        sig { params(ledgerable_id: String).void }
-        attr_writer :ledgerable_id
-
-        # If the ledger account links to another object in Modern Treasury, the type will
-        # be populated here, otherwise null. The value is one of internal_account or
-        # external_account.
-        sig do
-          returns(
-            T.nilable(
-              ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType::OrSymbol
-            )
-          )
-        end
-        attr_reader :ledgerable_type
-
-        sig do
-          params(
-            ledgerable_type:
-              ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType::OrSymbol
-          ).void
-        end
-        attr_writer :ledgerable_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
-
-        # Specifies a ledger account object that will be created with the external
-        # account. The resulting ledger account is linked to the external account for
-        # auto-ledgering Payment objects. See
-        # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
-        # for more details.
-        sig do
-          params(
-            currency: String,
-            ledger_id: String,
-            name: String,
-            normal_balance: ModernTreasury::TransactionDirection::OrSymbol,
-            currency_exponent: T.nilable(Integer),
-            description: T.nilable(String),
-            ledger_account_category_ids: T::Array[String],
-            ledgerable_id: String,
-            ledgerable_type:
-              ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType::OrSymbol,
-            metadata: T::Hash[Symbol, String]
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The currency of the ledger account.
-          currency:,
-          # The id of the ledger that this account belongs to.
-          ledger_id:,
-          # The name of the ledger account.
-          name:,
-          # The normal balance of the ledger account.
-          normal_balance:,
-          # The currency exponent of the ledger account.
-          currency_exponent: nil,
-          # The description of the ledger account.
-          description: nil,
-          # The array of ledger account category ids that this ledger account should be a
-          # child of.
-          ledger_account_category_ids: nil,
-          # If the ledger account links to another object in Modern Treasury, the id will be
-          # populated here, otherwise null.
-          ledgerable_id: nil,
-          # If the ledger account links to another object in Modern Treasury, the type will
-          # be populated here, otherwise null. The value is one of internal_account or
-          # external_account.
-          ledgerable_type: nil,
-          # Additional data represented as key-value pairs. Both the key and value must be
-          # strings.
-          metadata: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              currency: String,
-              ledger_id: String,
-              name: String,
-              normal_balance: ModernTreasury::TransactionDirection::OrSymbol,
-              currency_exponent: T.nilable(Integer),
-              description: T.nilable(String),
-              ledger_account_category_ids: T::Array[String],
-              ledgerable_id: String,
-              ledgerable_type:
-                ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType::OrSymbol,
-              metadata: T::Hash[Symbol, String]
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # If the ledger account links to another object in Modern Treasury, the type will
-        # be populated here, otherwise null. The value is one of internal_account or
-        # external_account.
-        module LedgerableType
-          extend ModernTreasury::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          COUNTERPARTY =
-            T.let(
-              :counterparty,
-              ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType::TaggedSymbol
-            )
-          EXTERNAL_ACCOUNT =
-            T.let(
-              :external_account,
-              ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType::TaggedSymbol
-            )
-          INTERNAL_ACCOUNT =
-            T.let(
-              :internal_account,
-              ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType::TaggedSymbol
-            )
-          VIRTUAL_ACCOUNT =
-            T.let(
-              :virtual_account,
-              ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ModernTreasury::ExternalAccountCreateParams::LedgerAccount::LedgerableType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
-      class PartyAddress < ModernTreasury::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModernTreasury::ExternalAccountCreateParams::PartyAddress,
-              ModernTreasury::Internal::AnyHash
-            )
-          end
-
-        # Country code conforms to [ISO 3166-1 alpha-2]
-        sig { returns(T.nilable(String)) }
-        attr_accessor :country
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :line1
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :line2
-
-        # Locality or City.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :locality
-
-        # The postal code of the address.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :postal_code
-
-        # Region or State.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :region
-
-        # Required if receiving wire payments.
-        sig do
-          params(
-            country: T.nilable(String),
-            line1: T.nilable(String),
-            line2: T.nilable(String),
-            locality: T.nilable(String),
-            postal_code: T.nilable(String),
-            region: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Country code conforms to [ISO 3166-1 alpha-2]
-          country: nil,
-          line1: nil,
-          line2: nil,
-          # Locality or City.
-          locality: nil,
-          # The postal code of the address.
-          postal_code: nil,
-          # Region or State.
-          region: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              country: T.nilable(String),
-              line1: T.nilable(String),
-              line2: T.nilable(String),
-              locality: T.nilable(String),
-              postal_code: T.nilable(String),
-              region: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
       # Either `individual` or `business`.
       module PartyType
         extend ModernTreasury::Internal::Type::Enum

data/rbi/modern_treasury/models/external_account_list_params.rbi

@@ -23,6 +23,13 @@ module ModernTreasury
       sig { params(counterparty_id: String).void }
       attr_writer :counterparty_id
 
+      # An optional user-defined 180 character unique identifier.
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_id
+
+      sig { params(external_id: String).void }
+      attr_writer :external_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.
@@ -49,6 +56,7 @@ module ModernTreasury
         params(
           after_cursor: T.nilable(String),
           counterparty_id: String,
+          external_id: String,
           metadata: T::Hash[Symbol, String],
           party_name: String,
           per_page: Integer,
@@ -58,6 +66,8 @@ module ModernTreasury
       def self.new(
         after_cursor: nil,
         counterparty_id: nil,
+        # An optional user-defined 180 character unique identifier.
+        external_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.
@@ -74,6 +84,7 @@ module ModernTreasury
           {
             after_cursor: T.nilable(String),
             counterparty_id: String,
+            external_id: String,
             metadata: T::Hash[Symbol, String],
             party_name: String,
             per_page: Integer,

data/rbi/modern_treasury/models/external_account_update_params.rbi

@@ -39,19 +39,10 @@ module ModernTreasury
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
-      sig do
-        returns(
-          T.nilable(ModernTreasury::ExternalAccountUpdateParams::PartyAddress)
-        )
-      end
+      sig { returns(T.nilable(ModernTreasury::AddressRequest)) }
       attr_reader :party_address
 
-      sig do
-        params(
-          party_address:
-            ModernTreasury::ExternalAccountUpdateParams::PartyAddress::OrHash
-        ).void
-      end
+      sig { params(party_address: ModernTreasury::AddressRequest::OrHash).void }
       attr_writer :party_address
 
       # If this value isn't provided, it will be inherited from the counterparty's name.
@@ -77,8 +68,7 @@ module ModernTreasury
           counterparty_id: T.nilable(String),
           metadata: T::Hash[Symbol, String],
           name: T.nilable(String),
-          party_address:
-            ModernTreasury::ExternalAccountUpdateParams::PartyAddress::OrHash,
+          party_address: ModernTreasury::AddressRequest::OrHash,
           party_name: String,
           party_type:
             T.nilable(
@@ -113,8 +103,7 @@ module ModernTreasury
             counterparty_id: T.nilable(String),
             metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
-            party_address:
-              ModernTreasury::ExternalAccountUpdateParams::PartyAddress,
+            party_address: ModernTreasury::AddressRequest,
             party_name: String,
             party_type:
               T.nilable(
@@ -127,77 +116,6 @@ module ModernTreasury
       def to_hash
       end
 
-      class PartyAddress < ModernTreasury::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModernTreasury::ExternalAccountUpdateParams::PartyAddress,
-              ModernTreasury::Internal::AnyHash
-            )
-          end
-
-        # Country code conforms to [ISO 3166-1 alpha-2]
-        sig { returns(T.nilable(String)) }
-        attr_accessor :country
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :line1
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :line2
-
-        # Locality or City.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :locality
-
-        # The postal code of the address.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :postal_code
-
-        # Region or State.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :region
-
-        sig do
-          params(
-            country: T.nilable(String),
-            line1: T.nilable(String),
-            line2: T.nilable(String),
-            locality: T.nilable(String),
-            postal_code: T.nilable(String),
-            region: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Country code conforms to [ISO 3166-1 alpha-2]
-          country: nil,
-          line1: nil,
-          line2: nil,
-          # Locality or City.
-          locality: nil,
-          # The postal code of the address.
-          postal_code: nil,
-          # Region or State.
-          region: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              country: T.nilable(String),
-              line1: T.nilable(String),
-              line2: T.nilable(String),
-              locality: T.nilable(String),
-              postal_code: T.nilable(String),
-              region: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
       # Either `individual` or `business`.
       module PartyType
         extend ModernTreasury::Internal::Type::Enum