modern_treasury 0.11.0 → 0.13.0

data/rbi/modern_treasury/models/counterparty_create_params.rbi

@@ -1185,6 +1185,10 @@ module ModernTreasury
         end
         attr_writer :bank_settings
 
+        # A description of the business.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :business_description
+
         # The business's legal business name.
         sig { returns(T.nilable(String)) }
         attr_accessor :business_name
@@ -1204,6 +1208,11 @@ module ModernTreasury
         end
         attr_writer :compliance_details
 
+        # The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+        # alpha-3 formats.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :country_of_incorporation
+
         # A business's formation date (YYYY-MM-DD).
         sig { returns(T.nilable(Date)) }
         attr_accessor :date_formed
@@ -1222,6 +1231,10 @@ module ModernTreasury
         sig { returns(T.nilable(String)) }
         attr_accessor :email
 
+        # Monthly expected transaction volume in entity's local currency.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :expected_activity_volume
+
         # An individual's first name.
         sig { returns(T.nilable(String)) }
         attr_accessor :first_name
@@ -1262,6 +1275,10 @@ module ModernTreasury
         end
         attr_writer :industry_classifications
 
+        # A description of the intended use of the legal entity.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :intended_use
+
         # An individual's last name.
         sig { returns(T.nilable(String)) }
         attr_accessor :last_name
@@ -1270,9 +1287,7 @@ module ModernTreasury
         sig do
           returns(
             T.nilable(
-              T::Array[
-                ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation
-              ]
+              T::Array[ModernTreasury::LegalEntityAssociationInlineCreate]
             )
           )
         end
@@ -1300,6 +1315,14 @@ module ModernTreasury
         sig { returns(T.nilable(String)) }
         attr_accessor :middle_name
 
+        # A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
+        # codes).
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :operating_jurisdictions
+
+        sig { params(operating_jurisdictions: T::Array[String]).void }
+        attr_writer :operating_jurisdictions
+
         sig do
           returns(
             T.nilable(
@@ -1333,6 +1356,13 @@ module ModernTreasury
         sig { returns(T.nilable(String)) }
         attr_accessor :prefix
 
+        # A list of primary social media URLs for the business.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :primary_social_media_sites
+
+        sig { params(primary_social_media_sites: T::Array[String]).void }
+        attr_writer :primary_social_media_sites
+
         # The risk rating of the legal entity. One of low, medium, high.
         sig do
           returns(
@@ -1374,14 +1404,17 @@ 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],
@@ -1389,11 +1422,12 @@ module ModernTreasury
               T::Array[
                 ModernTreasury::LegalEntityIndustryClassification::OrHash
               ],
+            intended_use: T.nilable(String),
             last_name: T.nilable(String),
             legal_entity_associations:
               T.nilable(
                 T::Array[
-                  ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::OrHash
+                  ModernTreasury::LegalEntityAssociationInlineCreate::OrHash
                 ]
               ),
             legal_structure:
@@ -1402,6 +1436,7 @@ module ModernTreasury
               ),
             metadata: T::Hash[Symbol, String],
             middle_name: T.nilable(String),
+            operating_jurisdictions: T::Array[String],
             phone_numbers:
               T::Array[
                 ModernTreasury::CounterpartyCreateParams::LegalEntity::PhoneNumber::OrHash
@@ -1409,6 +1444,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::CounterpartyCreateParams::LegalEntity::RiskRating::OrSymbol
@@ -1427,11 +1463,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).
@@ -1439,12 +1480,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.
@@ -1456,6 +1501,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,
@@ -1463,6 +1511,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.
@@ -1481,25 +1531,27 @@ module ModernTreasury
               addresses:
                 T::Array[ModernTreasury::LegalEntityAddressCreateRequest],
               bank_settings: T.nilable(ModernTreasury::LegalEntityBankSettings),
+              business_description: T.nilable(String),
               business_name: T.nilable(String),
               citizenship_country: T.nilable(String),
               compliance_details:
                 T.nilable(ModernTreasury::LegalEntityComplianceDetail),
+              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],
               industry_classifications:
                 T::Array[ModernTreasury::LegalEntityIndustryClassification],
+              intended_use: T.nilable(String),
               last_name: T.nilable(String),
               legal_entity_associations:
                 T.nilable(
-                  T::Array[
-                    ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation
-                  ]
+                  T::Array[ModernTreasury::LegalEntityAssociationInlineCreate]
                 ),
               legal_structure:
                 T.nilable(
@@ -1507,6 +1559,7 @@ module ModernTreasury
                 ),
               metadata: T::Hash[Symbol, String],
               middle_name: T.nilable(String),
