modern_treasury 0.1.0.pre.alpha.21 → 0.1.0

data/lib/modern_treasury/models/internal_account_create_params.rb

@@ -32,6 +32,16 @@ module ModernTreasury
       #   @return [String]
       required :party_name, String
 
+      # @!attribute account_capabilities
+      #   An array of AccountCapability objects that list the originating abilities of the
+      #   internal account and any relevant information for them.
+      #
+      #   @return [Array<ModernTreasury::Models::InternalAccountCreateParams::AccountCapability>, nil]
+      optional :account_capabilities,
+               -> {
+                 ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::InternalAccountCreateParams::AccountCapability]
+               }
+
       # @!attribute account_type
       #   The account type, used to provision the appropriate account at the financial
       #   institution.
@@ -70,7 +80,7 @@ module ModernTreasury
       #   @return [Hash{Symbol=>String}, nil]
       optional :vendor_attributes, ModernTreasury::Internal::Type::HashOf[String]
 
-      # @!method initialize(connection_id:, currency:, name:, party_name:, account_type: nil, counterparty_id: nil, legal_entity_id: nil, parent_account_id: nil, party_address: nil, vendor_attributes: nil, request_options: {})
+      # @!method initialize(connection_id:, currency:, name:, party_name:, account_capabilities: nil, account_type: nil, counterparty_id: nil, legal_entity_id: nil, parent_account_id: nil, party_address: nil, vendor_attributes: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::InternalAccountCreateParams} for more details.
       #
@@ -82,6 +92,8 @@ module ModernTreasury
       #
       #   @param party_name [String] The legal name of the entity which owns the account.
       #
+      #   @param account_capabilities [Array<ModernTreasury::Models::InternalAccountCreateParams::AccountCapability>] An array of AccountCapability objects that list the originating abilities of the
+      #
       #   @param account_type [Symbol, ModernTreasury::Models::InternalAccountCreateParams::AccountType] The account type, used to provision the appropriate account at the financial ins
       #
       #   @param counterparty_id [String] The Counterparty associated to this account.
@@ -108,6 +120,131 @@ module ModernTreasury
         #   @return [Array<Symbol>]
       end
 
+      class AccountCapability < ModernTreasury::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute direction
+        #   One of `debit` or `credit`. Indicates the direction of money movement this
+        #   capability is responsible for.
+        #
+        #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+        required :direction, enum: -> { ModernTreasury::TransactionDirection }
+
+        # @!attribute discarded_at
+        #
+        #   @return [Time, nil]
+        required :discarded_at, Time, nil?: true
+
+        # @!attribute identifier
+        #   A unique reference assigned by your bank for tracking and recognizing payment
+        #   files. It is important this is formatted exactly how the bank assigned it.
+        #
+        #   @return [String, nil]
+        required :identifier, String, nil?: true
+
+        # @!attribute live_mode
+        #   This field will be true if this object exists in the live environment or false
+        #   if it exists in the test environment.
+        #
+        #   @return [Boolean]
+        required :live_mode, ModernTreasury::Internal::Type::Boolean
+
+        # @!attribute object
+        #
+        #   @return [String]
+        required :object, String
+
+        # @!attribute payment_type
+        #   Indicates the the type of payment this capability is responsible for
+        #   originating.
+        #
+        #   @return [Symbol, ModernTreasury::Models::InternalAccountCreateParams::AccountCapability::PaymentType]
+        required :payment_type,
+                 enum: -> { ModernTreasury::InternalAccountCreateParams::AccountCapability::PaymentType }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!method initialize(id:, created_at:, direction:, discarded_at:, identifier:, live_mode:, object:, payment_type:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Models::InternalAccountCreateParams::AccountCapability} for
+        #   more details.
+        #
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `debit` or `credit`. Indicates the direction of money movement this capab
+        #
+        #   @param discarded_at [Time, nil]
+        #
+        #   @param identifier [String, nil] A unique reference assigned by your bank for tracking and recognizing payment fi
+        #
+        #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+        #
+        #   @param object [String]
+        #
+        #   @param payment_type [Symbol, ModernTreasury::Models::InternalAccountCreateParams::AccountCapability::PaymentType] Indicates the the type of payment this capability is responsible for originating
+        #
+        #   @param updated_at [Time]
+
+        # Indicates the the type of payment this capability is responsible for
+        # originating.
+        #
+        # @see ModernTreasury::Models::InternalAccountCreateParams::AccountCapability#payment_type
+        module PaymentType
+          extend ModernTreasury::Internal::Type::Enum
+
+          ACH = :ach
+          AU_BECS = :au_becs
+          BACS = :bacs
+          BASE = :base
+          BOOK = :book
+          CARD = :card
+          CHATS = :chats
+          CHECK = :check
+          CROSS_BORDER = :cross_border
+          DK_NETS = :dk_nets
+          EFT = :eft
+          ETHEREUM = :ethereum
+          HU_ICS = :hu_ics
+          INTERAC = :interac
+          MASAV = :masav
+          MX_CCEN = :mx_ccen
+          NEFT = :neft
+          NICS = :nics
+          NZ_BECS = :nz_becs
+          PL_ELIXIR = :pl_elixir
+          POLYGON = :polygon
+          PROVXCHANGE = :provxchange
+          RO_SENT = :ro_sent
+          RTP = :rtp
+          SE_BANKGIROT = :se_bankgirot
+          SEN = :sen
+          SEPA = :sepa
+          SG_GIRO = :sg_giro
+          SIC = :sic
+          SIGNET = :signet
+          SKNBI = :sknbi
+          SOLANA = :solana
+          WIRE = :wire
+          ZENGIN = :zengin
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # The account type, used to provision the appropriate account at the financial
       # institution.
       module AccountType

