modern_treasury 0.10.0 → 0.12.0

data/lib/modern_treasury/models/invoice_update_params.rb

@@ -60,14 +60,6 @@ module ModernTreasury
       #   @return [String, nil]
       optional :fallback_payment_method, String, nil?: true
 
-      # @!attribute ingest_ledger_entries
-      #   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.
-      #
-      #   @return [Boolean, nil]
-      optional :ingest_ledger_entries, ModernTreasury::Internal::Type::Boolean, nil?: true
-
       # @!attribute invoice_line_items
       #   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
@@ -86,12 +78,6 @@ module ModernTreasury
       #   @return [ModernTreasury::Models::InvoiceUpdateParams::InvoicerAddress, nil]
       optional :invoicer_address, -> { ModernTreasury::InvoiceUpdateParams::InvoicerAddress }, nil?: true
 
-      # @!attribute ledger_account_settlement_id
-      #   The ID of the virtual account the invoice should be paid to.
-      #
-      #   @return [String, nil]
-      optional :ledger_account_settlement_id, String, nil?: true
-
       # @!attribute metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
       #   strings.
@@ -188,7 +174,7 @@ module ModernTreasury
       #   @return [String, nil]
       optional :virtual_account_id, String, nil?: true
 
-      # @!method initialize(contact_details: nil, counterparty_billing_address: nil, counterparty_id: nil, counterparty_shipping_address: nil, currency: nil, description: nil, due_date: nil, fallback_payment_method: nil, ingest_ledger_entries: nil, invoice_line_items: nil, invoicer_address: nil, ledger_account_settlement_id: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, originating_account_id: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, status: nil, virtual_account_id: nil, request_options: {})
+      # @!method initialize(contact_details: nil, counterparty_billing_address: nil, counterparty_id: nil, counterparty_shipping_address: nil, currency: nil, description: nil, due_date: nil, fallback_payment_method: nil, invoice_line_items: nil, invoicer_address: nil, metadata: nil, notification_email_addresses: nil, notifications_enabled: nil, originating_account_id: nil, payment_effective_date: nil, payment_method: nil, payment_type: nil, receiving_account_id: nil, recipient_email: nil, recipient_name: nil, remind_after_overdue_days: nil, status: nil, virtual_account_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::InvoiceUpdateParams} for more details.
       #
@@ -208,14 +194,10 @@ module ModernTreasury
       #
       #   @param fallback_payment_method [String, nil] When payment_method is automatic, the fallback payment method to use when an aut
       #
-      #   @param ingest_ledger_entries [Boolean, nil] Whether to ingest the ledger_entries to populate the invoice line items. If this
-      #
       #   @param invoice_line_items [Array<ModernTreasury::Models::InvoiceUpdateParams::InvoiceLineItem>, nil] An array of invoice line items. The API supports a maximum of 50 invoice line it
       #
       #   @param invoicer_address [ModernTreasury::Models::InvoiceUpdateParams::InvoicerAddress, nil] The invoice issuer's business address.
       #
-      #   @param ledger_account_settlement_id [String, nil] The ID of the virtual account the invoice should be paid to.
-      #
       #   @param metadata [Hash{Symbol=>String}, nil] Additional data represented as key-value pairs. Both the key and value must be s
       #
       #   @param notification_email_addresses [Array<String>, nil] Emails in addition to the counterparty email to send invoice status notification

data/lib/modern_treasury/models/journal_entry_list_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalEntries#list
+    class JournalEntryListParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute journal_report_id
+      #   The ID of the journal report
+      #
+      #   @return [String]
+      required :journal_report_id, String
+
+      # @!attribute page
+      #   Page number for pagination
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute per_page
+      #   Number of items per page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!method initialize(journal_report_id:, page: nil, per_page: nil, request_options: {})
+      #   @param journal_report_id [String] The ID of the journal report
+      #
+      #   @param page [Integer] Page number for pagination
+      #
+      #   @param per_page [Integer] Number of items per page
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/journal_entry_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalEntries#retrieve
+    class JournalEntryRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/journal_report_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalReports#list
+    class JournalReportListParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/journal_report_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalReports#retrieve
+    class JournalReportRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/journal_report_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalReports#update
+    class JournalReportUpdateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute metadata
+      #
+      #   @return [Object, nil]
+      optional :metadata, ModernTreasury::Internal::Type::Unknown
+
+      # @!attribute status
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(metadata: nil, status: nil, request_options: {})
+      #   @param metadata [Object]
+      #   @param status [String]
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/ledger_entry.rb

@@ -35,6 +35,13 @@ module ModernTreasury
       #   @return [Time, nil]
       required :discarded_at, Time, nil?: true
 
+      # @!attribute effective_at
+      #   The timestamp (ISO8601 format) at which the ledger transaction happened for
+      #   reporting purposes.
+      #
+      #   @return [Time]
+      required :effective_at, Time
+
       # @!attribute ledger_account_currency
       #   The currency of the ledger account.
       #
