modern_treasury 0.11.0 → 0.12.0

data/lib/modern_treasury/resources/legal_entities.rb

@@ -8,7 +8,7 @@ module ModernTreasury
       #
       # create legal_entity
       #
-      # @overload create(legal_entity_type:, addresses: nil, bank_settings: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
+      # @overload create(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
       #
       # @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalEntityType] The type of legal entity.
       #
@@ -16,12 +16,16 @@ module ModernTreasury
       #
       # @param bank_settings [ModernTreasury::Models::LegalEntityBankSettings, nil]
       #
+      # @param business_description [String, nil] A description of the business.
+      #
       # @param business_name [String, nil] The business's legal business name.
       #
       # @param citizenship_country [String, nil] The country of citizenship for an individual.
       #
       # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
       #
+      # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+      #
       # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
       #
       # @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
@@ -30,15 +34,19 @@ module ModernTreasury
       #
       # @param email [String, nil] The entity's primary email.
       #
+      # @param expected_activity_volume [Integer, nil] Monthly expected transaction volume in entity's local currency.
+      #
       # @param first_name [String, nil] An individual's first name.
       #
       # @param identifications [Array<ModernTreasury::Models::IdentificationCreateRequest>] A list of identifications for the legal entity.
       #
       # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
       #
+      # @param intended_use [String, nil] A description of the intended use of the legal entity.
+      #
       # @param last_name [String, nil] An individual's last name.
       #
-      # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityCreateParams::LegalEntityAssociation>, nil] The legal entity associations and its child legal entities.
+      # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityAssociationInlineCreate>, nil] The legal entity associations and its child legal entities.
       #
       # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalStructure, nil] The business's legal structure.
       #
@@ -46,6 +54,8 @@ module ModernTreasury
       #
       # @param middle_name [String, nil] An individual's middle name.
       #
+      # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
+      #
       # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>]
       #
       # @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
@@ -54,6 +64,8 @@ module ModernTreasury
       #
       # @param prefix [String, nil] An individual's prefix.
       #
+      # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
+      #
       # @param risk_rating [Symbol, ModernTreasury::Models::LegalEntityCreateParams::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
       #
       # @param suffix [String, nil] An individual's suffix.
@@ -103,7 +115,7 @@ module ModernTreasury
       #
       # Update a legal entity.
       #
-      # @overload update(id, addresses: nil, bank_settings: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
+      # @overload update(id, addresses: nil, bank_settings: nil, business_description: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_structure: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, risk_rating: nil, suffix: nil, wealth_and_employment_details: nil, website: nil, request_options: {})
       #
       # @param id [String] id
       #
@@ -111,12 +123,16 @@ module ModernTreasury
       #
       # @param bank_settings [ModernTreasury::Models::LegalEntityBankSettings, nil]
       #
+      # @param business_description [String, nil] A description of the business.
+      #
       # @param business_name [String, nil] The business's legal business name.
       #
       # @param citizenship_country [String, nil] The country of citizenship for an individual.
       #
       # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
       #
+      # @param country_of_incorporation [String, nil] The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+      #
       # @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
       #
       # @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
@@ -125,12 +141,16 @@ module ModernTreasury
       #
       # @param email [String, nil] The entity's primary email.
       #
+      # @param expected_activity_volume [Integer, nil] Monthly expected transaction volume in entity's local currency.
+      #
       # @param first_name [String, nil] An individual's first name.
       #
       # @param identifications [Array<ModernTreasury::Models::IdentificationCreateRequest>] A list of identifications for the legal entity.
       #
       # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
       #
+      # @param intended_use [String, nil] A description of the intended use of the legal entity.
+      #
       # @param last_name [String, nil] An individual's last name.
       #
       # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::LegalStructure, nil] The business's legal structure.
@@ -139,6 +159,8 @@ module ModernTreasury
       #
       # @param middle_name [String, nil] An individual's middle name.
       #
+      # @param operating_jurisdictions [Array<String>] A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3 c
+      #
       # @param phone_numbers [Array<ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber>]
       #
       # @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
@@ -147,6 +169,8 @@ module ModernTreasury
       #
       # @param prefix [String, nil] An individual's prefix.
       #
