modern_treasury 0.1.0.pre.alpha.21 → 0.1.0

data/rbi/modern_treasury/models/payment_order_list_params.rbi

@@ -59,6 +59,12 @@ module ModernTreasury
       sig { params(effective_date_start: Date).void }
       attr_writer :effective_date_start
 
+      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.
@@ -162,6 +168,7 @@ module ModernTreasury
           direction: ModernTreasury::TransactionDirection::OrSymbol,
           effective_date_end: Date,
           effective_date_start: Date,
+          external_id: String,
           metadata: T::Hash[Symbol, String],
           originating_account_id: String,
           per_page: Integer,
@@ -187,6 +194,7 @@ module ModernTreasury
         effective_date_end: nil,
         # An inclusive lower bound for searching effective_date
         effective_date_start: nil,
+        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.
@@ -221,6 +229,7 @@ module ModernTreasury
             direction: ModernTreasury::TransactionDirection::OrSymbol,
             effective_date_end: Date,
             effective_date_start: Date,
+            external_id: String,
             metadata: T::Hash[Symbol, String],
             originating_account_id: String,
             per_page: Integer,
@@ -337,6 +346,11 @@ module ModernTreasury
             :sent,
             ModernTreasury::PaymentOrderListParams::Status::TaggedSymbol
           )
+        STOPPED =
+          T.let(
+            :stopped,
+            ModernTreasury::PaymentOrderListParams::Status::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/modern_treasury/models/payment_order_update_params.rbi

@@ -14,17 +14,10 @@ module ModernTreasury
           )
         end
 
-      sig do
-        returns(T.nilable(ModernTreasury::PaymentOrderUpdateParams::Accounting))
-      end
+      sig { returns(T.nilable(ModernTreasury::Accounting)) }
       attr_reader :accounting
 
-      sig do
-        params(
-          accounting:
-            ModernTreasury::PaymentOrderUpdateParams::Accounting::OrHash
-        ).void
-      end
+      sig { params(accounting: ModernTreasury::Accounting::OrHash).void }
       attr_writer :accounting
 
       # The ID of one of your accounting categories. Note that these will only be
@@ -45,9 +38,9 @@ module ModernTreasury
       sig { params(amount: Integer).void }
       attr_writer :amount
 