+              operating_jurisdictions: T::Array[String],
               phone_numbers:
                 T::Array[
                   ModernTreasury::CounterpartyCreateParams::LegalEntity::PhoneNumber
@@ -1514,6 +1567,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::CounterpartyCreateParams::LegalEntity::RiskRating::OrSymbol
@@ -1563,134 +1617,6 @@ module ModernTreasury
           end
         end
 
-        class LegalEntityAssociation < ModernTreasury::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation,
-                ModernTreasury::Internal::AnyHash
-              )
-            end
-
-          sig do
-            returns(
-              T::Array[
-                ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType::OrSymbol
-              ]
-            )
-          end
-          attr_accessor :relationship_types
-
-          # The child legal entity.
-          sig { returns(T.nilable(ModernTreasury::ChildLegalEntityCreate)) }
-          attr_reader :child_legal_entity
-
-          sig do
-            params(
-              child_legal_entity: ModernTreasury::ChildLegalEntityCreate::OrHash
-            ).void
-          end
-          attr_writer :child_legal_entity
-
-          # The ID of the child legal entity.
-          sig { returns(T.nilable(String)) }
-          attr_reader :child_legal_entity_id
-
-          sig { params(child_legal_entity_id: String).void }
-          attr_writer :child_legal_entity_id
-
-          # The child entity's ownership percentage iff they are a beneficial owner.
-          sig { returns(T.nilable(Integer)) }
-          attr_accessor :ownership_percentage
-
-          # The job title of the child entity at the parent entity.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :title
-
-          sig do
-            params(
-              relationship_types:
-                T::Array[
-                  ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType::OrSymbol
-                ],
-              child_legal_entity:
-                ModernTreasury::ChildLegalEntityCreate::OrHash,
-              child_legal_entity_id: String,
-              ownership_percentage: T.nilable(Integer),
-              title: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            relationship_types:,
-            # The child legal entity.
-            child_legal_entity: nil,
-            # The ID of the child legal entity.
-            child_legal_entity_id: nil,
-            # The child entity's ownership percentage iff they are a beneficial owner.
-            ownership_percentage: nil,
-            # The job title of the child entity at the parent entity.
-            title: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                relationship_types:
-                  T::Array[
-                    ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType::OrSymbol
-                  ],
-                child_legal_entity: ModernTreasury::ChildLegalEntityCreate,
-                child_legal_entity_id: String,
-                ownership_percentage: T.nilable(Integer),
-                title: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-
-          # A list of relationship types for how the child entity relates to parent entity.
-          module RelationshipType
-            extend ModernTreasury::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            AUTHORIZED_SIGNER =
-              T.let(
-                :authorized_signer,
-                ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType::TaggedSymbol
-              )
-            BENEFICIAL_OWNER =
-              T.let(
-                :beneficial_owner,
-                ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType::TaggedSymbol
-              )
-            CONTROL_PERSON =
-              T.let(
-                :control_person,
-                ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation::RelationshipType::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-
         # The business's legal structure.
         module LegalStructure
           extend ModernTreasury::Internal::Type::Enum

data/rbi/modern_treasury/models/document.rbi

@@ -25,13 +25,17 @@ module ModernTreasury
       attr_accessor :document_type
 
       # The unique identifier for the associated object.
-      sig { returns(String) }
+      sig { returns(T.nilable(String)) }
       attr_accessor :documentable_id
 
       # The type of the associated object. Currently can be one of `payment_order`,
       # `transaction`, `expected_payment`, `counterparty`, `organization`, `case`,
       # `internal_account`, `decision`, or `external_account`.
-      sig { returns(ModernTreasury::Document::DocumentableType::TaggedSymbol) }
+      sig do
+        returns(
+          T.nilable(ModernTreasury::Document::DocumentableType::TaggedSymbol)
+        )
+      end
       attr_accessor :documentable_type
 
       sig { returns(ModernTreasury::Document::File) }
@@ -63,9 +67,9 @@ module ModernTreasury
           document_details:
             T::Array[ModernTreasury::Document::DocumentDetail::OrHash],
           document_type: T.nilable(String),
-          documentable_id: String,
+          documentable_id: T.nilable(String),
           documentable_type:
-            ModernTreasury::Document::DocumentableType::OrSymbol,
+            T.nilable(ModernTreasury::Document::DocumentableType::OrSymbol),
           file: ModernTreasury::Document::File::OrHash,
           live_mode: T::Boolean,
           object: String,
@@ -106,9 +110,11 @@ module ModernTreasury
             document_details:
               T::Array[ModernTreasury::Document::DocumentDetail],
             document_type: T.nilable(String),
-            documentable_id: String,
+            documentable_id: T.nilable(String),
             documentable_type:
-              ModernTreasury::Document::DocumentableType::TaggedSymbol,
+              T.nilable(
+                ModernTreasury::Document::DocumentableType::TaggedSymbol
+              ),
             file: ModernTreasury::Document::File,
             live_mode: T::Boolean,
             object: String,
@@ -211,6 +217,11 @@ module ModernTreasury
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        CONNECTION =
+          T.let(
+            :connection,
+            ModernTreasury::Document::DocumentableType::TaggedSymbol
+          )
         COUNTERPARTY =
           T.let(
             :counterparty,
@@ -241,6 +252,11 @@ module ModernTreasury
             :internal_account,
             ModernTreasury::Document::DocumentableType::TaggedSymbol
           )
+        LEGAL_ENTITY =
+          T.let(
+            :legal_entity,
+            ModernTreasury::Document::DocumentableType::TaggedSymbol
+          )
         ORGANIZATION =
           T.let(
             :organization,
@@ -256,11 +272,6 @@ module ModernTreasury
             :transaction,
             ModernTreasury::Document::DocumentableType::TaggedSymbol
           )
-        CONNECTION =
-          T.let(
-            :connection,
-            ModernTreasury::Document::DocumentableType::TaggedSymbol
-          )
 
         sig do
           override.returns(

data/rbi/modern_treasury/models/document_create_params.rbi

@@ -14,17 +14,6 @@ module ModernTreasury
           )
         end
 
-      # The unique identifier for the associated object.
-      sig { returns(String) }
-      attr_accessor :documentable_id
-
-      sig do
-        returns(
-          ModernTreasury::DocumentCreateParams::DocumentableType::OrSymbol
-        )
-      end
-      attr_accessor :documentable_type
-
       sig { returns(ModernTreasury::Internal::FileInput) }
       attr_accessor :file
 
@@ -35,23 +24,47 @@ module ModernTreasury
       sig { params(document_type: String).void }
       attr_writer :document_type
 
+      # The unique identifier for the associated object.
+      sig { returns(T.nilable(String)) }
+      attr_reader :documentable_id
+
+      sig { params(documentable_id: String).void }
+      attr_writer :documentable_id
+
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::DocumentCreateParams::DocumentableType::OrSymbol
+          )
+        )
+      end
+      attr_reader :documentable_type
+
       sig do
         params(
-          documentable_id: String,
           documentable_type:
-            ModernTreasury::DocumentCreateParams::DocumentableType::OrSymbol,
+            ModernTreasury::DocumentCreateParams::DocumentableType::OrSymbol
+        ).void
+      end
+      attr_writer :documentable_type
+
+      sig do
+        params(
           file: ModernTreasury::Internal::FileInput,
           document_type: String,
+          documentable_id: String,
+          documentable_type:
+            ModernTreasury::DocumentCreateParams::DocumentableType::OrSymbol,
           request_options: ModernTreasury::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # The unique identifier for the associated object.
-        documentable_id:,
-        documentable_type:,
         file:,
         # A category given to the document, can be `null`.
         document_type: nil,
+        # The unique identifier for the associated object.
+        documentable_id: nil,
+        documentable_type: nil,
         request_options: {}
       )
       end
