modern_treasury 0.11.0 → 0.12.0

data/rbi/modern_treasury/models/payment_order.rbi

@@ -1185,6 +1185,11 @@ module ModernTreasury
               :bankprov_payment_id,
               ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          BLOCKCHAIN_TRANSACTION_HASH =
+            T.let(
+              :blockchain_transaction_hash,
+              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           BNK_DEV_PRENOTIFICATION_ID =
             T.let(
               :bnk_dev_prenotification_id,
@@ -1430,6 +1435,11 @@ module ModernTreasury
               :lob_check_id,
               ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          MT_FLOW_ACH_NOC_ID =
+            T.let(
+              :mt_flow_ach_noc_id,
+              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           MT_FLOW_TRANSFER_ID =
             T.let(
               :mt_flow_transfer_id,
@@ -1445,6 +1455,16 @@ module ModernTreasury
               :partial_swift_mir,
               ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          PAXOS_ORCHESTRATION_ID =
+            T.let(
+              :paxos_orchestration_id,
+              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          PAXOS_TRANSFER_ID =
+            T.let(
+              :paxos_transfer_id,
+              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           PNC_CLEARING_REFERENCE =
             T.let(
               :pnc_clearing_reference,

data/rbi/modern_treasury/models/payment_reference.rbi

@@ -140,6 +140,11 @@ module ModernTreasury
             :bankprov_payment_id,
             ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
           )
+        BLOCKCHAIN_TRANSACTION_HASH =
+          T.let(
+            :blockchain_transaction_hash,
+            ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
+          )
         BNK_DEV_PRENOTIFICATION_ID =
           T.let(
             :bnk_dev_prenotification_id,
@@ -385,6 +390,11 @@ module ModernTreasury
             :lob_check_id,
             ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
           )
+        MT_FLOW_ACH_NOC_ID =
+          T.let(
+            :mt_flow_ach_noc_id,
+            ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
+          )
         MT_FLOW_TRANSFER_ID =
           T.let(
             :mt_flow_transfer_id,
@@ -400,6 +410,16 @@ module ModernTreasury
             :partial_swift_mir,
             ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
           )
+        PAXOS_ORCHESTRATION_ID =
+          T.let(
+            :paxos_orchestration_id,
+            ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
+          )
+        PAXOS_TRANSFER_ID =
+          T.let(
+            :paxos_transfer_id,
+            ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
+          )
         PNC_CLEARING_REFERENCE =
           T.let(
             :pnc_clearing_reference,

data/rbi/modern_treasury/models/return_object.rbi

@@ -652,6 +652,11 @@ module ModernTreasury
               :bankprov_payment_id,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          BLOCKCHAIN_TRANSACTION_HASH =
+            T.let(
+              :blockchain_transaction_hash,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           BNK_DEV_PRENOTIFICATION_ID =
             T.let(
               :bnk_dev_prenotification_id,
@@ -897,6 +902,11 @@ module ModernTreasury
               :lob_check_id,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          MT_FLOW_ACH_NOC_ID =
+            T.let(
+              :mt_flow_ach_noc_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           MT_FLOW_TRANSFER_ID =
             T.let(
               :mt_flow_transfer_id,
@@ -912,6 +922,16 @@ module ModernTreasury
               :partial_swift_mir,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          PAXOS_ORCHESTRATION_ID =
+            T.let(
+              :paxos_orchestration_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          PAXOS_TRANSFER_ID =
+            T.let(
+              :paxos_transfer_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           PNC_CLEARING_REFERENCE =
             T.let(
               :pnc_clearing_reference,
@@ -1194,6 +1214,8 @@ module ModernTreasury
           T.let(:manual, ModernTreasury::ReturnObject::Type::TaggedSymbol)
         SEPA = T.let(:sepa, ModernTreasury::ReturnObject::Type::TaggedSymbol)
         WIRE = T.let(:wire, ModernTreasury::ReturnObject::Type::TaggedSymbol)
+        ZENGIN =
+          T.let(:zengin, ModernTreasury::ReturnObject::Type::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/modern_treasury/models/transaction.rbi

@@ -449,6 +449,11 @@ module ModernTreasury
           )
         MX =
           T.let(:mx, ModernTreasury::Transaction::VendorCodeType::TaggedSymbol)
+        PAXOS =
+          T.let(
+            :paxos,
+            ModernTreasury::Transaction::VendorCodeType::TaggedSymbol
+          )
         PAYPAL =
           T.let(
             :paypal,

data/rbi/modern_treasury/models.rbi

@@ -50,6 +50,8 @@ module ModernTreasury
 
   BulkResultRetrieveParams = ModernTreasury::Models::BulkResultRetrieveParams
 
+  ChildLegalEntity = ModernTreasury::Models::ChildLegalEntity
+
   ChildLegalEntityCreate = ModernTreasury::Models::ChildLegalEntityCreate
 
   ClientPingParams = ModernTreasury::Models::ClientPingParams
@@ -386,6 +388,9 @@ module ModernTreasury
   LegalEntityAssociationCreateParams =
     ModernTreasury::Models::LegalEntityAssociationCreateParams
 
+  LegalEntityAssociationInlineCreate =
+    ModernTreasury::Models::LegalEntityAssociationInlineCreate
+
   LegalEntityBankSettings = ModernTreasury::Models::LegalEntityBankSettings
 
   LegalEntityComplianceDetail =

data/rbi/modern_treasury/resources/expected_payments.rbi

@@ -7,6 +7,16 @@ module ModernTreasury
       sig do
         params(
           amount_lower_bound: T.nilable(Integer),
+          amount_reconciled: T.nilable(Integer),
+          amount_reconciled_direction:
+            T.nilable(
+              ModernTreasury::ExpectedPaymentCreateParams::AmountReconciledDirection::OrSymbol
+            ),
+          amount_unreconciled: T.nilable(Integer),
+          amount_unreconciled_direction:
+            T.nilable(
+              ModernTreasury::ExpectedPaymentCreateParams::AmountUnreconciledDirection::OrSymbol
+            ),
           amount_upper_bound: T.nilable(Integer),
           counterparty_id: T.nilable(String),
           currency: T.nilable(ModernTreasury::Currency::OrSymbol),
@@ -41,6 +51,18 @@ module ModernTreasury
         # The lowest amount this expected payment may be equal to. Value in specified
         # currency's smallest unit. e.g. $10 would be represented as 1000.
         amount_lower_bound: nil,
+        # The amount reconciled for this expected payment. Value in specified currency's
+        # smallest unit. e.g. $10 would be represented as 1000.
+        amount_reconciled: nil,
+        # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+        # amount.
+        amount_reconciled_direction: nil,
+        # The amount that remains unreconciled for this expected payment. Value in
+        # specified currency's smallest unit. e.g. $10 would be represented as 1000.
+        amount_unreconciled: nil,
+        # One of credit or debit. Indicates whether amount_unreconciled is a credit or
+        # debit amount.
+        amount_unreconciled_direction: nil,
         # The highest amount this expected payment may be equal to. Value in specified
         # currency's smallest unit. e.g. $10 would be represented as 1000.
         amount_upper_bound: nil,
@@ -116,6 +138,16 @@ module ModernTreasury
         params(
           id: String,
           amount_lower_bound: T.nilable(Integer),
+          amount_reconciled: T.nilable(Integer),
+          amount_reconciled_direction:
+            T.nilable(
+              ModernTreasury::ExpectedPaymentUpdateParams::AmountReconciledDirection::OrSymbol
+            ),
+          amount_unreconciled: T.nilable(Integer),
+          amount_unreconciled_direction:
+            T.nilable(
+              ModernTreasury::ExpectedPaymentUpdateParams::AmountUnreconciledDirection::OrSymbol
+            ),
           amount_upper_bound: T.nilable(Integer),
           counterparty_id: T.nilable(String),
           currency: T.nilable(ModernTreasury::Currency::OrSymbol),
@@ -149,6 +181,18 @@ module ModernTreasury
         # The lowest amount this expected payment may be equal to. Value in specified
         # currency's smallest unit. e.g. $10 would be represented as 1000.
         amount_lower_bound: nil,
+        # The amount reconciled for this expected payment. Value in specified currency's
+        # smallest unit. e.g. $10 would be represented as 1000.
+        amount_reconciled: nil,
+        # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+        # amount.
+        amount_reconciled_direction: nil,
+        # The amount that remains unreconciled for this expected payment. Value in
+        # specified currency's smallest unit. e.g. $10 would be represented as 1000.
+        amount_unreconciled: nil,
+        # One of credit or debit. Indicates whether amount_unreconciled is a credit or
+        # debit amount.
+        amount_unreconciled_direction: nil,
         # The highest amount this expected payment may be equal to. Value in specified
         # currency's smallest unit. e.g. $10 would be represented as 1000.
         amount_upper_bound: nil,

data/rbi/modern_treasury/resources/internal_accounts.rbi

@@ -80,6 +80,7 @@ module ModernTreasury
       sig do
         params(
           id: String,
+          contra_ledger_account_id: String,
           counterparty_id: String,
           ledger_account_id: String,
           metadata: T::Hash[Symbol, String],
@@ -91,6 +92,8 @@ module ModernTreasury
       def update(
         # Unique identifier for the account.
         id,
+        # The Contra Ledger Account associated to this account.
+        contra_ledger_account_id: nil,
         # The Counterparty associated to this account.
         counterparty_id: nil,
         # The Ledger Account associated to this account.

data/rbi/modern_treasury/resources/invoices.rbi

@@ -25,7 +25,6 @@ module ModernTreasury
           currency: ModernTreasury::Currency::OrSymbol,
           description: String,
           fallback_payment_method: T.nilable(String),
-          ingest_ledger_entries: T.nilable(T::Boolean),
           invoice_line_items:
             T.nilable(
               T::Array[
@@ -36,7 +35,6 @@ module ModernTreasury
             T.nilable(
               ModernTreasury::InvoiceCreateParams::InvoicerAddress::OrHash
             ),
-          ledger_account_settlement_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, String]),
           notification_email_addresses: T.nilable(T::Array[String]),
           notifications_enabled: T::Boolean,
@@ -76,18 +74,12 @@ module ModernTreasury
         # When payment_method is automatic, the fallback payment method to use when an
         # automatic payment fails. One of `manual` or `ui`.
         fallback_payment_method: nil,
-        # Whether to ingest the ledger_entries to populate the invoice line items. If this
-        # is false, then a line item must be provided. If this is true, line_items must be
-        # empty. Ignored if ledger_account_settlement_id is empty.
-        ingest_ledger_entries: nil,
         # An array of invoice line items. The API supports a maximum of 50 invoice line
         # items per invoice. If a greater number of invoice line items is required, please
         # contact support.
         invoice_line_items: nil,
         # The invoice issuer's business address.
         invoicer_address: nil,
-        # The ID of the virtual account the invoice should be paid to.
-        ledger_account_settlement_id: nil,
         # Additional data represented as key-value pairs. Both the key and value must be
         # strings.
         metadata: nil,
@@ -162,7 +154,6 @@ module ModernTreasury
           description: String,
           due_date: Time,
           fallback_payment_method: T.nilable(String),
-          ingest_ledger_entries: T.nilable(T::Boolean),
           invoice_line_items:
             T.nilable(
               T::Array[
@@ -173,7 +164,6 @@ module ModernTreasury
             T.nilable(
               ModernTreasury::InvoiceUpdateParams::InvoicerAddress::OrHash
             ),
-          ledger_account_settlement_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, String]),
           notification_email_addresses: T.nilable(T::Array[String]),
           notifications_enabled: T::Boolean,
@@ -211,18 +201,12 @@ module ModernTreasury
         # When payment_method is automatic, the fallback payment method to use when an
         # automatic payment fails. One of `manual` or `ui`.
         fallback_payment_method: nil,
-        # Whether to ingest the ledger_entries to populate the invoice line items. If this
-        # is false, then a line item must be provided. If this is true, line_items must be
-        # empty. Ignored if ledger_account_settlement_id is empty.
-        ingest_ledger_entries: nil,
         # An array of invoice line items. The API supports a maximum of 50 invoice line
         # items per invoice. If a greater number of invoice line items is required, please
         # contact support.
         invoice_line_items: nil,
         # The invoice issuer's business address.
         invoicer_address: nil,
-        # The ID of the virtual account the invoice should be paid to.
-        ledger_account_settlement_id: nil,
         # Additional data represented as key-value pairs. Both the key and value must be
         # strings.
         metadata: nil,

data/rbi/modern_treasury/resources/ledger_accounts.rbi

@@ -60,7 +60,7 @@ module ModernTreasury
         ).returns(ModernTreasury::LedgerAccount)
       end
       def retrieve(
-        # id
+        # The ledger account id (UUID) or external_id
         id,
         # Use `balances[effective_at_lower_bound]` and
         # `balances[effective_at_upper_bound]` to get the balances change between the two
@@ -84,7 +84,7 @@ module ModernTreasury
         ).returns(ModernTreasury::LedgerAccount)
       end
       def update(
-        # id
+        # The ledger account id (UUID)
         id,
         # The description of the ledger account.
         description: nil,
@@ -175,7 +175,7 @@ module ModernTreasury
         ).returns(ModernTreasury::LedgerAccount)
       end
       def delete(
-        # id
+        # The ledger account id (UUID)
         id,
         request_options: {}
       )

data/rbi/modern_treasury/resources/ledger_transactions.rbi

@@ -62,7 +62,8 @@ module ModernTreasury
         ).returns(ModernTreasury::LedgerTransaction)
       end
       def retrieve(
-        # id
+        # The ledger transaction id (UUID) or external_id. If using external_id, only
+        # non-archived Ledger Transactions will be returned.
         id,
         request_options: {}
       )
@@ -86,7 +87,7 @@ module ModernTreasury
         ).returns(ModernTreasury::LedgerTransaction)
       end
       def update(
-        # id
+        # The ledger transaction id (UUID)
         id,
         # An optional description for internal use.
         description: nil,

data/rbi/modern_treasury/resources/legal_entities.rbi

@@ -12,24 +12,28 @@ module ModernTreasury
             T::Array[ModernTreasury::LegalEntityAddressCreateRequest::OrHash],
           bank_settings:
             T.nilable(ModernTreasury::LegalEntityBankSettings::OrHash),
+          business_description: T.nilable(String),
           business_name: T.nilable(String),
           citizenship_country: T.nilable(String),
           compliance_details:
             T.nilable(ModernTreasury::LegalEntityComplianceDetail::OrHash),
+          country_of_incorporation: T.nilable(String),
           date_formed: T.nilable(Date),
           date_of_birth: T.nilable(Date),
           doing_business_as_names: T::Array[String],
           email: T.nilable(String),
+          expected_activity_volume: T.nilable(Integer),
           first_name: T.nilable(String),
           identifications:
             T::Array[ModernTreasury::IdentificationCreateRequest::OrHash],
           industry_classifications:
             T::Array[ModernTreasury::LegalEntityIndustryClassification::OrHash],
+          intended_use: T.nilable(String),
           last_name: T.nilable(String),
           legal_entity_associations:
             T.nilable(
               T::Array[
-                ModernTreasury::LegalEntityCreateParams::LegalEntityAssociation::OrHash
+                ModernTreasury::LegalEntityAssociationInlineCreate::OrHash
               ]
             ),
           legal_structure:
@@ -38,6 +42,7 @@ module ModernTreasury
             ),
           metadata: T::Hash[Symbol, String],
           middle_name: T.nilable(String),
+          operating_jurisdictions: T::Array[String],
           phone_numbers:
             T::Array[
               ModernTreasury::LegalEntityCreateParams::PhoneNumber::OrHash
@@ -45,6 +50,7 @@ module ModernTreasury
           politically_exposed_person: T.nilable(T::Boolean),
           preferred_name: T.nilable(String),
           prefix: T.nilable(String),
+          primary_social_media_sites: T::Array[String],
           risk_rating:
             T.nilable(
               ModernTreasury::LegalEntityCreateParams::RiskRating::OrSymbol
@@ -64,11 +70,16 @@ module ModernTreasury
         # A list of addresses for the entity.
         addresses: nil,
         bank_settings: nil,
+        # A description of the business.
+        business_description: nil,
         # The business's legal business name.
         business_name: nil,
         # The country of citizenship for an individual.
         citizenship_country: nil,
         compliance_details: nil,
+        # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+        # alpha-3 formats.
+        country_of_incorporation: nil,
         # A business's formation date (YYYY-MM-DD).
         date_formed: nil,
         # An individual's date of birth (YYYY-MM-DD).
@@ -76,12 +87,16 @@ module ModernTreasury
         doing_business_as_names: nil,
         # The entity's primary email.
         email: nil,
+        # Monthly expected transaction volume in entity's local currency.
+        expected_activity_volume: nil,
         # An individual's first name.
         first_name: nil,
         # A list of identifications for the legal entity.
         identifications: nil,
         # A list of industry classifications for the legal entity.
         industry_classifications: nil,
+        # A description of the intended use of the legal entity.
+        intended_use: nil,
         # An individual's last name.
         last_name: nil,
         # The legal entity associations and its child legal entities.
@@ -93,6 +108,9 @@ module ModernTreasury
         metadata: nil,
         # An individual's middle name.
         middle_name: nil,
+        # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
+        # codes).
+        operating_jurisdictions: nil,
         phone_numbers: nil,
         # Whether the individual is a politically exposed person.
         politically_exposed_person: nil,
@@ -100,6 +118,8 @@ module ModernTreasury
         preferred_name: nil,
         # An individual's prefix.
         prefix: nil,
+        # A list of primary social media URLs for the business.
+        primary_social_media_sites: nil,
         # The risk rating of the legal entity. One of low, medium, high.
         risk_rating: nil,
         # An individual's suffix.
@@ -133,19 +153,23 @@ module ModernTreasury
             T::Array[ModernTreasury::LegalEntityAddressCreateRequest::OrHash],
           bank_settings:
             T.nilable(ModernTreasury::LegalEntityBankSettings::OrHash),
+          business_description: T.nilable(String),
           business_name: T.nilable(String),
           citizenship_country: T.nilable(String),
           compliance_details:
             T.nilable(ModernTreasury::LegalEntityComplianceDetail::OrHash),
+          country_of_incorporation: T.nilable(String),
           date_formed: T.nilable(Date),
           date_of_birth: T.nilable(Date),
           doing_business_as_names: T::Array[String],
           email: T.nilable(String),
+          expected_activity_volume: T.nilable(Integer),
           first_name: T.nilable(String),
           identifications:
             T::Array[ModernTreasury::IdentificationCreateRequest::OrHash],
           industry_classifications:
             T::Array[ModernTreasury::LegalEntityIndustryClassification::OrHash],
+          intended_use: T.nilable(String),
           last_name: T.nilable(String),
           legal_structure:
             T.nilable(
@@ -153,6 +177,7 @@ module ModernTreasury
             ),
           metadata: T::Hash[Symbol, String],
           middle_name: T.nilable(String),
+          operating_jurisdictions: T::Array[String],
           phone_numbers:
             T::Array[
               ModernTreasury::LegalEntityUpdateParams::PhoneNumber::OrHash
@@ -160,6 +185,7 @@ module ModernTreasury
           politically_exposed_person: T.nilable(T::Boolean),
           preferred_name: T.nilable(String),
           prefix: T.nilable(String),
+          primary_social_media_sites: T::Array[String],
           risk_rating:
             T.nilable(
               ModernTreasury::LegalEntityUpdateParams::RiskRating::OrSymbol
@@ -179,11 +205,16 @@ module ModernTreasury
         # A list of addresses for the entity.
         addresses: nil,
         bank_settings: nil,
+        # A description of the business.
+        business_description: nil,
         # The business's legal business name.
         business_name: nil,
         # The country of citizenship for an individual.
         citizenship_country: nil,
         compliance_details: nil,
+        # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+        # alpha-3 formats.
+        country_of_incorporation: nil,
         # A business's formation date (YYYY-MM-DD).
         date_formed: nil,
         # An individual's date of birth (YYYY-MM-DD).
@@ -191,12 +222,16 @@ module ModernTreasury
         doing_business_as_names: nil,
         # The entity's primary email.
         email: nil,
+        # Monthly expected transaction volume in entity's local currency.
+        expected_activity_volume: nil,
         # An individual's first name.
         first_name: nil,
         # A list of identifications for the legal entity.
         identifications: nil,
         # A list of industry classifications for the legal entity.
         industry_classifications: nil,
+        # A description of the intended use of the legal entity.
+        intended_use: nil,
         # An individual's last name.
         last_name: nil,
         # The business's legal structure.
@@ -206,6 +241,9 @@ module ModernTreasury
         metadata: nil,
         # An individual's middle name.
         middle_name: nil,
+        # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
+        # codes).
+        operating_jurisdictions: nil,
         phone_numbers: nil,
         # Whether the individual is a politically exposed person.
         politically_exposed_person: nil,
@@ -213,6 +251,8 @@ module ModernTreasury
         preferred_name: nil,
         # An individual's prefix.
         prefix: nil,
+        # A list of primary social media URLs for the business.
+        primary_social_media_sites: nil,
         # The risk rating of the legal entity. One of low, medium, high.
         risk_rating: nil,
         # An individual's suffix.