-      # The party that will pay the fees for the payment order. Only applies to wire
-      # payment orders. Can be one of shared, sender, or receiver, which correspond
-      # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       sig do
         returns(
           T.nilable(
@@ -330,8 +323,7 @@ module ModernTreasury
 
       sig do
         params(
-          accounting:
-            ModernTreasury::PaymentOrderUpdateParams::Accounting::OrHash,
+          accounting: ModernTreasury::Accounting::OrHash,
           accounting_category_id: T.nilable(String),
           accounting_ledger_class_id: T.nilable(String),
           amount: Integer,
@@ -392,9 +384,9 @@ module ModernTreasury
         # Value in specified currency's smallest unit. e.g. $10 would be represented as
         # 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.
         amount: nil,
-        # The party that will pay the fees for the payment order. Only applies to wire
-        # payment orders. Can be one of shared, sender, or receiver, which correspond
-        # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+        # The party that will pay the fees for the payment order. See
+        # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+        # differences between the options.
         charge_bearer: nil,
         # Required when receiving_account_id is passed the ID of an external account.
         counterparty_id: nil,
@@ -511,7 +503,7 @@ module ModernTreasury
       sig do
         override.returns(
           {
-            accounting: ModernTreasury::PaymentOrderUpdateParams::Accounting,
+            accounting: ModernTreasury::Accounting,
             accounting_category_id: T.nilable(String),
             accounting_ledger_class_id: T.nilable(String),
             amount: Integer,
@@ -563,55 +555,9 @@ module ModernTreasury
       def to_hash
       end
 
-      class Accounting < ModernTreasury::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModernTreasury::PaymentOrderUpdateParams::Accounting,
-              ModernTreasury::Internal::AnyHash
-            )
-          end
-
-        # The ID of one of your accounting categories. Note that these will only be
-        # accessible if your accounting system has been connected.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :account_id
-
-        # The ID of one of the class objects in your accounting system. Class objects
-        # track segments of your business independent of client or project. Note that
-        # these will only be accessible if your accounting system has been connected.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :class_id
-
-        sig do
-          params(
-            account_id: T.nilable(String),
-            class_id: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The ID of one of your accounting categories. Note that these will only be
-          # accessible if your accounting system has been connected.
-          account_id: nil,
-          # The ID of one of the class objects in your accounting system. Class objects
-          # track segments of your business independent of client or project. Note that
-          # these will only be accessible if your accounting system has been connected.
-          class_id: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            { account_id: T.nilable(String), class_id: T.nilable(String) }
-          )
-        end
-        def to_hash
-        end
-      end
-
-      # The party that will pay the fees for the payment order. Only applies to wire
-      # payment orders. Can be one of shared, sender, or receiver, which correspond
-      # respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       module ChargeBearer
         extend ModernTreasury::Internal::Type::Enum
 
@@ -902,11 +848,7 @@ module ModernTreasury
 
         sig do
           returns(
-            T.nilable(
-              T::Array[
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail
-              ]
-            )
+            T.nilable(T::Array[ModernTreasury::ContactDetailCreateRequest])
           )
         end
         attr_reader :contact_details
@@ -914,31 +856,26 @@ module ModernTreasury
         sig do
           params(
             contact_details:
-              T::Array[
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::OrHash
-              ]
+              T::Array[ModernTreasury::ContactDetailCreateRequest::OrHash]
           ).void
         end
         attr_writer :contact_details
 
+        # An optional user-defined 180 character unique identifier.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_id
+
         # 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
-          returns(
-            T.nilable(
-              ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount
-            )
-          )
-        end
+        sig { returns(T.nilable(ModernTreasury::LedgerAccountCreateRequest)) }
         attr_reader :ledger_account
 
         sig do
           params(
-            ledger_account:
-              ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::OrHash
+            ledger_account: ModernTreasury::LedgerAccountCreateRequest::OrHash
           ).void
         end
         attr_writer :ledger_account
@@ -957,20 +894,11 @@ module ModernTreasury
         attr_accessor :name
 
         # Required if receiving wire payments.
-        sig do
-          returns(
-            T.nilable(
-              ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::PartyAddress
-            )
-          )
-        end
+        sig { returns(T.nilable(ModernTreasury::AddressRequest)) }
         attr_reader :party_address
 
         sig do
-          params(
-            party_address:
-              ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::PartyAddress::OrHash
-          ).void
+          params(party_address: ModernTreasury::AddressRequest::OrHash).void
         end
         attr_writer :party_address
 
@@ -1037,15 +965,12 @@ module ModernTreasury
               ],
             account_type: ModernTreasury::ExternalAccountType::OrSymbol,
             contact_details:
-              T::Array[
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::OrHash
-              ],
-            ledger_account:
-              ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::OrHash,
+              T::Array[ModernTreasury::ContactDetailCreateRequest::OrHash],
+            external_id: T.nilable(String),
+            ledger_account: ModernTreasury::LedgerAccountCreateRequest::OrHash,
             metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
-            party_address:
-              ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::PartyAddress::OrHash,
+            party_address: ModernTreasury::AddressRequest::OrHash,
             party_identifier: String,
             party_name: String,
             party_type:
@@ -1064,6 +989,8 @@ module ModernTreasury
           # Can be `checking`, `savings` or `other`.
           account_type: nil,
           contact_details: nil,
+          # An optional user-defined 180 character unique identifier.
+          external_id: nil,
           # 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
@@ -1099,15 +1026,12 @@ module ModernTreasury
                 ],
               account_type: ModernTreasury::ExternalAccountType::OrSymbol,
               contact_details:
-                T::Array[
-                  ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail
-                ],
-              ledger_account:
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount,
+                T::Array[ModernTreasury::ContactDetailCreateRequest],
+              external_id: T.nilable(String),
+              ledger_account: ModernTreasury::LedgerAccountCreateRequest,
               metadata: T::Hash[Symbol, String],
               name: T.nilable(String),
-              party_address:
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::PartyAddress,
+              party_address: ModernTreasury::AddressRequest,
               party_identifier: String,
               party_name: String,
               party_type:
@@ -1271,366 +1195,6 @@ module ModernTreasury
           end
         end
 
-        class ContactDetail < ModernTreasury::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::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::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType::OrSymbol
-              )
-            )
-          end
-          attr_reader :contact_identifier_type
-
-          sig do
-            params(
-              contact_identifier_type:
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType::OrSymbol
-            ).void
-          end
-          attr_writer :contact_identifier_type
-
-          sig do
-            params(
-              contact_identifier: String,
-              contact_identifier_type:
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::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::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType::OrSymbol
-              }
-            )
-          end
-          def to_hash
-          end
-
-          module ContactIdentifierType
-            extend ModernTreasury::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            EMAIL =
-              T.let(
-                :email,
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType::TaggedSymbol
-              )
-            PHONE_NUMBER =
-              T.let(
-                :phone_number,
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType::TaggedSymbol
-              )
-            WEBSITE =
-              T.let(
-                :website,
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::ContactDetail::ContactIdentifierType::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-
-        class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::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::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType::OrSymbol
-              )
-            )
-          end
-          attr_reader :ledgerable_type
-
-          sig do
-            params(
-              ledgerable_type:
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::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::PaymentOrderUpdateParams::ReceivingAccount::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::PaymentOrderUpdateParams::ReceivingAccount::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::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            COUNTERPARTY =
-              T.let(
-                :counterparty,
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType::TaggedSymbol
-              )
-            EXTERNAL_ACCOUNT =
-              T.let(
-                :external_account,
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType::TaggedSymbol
-              )
-            INTERNAL_ACCOUNT =
-              T.let(
-                :internal_account,
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType::TaggedSymbol
-              )
-            VIRTUAL_ACCOUNT =
-              T.let(
-                :virtual_account,
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::LedgerAccount::LedgerableType::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-
-        class PartyAddress < ModernTreasury::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::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
@@ -1795,6 +1359,11 @@ module ModernTreasury
                 :id_sknbi_code,
                 ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::RoutingDetail::RoutingNumberType::TaggedSymbol
               )
+            IL_BANK_CODE =
+              T.let(
+                :il_bank_code,
+                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::RoutingDetail::RoutingNumberType::TaggedSymbol
+              )
             IN_IFSC =
               T.let(
                 :in_ifsc,
@@ -2120,6 +1689,11 @@ module ModernTreasury
             :sent,
             ModernTreasury::PaymentOrderUpdateParams::Status::TaggedSymbol
           )
+        STOPPED =
+          T.let(
+            :stopped,
+            ModernTreasury::PaymentOrderUpdateParams::Status::TaggedSymbol
+          )
 
         sig do
           override.returns(