@@ -59,11 +72,11 @@ module ModernTreasury
       sig do
         override.returns(
           {
+            file: ModernTreasury::Internal::FileInput,
+            document_type: String,
             documentable_id: String,
             documentable_type:
               ModernTreasury::DocumentCreateParams::DocumentableType::OrSymbol,
-            file: ModernTreasury::Internal::FileInput,
-            document_type: String,
             request_options: ModernTreasury::RequestOptions
           }
         )
@@ -83,6 +96,11 @@ module ModernTreasury
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        CONNECTIONS =
+          T.let(
+            :connections,
+            ModernTreasury::DocumentCreateParams::DocumentableType::TaggedSymbol
+          )
         COUNTERPARTIES =
           T.let(
             :counterparties,
@@ -113,6 +131,11 @@ module ModernTreasury
             :internal_accounts,
             ModernTreasury::DocumentCreateParams::DocumentableType::TaggedSymbol
           )
+        LEGAL_ENTITIES =
+          T.let(
+            :legal_entities,
+            ModernTreasury::DocumentCreateParams::DocumentableType::TaggedSymbol
+          )
         ORGANIZATIONS =
           T.let(
             :organizations,
@@ -128,11 +151,6 @@ module ModernTreasury
             :transactions,
             ModernTreasury::DocumentCreateParams::DocumentableType::TaggedSymbol
           )
-        CONNECTIONS =
-          T.let(
-            :connections,
-            ModernTreasury::DocumentCreateParams::DocumentableType::TaggedSymbol
-          )
 
         sig do
           override.returns(

data/rbi/modern_treasury/models/document_list_params.rbi

@@ -100,6 +100,11 @@ module ModernTreasury
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        CONNECTIONS =
+          T.let(
+            :connections,
+            ModernTreasury::DocumentListParams::DocumentableType::TaggedSymbol
+          )
         COUNTERPARTIES =
           T.let(
             :counterparties,
@@ -130,6 +135,11 @@ module ModernTreasury
             :internal_accounts,
             ModernTreasury::DocumentListParams::DocumentableType::TaggedSymbol
           )
+        LEGAL_ENTITIES =
+          T.let(
+            :legal_entities,
+            ModernTreasury::DocumentListParams::DocumentableType::TaggedSymbol
+          )
         ORGANIZATIONS =
           T.let(
             :organizations,
@@ -145,11 +155,6 @@ module ModernTreasury
             :transactions,
             ModernTreasury::DocumentListParams::DocumentableType::TaggedSymbol
           )
-        CONNECTIONS =
-          T.let(
-            :connections,
-            ModernTreasury::DocumentListParams::DocumentableType::TaggedSymbol
-          )
 
         sig do
           override.returns(