+      # @param primary_social_media_sites [Array<String>] A list of primary social media URLs for the business.
+      #
       # @param risk_rating [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
       #
       # @param suffix [String, nil] An individual's suffix.

data/lib/modern_treasury/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

data/lib/modern_treasury.rb

@@ -3,6 +3,7 @@
 # Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
+require "base64"
 require "cgi"
 require "date"
 require "erb"
@@ -76,6 +77,7 @@ require_relative "modern_treasury/models/bulk_request_retrieve_params"
 require_relative "modern_treasury/models/bulk_result"
 require_relative "modern_treasury/models/bulk_result_list_params"
 require_relative "modern_treasury/models/bulk_result_retrieve_params"
+require_relative "modern_treasury/models/child_legal_entity"
 require_relative "modern_treasury/models/child_legal_entity_create"
 require_relative "modern_treasury/models/client_ping_params"
 require_relative "modern_treasury/models/connection"
@@ -228,6 +230,7 @@ require_relative "modern_treasury/models/legal_entity"
 require_relative "modern_treasury/models/legal_entity_address_create_request"
 require_relative "modern_treasury/models/legal_entity_association"
 require_relative "modern_treasury/models/legal_entity_association_create_params"
+require_relative "modern_treasury/models/legal_entity_association_inline_create"
 require_relative "modern_treasury/models/legal_entity_bank_settings"
 require_relative "modern_treasury/models/legal_entity_compliance_detail"
 require_relative "modern_treasury/models/legal_entity_create_params"

data/manifest.yaml

@@ -1,5 +1,6 @@
 dependencies:
   - English
+  - base64
   - cgi
   - date
   - erb

data/rbi/modern_treasury/models/bulk_request_create_params.rbi

@@ -2012,6 +2012,38 @@ module ModernTreasury
           sig { returns(T.nilable(Integer)) }
           attr_accessor :amount_lower_bound
 
+          # The amount reconciled for this expected payment. Value in specified currency's
+          # smallest unit. e.g. $10 would be represented as 1000.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :amount_reconciled
+
+          # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+          # amount.
+          sig do
+            returns(
+              T.nilable(
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection::OrSymbol
+              )
+            )
+          end
+          attr_accessor :amount_reconciled_direction
+
+          # The amount that remains unreconciled for this expected payment. Value in
+          # specified currency's smallest unit. e.g. $10 would be represented as 1000.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :amount_unreconciled
+
+          # One of credit or debit. Indicates whether amount_unreconciled is a credit or
+          # debit amount.
+          sig do
+            returns(
+              T.nilable(
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection::OrSymbol
+              )
+            )
+          end
+          attr_accessor :amount_unreconciled_direction
+
           # 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.
           sig { returns(T.nilable(Integer)) }