@@ -111,7 +118,7 @@ module ModernTreasury
       #   @return [Time]
       required :updated_at, Time
 
-      # @!method initialize(id:, amount:, created_at:, direction:, discarded_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:, updated_at:)
+      # @!method initialize(id:, amount:, created_at:, direction:, discarded_at:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:, updated_at:)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::LedgerEntry} for more details.
       #
@@ -125,6 +132,8 @@ module ModernTreasury
       #
       #   @param discarded_at [Time, nil]
       #
+      #   @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
+      #
       #   @param ledger_account_currency [String] The currency of the ledger account.
       #
       #   @param ledger_account_currency_exponent [Integer] The currency exponent of the ledger account.

data/lib/modern_treasury/models/ledger_entry_create_request.rb

@@ -33,6 +33,13 @@ module ModernTreasury
       #   @return [Hash{Symbol=>Integer}, nil]
       optional :available_balance_amount, ModernTreasury::Internal::Type::HashOf[Integer], nil?: true
 
+      # @!attribute effective_at
+      #   The timestamp (ISO8601 format) at which the ledger transaction happened for
+      #   reporting purposes.
+      #
+      #   @return [Time, nil]
+      optional :effective_at, Time
+
       # @!attribute lock_version
       #   Lock version of the ledger account. This can be passed when creating a ledger
       #   transaction to only succeed if no ledger transactions have posted since the
@@ -72,7 +79,7 @@ module ModernTreasury
       #   @return [Boolean, nil]
       optional :show_resulting_ledger_account_balances, ModernTreasury::Internal::Type::Boolean, nil?: true
 
-      # @!method initialize(amount:, direction:, ledger_account_id:, available_balance_amount: nil, lock_version: nil, metadata: nil, pending_balance_amount: nil, posted_balance_amount: nil, show_resulting_ledger_account_balances: nil)
+      # @!method initialize(amount:, direction:, ledger_account_id:, available_balance_amount: nil, effective_at: nil, lock_version: nil, metadata: nil, pending_balance_amount: nil, posted_balance_amount: nil, show_resulting_ledger_account_balances: nil)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::LedgerEntryCreateRequest} for more details.
       #
@@ -84,6 +91,8 @@ module ModernTreasury
       #
       #   @param available_balance_amount [Hash{Symbol=>Integer}, nil] Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to lock on the accou
       #
+      #   @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
+      #
       #   @param lock_version [Integer, nil] Lock version of the ledger account. This can be passed when creating a ledger tr
       #
       #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s

data/lib/modern_treasury/models/ledger_transactions/ledger_transaction_version.rb

@@ -218,6 +218,13 @@ module ModernTreasury
           #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
           required :direction, enum: -> { ModernTreasury::TransactionDirection }
 
+          # @!attribute effective_at
+          #   The timestamp (ISO8601 format) at which the ledger transaction happened for
+          #   reporting purposes.
+          #
+          #   @return [Time]
+          required :effective_at, Time
+
           # @!attribute ledger_account_currency
           #   The currency of the ledger account.
           #
@@ -290,7 +297,7 @@ module ModernTreasury
           required :status,
                    enum: -> { ModernTreasury::LedgerTransactions::LedgerTransactionVersion::LedgerEntry::Status }
 
-          # @!method initialize(id:, amount:, created_at:, direction:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:)
+          # @!method initialize(id:, amount:, created_at:, direction:, effective_at:, ledger_account_currency:, ledger_account_currency_exponent:, ledger_account_id:, ledger_account_lock_version:, ledger_transaction_id:, live_mode:, metadata:, object:, resulting_ledger_account_balances:, status:)
           #   Some parameter documentations has been truncated, see
           #   {ModernTreasury::Models::LedgerTransactions::LedgerTransactionVersion::LedgerEntry}
           #   for more details.
@@ -303,6 +310,8 @@ module ModernTreasury
           #
           #   @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `credit`, `debit`. Describes the direction money is flowing in the transa
           #
+          #   @param effective_at [Time] The timestamp (ISO8601 format) at which the ledger transaction happened for repo
+          #
           #   @param ledger_account_currency [String] The currency of the ledger account.
           #
           #   @param ledger_account_currency_exponent [Integer] The currency exponent of the ledger account.

data/lib/modern_treasury/models/legal_entity.rb

@@ -20,6 +20,12 @@ module ModernTreasury
       #   @return [ModernTreasury::Models::LegalEntityBankSettings, nil]
       required :bank_settings, -> { ModernTreasury::LegalEntityBankSettings }, nil?: true
 
+      # @!attribute business_description
+      #   A description of the business.
+      #
+      #   @return [String, nil]
+      required :business_description, String, nil?: true
+
       # @!attribute business_name
       #   The business's legal business name.
       #
@@ -37,6 +43,13 @@ module ModernTreasury
       #   @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
       required :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true
 
+      # @!attribute country_of_incorporation
+      #   The country code where the business is incorporated in the ISO 3166-1 alpha-2 or
+      #   alpha-3 formats.
+      #
+      #   @return [String, nil]
+      required :country_of_incorporation, String, nil?: true
+
       # @!attribute created_at
       #
       #   @return [Time]