data/lib/modern_treasury/models/internal_account_update_account_capability_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::InternalAccounts#update_account_capability
+    class InternalAccountUpdateAccountCapabilityParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute internal_account_id
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!attribute identifier
+      #   A unique reference assigned by your bank for tracking and recognizing payment
+      #   files. It is important this is formatted exactly how the bank assigned it.
+      #
+      #   @return [String]
+      required :identifier, String
+
+      # @!method initialize(internal_account_id:, identifier:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::InternalAccountUpdateAccountCapabilityParams} for more
+      #   details.
+      #
+      #   @param internal_account_id [String]
+      #
+      #   @param identifier [String] A unique reference assigned by your bank for tracking and recognizing payment fi
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/internal_account_update_account_capability_response.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::InternalAccounts#update_account_capability
+    class InternalAccountUpdateAccountCapabilityResponse < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute direction
+      #   One of `debit` or `credit`. Indicates the direction of money movement this
+      #   capability is responsible for.
+      #
+      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+      required :direction, enum: -> { ModernTreasury::TransactionDirection }
+
+      # @!attribute discarded_at
+      #
+      #   @return [Time, nil]
+      required :discarded_at, Time, nil?: true
+
+      # @!attribute identifier
+      #   A unique reference assigned by your bank for tracking and recognizing payment
+      #   files. It is important this is formatted exactly how the bank assigned it.
+      #
+      #   @return [String, nil]
+      required :identifier, String, nil?: true
+
+      # @!attribute live_mode
+      #   This field will be true if this object exists in the live environment or false
+      #   if it exists in the test environment.
+      #
+      #   @return [Boolean]
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute payment_type
+      #   Indicates the the type of payment this capability is responsible for
+      #   originating.
+      #
+      #   @return [Symbol, ModernTreasury::Models::InternalAccountUpdateAccountCapabilityResponse::PaymentType]
+      required :payment_type,
+               enum: -> { ModernTreasury::Models::InternalAccountUpdateAccountCapabilityResponse::PaymentType }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, created_at:, direction:, discarded_at:, identifier:, live_mode:, object:, payment_type:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::InternalAccountUpdateAccountCapabilityResponse} for
+      #   more details.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `debit` or `credit`. Indicates the direction of money movement this capab
+      #
+      #   @param discarded_at [Time, nil]
+      #
+      #   @param identifier [String, nil] A unique reference assigned by your bank for tracking and recognizing payment fi
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param payment_type [Symbol, ModernTreasury::Models::InternalAccountUpdateAccountCapabilityResponse::PaymentType] Indicates the the type of payment this capability is responsible for originating
+      #
+      #   @param updated_at [Time]
+
+      # Indicates the the type of payment this capability is responsible for
+      # originating.
+      #
+      # @see ModernTreasury::Models::InternalAccountUpdateAccountCapabilityResponse#payment_type
+      module PaymentType
+        extend ModernTreasury::Internal::Type::Enum
+
+        ACH = :ach
+        AU_BECS = :au_becs
+        BACS = :bacs
+        BASE = :base
+        BOOK = :book
+        CARD = :card
+        CHATS = :chats
+        CHECK = :check
+        CROSS_BORDER = :cross_border
+        DK_NETS = :dk_nets
+        EFT = :eft
+        ETHEREUM = :ethereum
+        HU_ICS = :hu_ics
+        INTERAC = :interac
+        MASAV = :masav
+        MX_CCEN = :mx_ccen
+        NEFT = :neft
+        NICS = :nics
+        NZ_BECS = :nz_becs
+        PL_ELIXIR = :pl_elixir
+        POLYGON = :polygon
+        PROVXCHANGE = :provxchange
+        RO_SENT = :ro_sent
+        RTP = :rtp
+        SE_BANKGIROT = :se_bankgirot
+        SEN = :sen
+        SEPA = :sepa
+        SG_GIRO = :sg_giro
+        SIC = :sic
+        SIGNET = :signet
+        SKNBI = :sknbi
+        SOLANA = :solana
+        WIRE = :wire
+        ZENGIN = :zengin
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/internal_accounts/balance_report_retrieve_params.rb