@@ -2149,6 +2181,16 @@ module ModernTreasury
           sig do
             params(
               amount_lower_bound: T.nilable(Integer),
+              amount_reconciled: T.nilable(Integer),
+              amount_reconciled_direction:
+                T.nilable(
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection::OrSymbol
+                ),
+              amount_unreconciled: T.nilable(Integer),
+              amount_unreconciled_direction:
+                T.nilable(
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection::OrSymbol
+                ),
               amount_upper_bound: T.nilable(Integer),
               counterparty_id: T.nilable(String),
               currency: T.nilable(ModernTreasury::Currency::OrSymbol),
@@ -2182,6 +2224,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,
@@ -2241,6 +2295,16 @@ module ModernTreasury
             override.returns(
               {
                 amount_lower_bound: T.nilable(Integer),
+                amount_reconciled: T.nilable(Integer),
+                amount_reconciled_direction:
+                  T.nilable(
+                    ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection::OrSymbol
+                  ),
+                amount_unreconciled: T.nilable(Integer),
+                amount_unreconciled_direction:
+                  T.nilable(
+                    ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection::OrSymbol
+                  ),
                 amount_upper_bound: T.nilable(Integer),
                 counterparty_id: T.nilable(String),
                 currency: T.nilable(ModernTreasury::Currency::OrSymbol),
@@ -2274,6 +2338,78 @@ module ModernTreasury
           def to_hash
           end
 
+          # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+          # amount.
+          module AmountReconciledDirection
+            extend ModernTreasury::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CREDIT =
+              T.let(
+                :credit,
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection::TaggedSymbol
+              )
+            DEBIT =
+              T.let(
+                :debit,
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountReconciledDirection::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # One of credit or debit. Indicates whether amount_unreconciled is a credit or
+          # debit amount.
+          module AmountUnreconciledDirection
+            extend ModernTreasury::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CREDIT =
+              T.let(
+                :credit,
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection::TaggedSymbol
+              )
+            DEBIT =
+              T.let(
+                :debit,
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentCreateRequest::AmountUnreconciledDirection::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           # One of credit or debit. When you are receiving money, use credit. When you are
           # being charged, use debit.
           module Direction
@@ -4653,6 +4789,38 @@ module ModernTreasury
           sig { returns(T.nilable(Integer)) }
           attr_accessor :amount_lower_bound
 
+          # The amount reconciled for this expected payment. Value in specified currency's
+          # smallest unit. e.g. $10 would be represented as 1000.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :amount_reconciled
+
+          # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+          # amount.
+          sig do
+            returns(
+              T.nilable(
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountReconciledDirection::OrSymbol
+              )
+            )
+          end
+          attr_accessor :amount_reconciled_direction
+
+          # The amount that remains unreconciled for this expected payment. Value in
+          # specified currency's smallest unit. e.g. $10 would be represented as 1000.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :amount_unreconciled
+
+          # One of credit or debit. Indicates whether amount_unreconciled is a credit or
+          # debit amount.
+          sig do
+            returns(
+              T.nilable(
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountUnreconciledDirection::OrSymbol
+              )
+            )
+          end
+          attr_accessor :amount_unreconciled_direction
+
           # 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.
           sig { returns(T.nilable(Integer)) }
@@ -4754,6 +4922,16 @@ module ModernTreasury
             params(
               id: String,
               amount_lower_bound: T.nilable(Integer),
+              amount_reconciled: T.nilable(Integer),
+              amount_reconciled_direction:
+                T.nilable(
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountReconciledDirection::OrSymbol
+                ),
+              amount_unreconciled: T.nilable(Integer),
+              amount_unreconciled_direction:
+                T.nilable(
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountUnreconciledDirection::OrSymbol
+                ),
               amount_upper_bound: T.nilable(Integer),
               counterparty_id: T.nilable(String),
               currency: T.nilable(ModernTreasury::Currency::OrSymbol),
@@ -4785,6 +4963,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,
@@ -4837,6 +5027,16 @@ module ModernTreasury
               {
                 id: String,
                 amount_lower_bound: T.nilable(Integer),
+                amount_reconciled: T.nilable(Integer),
+                amount_reconciled_direction:
+                  T.nilable(
+                    ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountReconciledDirection::OrSymbol
+                  ),
+                amount_unreconciled: T.nilable(Integer),
+                amount_unreconciled_direction:
+                  T.nilable(
+                    ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountUnreconciledDirection::OrSymbol
+                  ),
                 amount_upper_bound: T.nilable(Integer),
                 counterparty_id: T.nilable(String),
                 currency: T.nilable(ModernTreasury::Currency::OrSymbol),
@@ -4867,6 +5067,78 @@ module ModernTreasury
           def to_hash
           end
 
+          # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+          # amount.
+          module AmountReconciledDirection
+            extend ModernTreasury::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountReconciledDirection
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CREDIT =
+              T.let(
+                :credit,
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountReconciledDirection::TaggedSymbol
+              )
+            DEBIT =
+              T.let(
+                :debit,
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountReconciledDirection::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountReconciledDirection::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # One of credit or debit. Indicates whether amount_unreconciled is a credit or
+          # debit amount.
+          module AmountUnreconciledDirection
+            extend ModernTreasury::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountUnreconciledDirection
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CREDIT =
+              T.let(
+                :credit,
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountUnreconciledDirection::TaggedSymbol
+              )
+            DEBIT =
+              T.let(
+                :debit,
+                ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountUnreconciledDirection::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  ModernTreasury::BulkRequestCreateParams::Resource::ExpectedPaymentUpdateRequestWithID::AmountUnreconciledDirection::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           # One of credit or debit. When you are receiving money, use credit. When you are
           # being charged, use debit.
           module Direction