@@ -70,6 +83,12 @@ module ModernTreasury
       #   @return [String, nil]
       required :email, String, nil?: true
 
+      # @!attribute expected_activity_volume
+      #   Monthly expected transaction volume in entity's local currency.
+      #
+      #   @return [Integer, nil]
+      required :expected_activity_volume, Integer, nil?: true
+
       # @!attribute first_name
       #   An individual's first name.
       #
@@ -90,20 +109,18 @@ module ModernTreasury
       required :industry_classifications,
                -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification] }
 
+      # @!attribute intended_use
+      #   A description of the intended use of the legal entity.
+      #
+      #   @return [String, nil]
+      required :intended_use, String, nil?: true
+
       # @!attribute last_name
       #   An individual's last name.
       #
       #   @return [String, nil]
       required :last_name, String, nil?: true
 
-      # @!attribute legal_entity_associations
-      #   The legal entity associations and its child legal entities.
-      #
-      #   @return [Array<ModernTreasury::Models::LegalEntityAssociation>, nil]
-      required :legal_entity_associations,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociation] },
-               nil?: true
-
       # @!attribute legal_entity_type
       #   The type of legal entity.
       #
@@ -141,6 +158,13 @@ module ModernTreasury
       #   @return [String]
       required :object, String
 
+      # @!attribute operating_jurisdictions
+      #   A list of countries where the business operates (ISO 3166-1 alpha-2 or alpha-3
+      #   codes).
+      #
+      #   @return [Array<String>]
+      required :operating_jurisdictions, ModernTreasury::Internal::Type::ArrayOf[String]
+
       # @!attribute phone_numbers
       #
       #   @return [Array<ModernTreasury::Models::LegalEntity::PhoneNumber>]
@@ -165,6 +189,12 @@ module ModernTreasury
       #   @return [String, nil]
       required :prefix, String, nil?: true
 
+      # @!attribute primary_social_media_sites
+      #   A list of primary social media URLs for the business.
+      #
+      #   @return [Array<String>]
+      required :primary_social_media_sites, ModernTreasury::Internal::Type::ArrayOf[String]
+
       # @!attribute risk_rating
       #   The risk rating of the legal entity. One of low, medium, high.
       #
@@ -195,7 +225,15 @@ module ModernTreasury
       #   @return [String, nil]
       required :website, String, nil?: true
 
-      # @!method initialize(id:, addresses:, bank_settings:, business_name:, citizenship_country:, compliance_details:, created_at:, date_formed:, date_of_birth:, discarded_at:, doing_business_as_names:, email:, first_name:, identifications:, industry_classifications:, last_name:, legal_entity_associations:, legal_entity_type:, legal_structure:, live_mode:, metadata:, middle_name:, object:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, risk_rating:, suffix:, updated_at:, wealth_and_employment_details:, website:)
+      # @!attribute legal_entity_associations
+      #   The legal entity associations and its child legal entities.
+      #
+      #   @return [Array<ModernTreasury::Models::LegalEntityAssociation>, nil]
+      optional :legal_entity_associations,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociation] },
+               nil?: true
+
+      # @!method initialize(id:, addresses:, bank_settings:, business_description:, business_name:, citizenship_country:, compliance_details:, country_of_incorporation:, created_at:, date_formed:, date_of_birth:, discarded_at:, doing_business_as_names:, email:, expected_activity_volume:, first_name:, identifications:, industry_classifications:, intended_use:, last_name:, legal_entity_type:, legal_structure:, live_mode:, metadata:, middle_name:, object:, operating_jurisdictions:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, primary_social_media_sites:, risk_rating:, suffix:, updated_at:, wealth_and_employment_details:, website:, legal_entity_associations: nil)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::LegalEntity} for more details.
       #
@@ -205,12 +243,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 created_at [Time]
       #
       #   @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
@@ -223,15 +265,17 @@ 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::LegalEntity::Identification>] 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 last_name [String, nil] An individual's last name.
+      #   @param intended_use [String, nil] A description of the intended use of the legal entity.
       #
-      #   @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityAssociation>, nil] The legal entity associations and its child legal entities.
+      #   @param last_name [String, nil] An individual's last name.
       #
       #   @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntity::LegalEntityType] The type of legal entity.
       #
@@ -245,6 +289,8 @@ module ModernTreasury
       #
       #   @param object [String]
       #
+      #   @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::LegalEntity::PhoneNumber>]
       #
       #   @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
@@ -253,6 +299,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::LegalEntity::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
       #
       #   @param suffix [String, nil] An individual's suffix.
@@ -262,6 +310,8 @@ module ModernTreasury
       #   @param wealth_and_employment_details [ModernTreasury::Models::LegalEntityWealthEmploymentDetail, nil]
       #
       #   @param website [String, nil] The entity's primary website URL.
+      #
+      #   @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityAssociation>, nil] The legal entity associations and its child legal entities.
 
       class Address < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id