@@ -16,6 +16,29 @@ module ModernTreasury
         # @!method initialize(internal_account_id:, request_options: {})
         #   @param internal_account_id [String]
         #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+
+        module ID
+          extend ModernTreasury::Internal::Type::Union
+
+          variant String
+
+          variant const: -> { ModernTreasury::Models::InternalAccounts::BalanceReportRetrieveParams::ID::LATEST }
+
+          # @!method self.variants
+          #   @return [Array(String, Symbol)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias do
+              T.any(String, ModernTreasury::InternalAccounts::BalanceReportRetrieveParams::ID::TaggedSymbol)
+            end
+          end
+
+          # @!group
+
+          LATEST = :latest
+
+          # @!endgroup
+        end
       end
     end
   end

data/lib/modern_treasury/models/invoice.rb

@@ -26,9 +26,8 @@ module ModernTreasury
       # @!attribute contact_details
       #   The invoicer's contact details displayed at the top of the invoice.
       #
-      #   @return [Array<ModernTreasury::Models::Invoice::ContactDetail>]
-      required :contact_details,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Invoice::ContactDetail] }
+      #   @return [Array<ModernTreasury::Models::ContactDetail>]
+      required :contact_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetail] }
 
       # @!attribute counterparty_billing_address
       #   The counterparty's billing address.
@@ -101,6 +100,13 @@ module ModernTreasury
       #   @return [ModernTreasury::Models::Invoice::InvoicerAddress, nil]
       required :invoicer_address, -> { ModernTreasury::Invoice::InvoicerAddress }, nil?: true
 
+      # @!attribute invoicer_name
+      #   The name of the issuer for the invoice. Defaults to the name of the
+      #   Organization.
+      #
+      #   @return [String, nil]
+      required :invoicer_name, String, nil?: true
+
       # @!attribute ledger_account_settlement_id
       #   The ledger account settlement object linked to the invoice.
       #
@@ -244,7 +250,7 @@ module ModernTreasury
       #   @return [String, nil]
       required :virtual_account_id, String, nil?: true
 
-      # @!method initialize(id:, amount_paid:, amount_remaining:, contact_details:, counterparty_billing_address:, counterparty_id:, counterparty_shipping_address:, created_at:, currency:, description:, due_date:, expected_payments:, fallback_payment_method:, hosted_url:, invoicer_address:, ledger_account_settlement_id:, live_mode:, metadata:, notification_email_addresses:, notifications_enabled:, number:, object:, originating_account_id:, payment_effective_date:, payment_method:, payment_orders:, payment_type:, pdf_url:, receiving_account_id:, recipient_email:, recipient_name:, remind_after_overdue_days:, status:, total_amount:, transaction_line_item_ids:, updated_at:, virtual_account_id:)
+      # @!method initialize(id:, amount_paid:, amount_remaining:, contact_details:, counterparty_billing_address:, counterparty_id:, counterparty_shipping_address:, created_at:, currency:, description:, due_date:, expected_payments:, fallback_payment_method:, hosted_url:, invoicer_address:, invoicer_name:, ledger_account_settlement_id:, live_mode:, metadata:, notification_email_addresses:, notifications_enabled:, number:, object:, originating_account_id:, payment_effective_date:, payment_method:, payment_orders:, payment_type:, pdf_url:, receiving_account_id:, recipient_email:, recipient_name:, remind_after_overdue_days:, status:, total_amount:, transaction_line_item_ids:, updated_at:, virtual_account_id:)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::Invoice} for more details.
       #
@@ -254,7 +260,7 @@ module ModernTreasury
       #
       #   @param amount_remaining [Integer] Amount remaining due on the invoice in specified currency's smallest unit, e.g.,
       #
-      #   @param contact_details [Array<ModernTreasury::Models::Invoice::ContactDetail>] The invoicer's contact details displayed at the top of the invoice.
+      #   @param contact_details [Array<ModernTreasury::Models::ContactDetail>] The invoicer's contact details displayed at the top of the invoice.
       #
       #   @param counterparty_billing_address [ModernTreasury::Models::Invoice::CounterpartyBillingAddress, nil] The counterparty's billing address.
       #
@@ -278,6 +284,8 @@ module ModernTreasury
       #
       #   @param invoicer_address [ModernTreasury::Models::Invoice::InvoicerAddress, nil] The invoice issuer's business address.
       #
+      #   @param invoicer_name [String, nil] The name of the issuer for the invoice. Defaults to the name of the Organization
+      #
       #   @param ledger_account_settlement_id [String, nil] The ledger account settlement object linked to the invoice.
       #
       #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
@@ -322,83 +330,6 @@ module ModernTreasury
       #
       #   @param virtual_account_id [String, nil] The ID of the virtual account the invoice should be paid to.
 
-      class ContactDetail < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute contact_identifier
-        #
-        #   @return [String]
-        required :contact_identifier, String
-
-        # @!attribute contact_identifier_type
-        #
-        #   @return [Symbol, ModernTreasury::Models::Invoice::ContactDetail::ContactIdentifierType]
-        required :contact_identifier_type,
-                 enum: -> { ModernTreasury::Invoice::ContactDetail::ContactIdentifierType }
-
-        # @!attribute created_at
-        #
-        #   @return [Time]
-        required :created_at, Time
-
-        # @!attribute discarded_at
-        #
-        #   @return [Time, nil]
-        required :discarded_at, Time, nil?: true
-
-        # @!attribute live_mode
-        #   This field will be true if this object exists in the live environment or false
-        #   if it exists in the test environment.
-        #
-        #   @return [Boolean]
-        required :live_mode, ModernTreasury::Internal::Type::Boolean
-
-        # @!attribute object
-        #
-        #   @return [String]
-        required :object, String
-
-        # @!attribute updated_at
-        #
-        #   @return [Time]
-        required :updated_at, Time
-
-        # @!method initialize(id:, contact_identifier:, contact_identifier_type:, created_at:, discarded_at:, live_mode:, object:, updated_at:)
-        #   Some parameter documentations has been truncated, see
-        #   {ModernTreasury::Models::Invoice::ContactDetail} for more details.
-        #
-        #   @param id [String]
-        #
-        #   @param contact_identifier [String]
-        #
-        #   @param contact_identifier_type [Symbol, ModernTreasury::Models::Invoice::ContactDetail::ContactIdentifierType]
-        #
-        #   @param created_at [Time]
-        #
-        #   @param discarded_at [Time, nil]
-        #
-        #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
-        #
-        #   @param object [String]
-        #
-        #   @param updated_at [Time]
-
-        # @see ModernTreasury::Models::Invoice::ContactDetail#contact_identifier_type
-        module ContactIdentifierType
-          extend ModernTreasury::Internal::Type::Enum
-
-          EMAIL = :email
-          PHONE_NUMBER = :phone_number
-          WEBSITE = :website
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       # @see ModernTreasury::Models::Invoice#counterparty_billing_address
       class CounterpartyBillingAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country

data/lib/modern_treasury/models/invoice_create_params.rb

@@ -36,11 +36,8 @@ module ModernTreasury
       # @!attribute contact_details
       #   The invoicer's contact details displayed at the top of the invoice.
       #
-      #   @return [Array<ModernTreasury::Models::InvoiceCreateParams::ContactDetail>, nil]
-      optional :contact_details,
-               -> {
-                 ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::InvoiceCreateParams::ContactDetail]
-               }
+      #   @return [Array<ModernTreasury::Models::ContactDetail>, nil]
+      optional :contact_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetail] }
 
       # @!attribute counterparty_billing_address
       #   The counterparty's billing address.
@@ -203,7 +200,7 @@ module ModernTreasury
       #
       #   @param auto_advance [Boolean, nil] When true, the invoice will progress to unpaid automatically and cannot be edite
       #
-      #   @param contact_details [Array<ModernTreasury::Models::InvoiceCreateParams::ContactDetail>] The invoicer's contact details displayed at the top of the invoice.
+      #   @param contact_details [Array<ModernTreasury::Models::ContactDetail>] The invoicer's contact details displayed at the top of the invoice.
       #
       #   @param counterparty_billing_address [ModernTreasury::Models::InvoiceCreateParams::CounterpartyBillingAddress, nil] The counterparty's billing address.
       #
@@ -247,83 +244,6 @@ module ModernTreasury
       #
       #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
-      class ContactDetail < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute contact_identifier
-        #
-        #   @return [String]
-        required :contact_identifier, String
-
-        # @!attribute contact_identifier_type
-        #
-        #   @return [Symbol, ModernTreasury::Models::InvoiceCreateParams::ContactDetail::ContactIdentifierType]
-        required :contact_identifier_type,
-                 enum: -> { ModernTreasury::InvoiceCreateParams::ContactDetail::ContactIdentifierType }
-
-        # @!attribute created_at
-        #
-        #   @return [Time]
-        required :created_at, Time
-
-        # @!attribute discarded_at
-        #
-        #   @return [Time, nil]
-        required :discarded_at, Time, nil?: true
-
-        # @!attribute live_mode
-        #   This field will be true if this object exists in the live environment or false
-        #   if it exists in the test environment.
-        #
-        #   @return [Boolean]
-        required :live_mode, ModernTreasury::Internal::Type::Boolean
-
-        # @!attribute object
-        #
-        #   @return [String]
-        required :object, String
-
-        # @!attribute updated_at
-        #
-        #   @return [Time]
-        required :updated_at, Time
-
-        # @!method initialize(id:, contact_identifier:, contact_identifier_type:, created_at:, discarded_at:, live_mode:, object:, updated_at:)
-        #   Some parameter documentations has been truncated, see
-        #   {ModernTreasury::Models::InvoiceCreateParams::ContactDetail} for more details.
-        #
-        #   @param id [String]
-        #
-        #   @param contact_identifier [String]
-        #
-        #   @param contact_identifier_type [Symbol, ModernTreasury::Models::InvoiceCreateParams::ContactDetail::ContactIdentifierType]
-        #
-        #   @param created_at [Time]
-        #
-        #   @param discarded_at [Time, nil]
-        #
-        #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
-        #
-        #   @param object [String]
-        #
-        #   @param updated_at [Time]
-
-        # @see ModernTreasury::Models::InvoiceCreateParams::ContactDetail#contact_identifier_type
-        module ContactIdentifierType
-          extend ModernTreasury::Internal::Type::Enum
-
-          EMAIL = :email
-          PHONE_NUMBER = :phone_number
-          WEBSITE = :website
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       class CounterpartyBillingAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]