modern_treasury 0.1.0.pre.alpha.21 → 0.1.0

data/lib/modern_treasury/models/foreign_exchange_quote.rb

@@ -37,8 +37,8 @@ module ModernTreasury
       # @!attribute foreign_exchange_rate
       #   The serialized rate information represented by this quote.
       #
-      #   @return [ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate]
-      required :foreign_exchange_rate, -> { ModernTreasury::ForeignExchangeQuote::ForeignExchangeRate }
+      #   @return [ModernTreasury::Models::ForeignExchangeRate]
+      required :foreign_exchange_rate, -> { ModernTreasury::ForeignExchangeRate }
 
       # @!attribute internal_account_id
       #   The ID for the `InternalAccount` this quote is associated with.
@@ -90,7 +90,7 @@ module ModernTreasury
       #
       #   @param foreign_exchange_indicator [String] Either `fixed_to_variable` if the `base_amount` was specified, or `variable_to_f
       #
-      #   @param foreign_exchange_rate [ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate] The serialized rate information represented by this quote.
+      #   @param foreign_exchange_rate [ModernTreasury::Models::ForeignExchangeRate] The serialized rate information represented by this quote.
       #
       #   @param internal_account_id [String] The ID for the `InternalAccount` this quote is associated with.
       #
@@ -103,76 +103,6 @@ module ModernTreasury
       #   @param updated_at [Time]
       #
       #   @param vendor_id [String] This vendor assigned ID for this quote.
-
-      # @see ModernTreasury::Models::ForeignExchangeQuote#foreign_exchange_rate
-      class ForeignExchangeRate < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute base_amount
-        #   Amount in the lowest denomination of the `base_currency` to convert, often
-        #   called the "sell" amount.
-        #
-        #   @return [Integer]
-        required :base_amount, Integer
-
-        # @!attribute base_currency
-        #   Currency to convert, often called the "sell" currency.
-        #
-        #   @return [Symbol, ModernTreasury::Models::Currency]
-        required :base_currency, enum: -> { ModernTreasury::Currency }
-
-        # @!attribute exponent
-        #   The exponent component of the rate. The decimal is calculated as `value` / (10 ^
-        #   `exponent`).
-        #
-        #   @return [Integer]
-        required :exponent, Integer
-
-        # @!attribute rate_string
-        #   A string representation of the rate.
-        #
-        #   @return [String]
-        required :rate_string, String
-
-        # @!attribute target_amount
-        #   Amount in the lowest denomination of the `target_currency`, often called the
-        #   "buy" amount.
-        #
-        #   @return [Integer]
-        required :target_amount, Integer
-
-        # @!attribute target_currency
-        #   Currency to convert the `base_currency` to, often called the "buy" currency.
-        #
-        #   @return [Symbol, ModernTreasury::Models::Currency]
-        required :target_currency, enum: -> { ModernTreasury::Currency }
-
-        # @!attribute value
-        #   The whole number component of the rate. The decimal is calculated as `value` /
-        #   (10 ^ `exponent`).
-        #
-        #   @return [Integer]
-        required :value, Integer
-
-        # @!method initialize(base_amount:, base_currency:, exponent:, rate_string:, target_amount:, target_currency:, value:)
-        #   Some parameter documentations has been truncated, see
-        #   {ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate} for more
-        #   details.
-        #
-        #   The serialized rate information represented by this quote.
-        #
-        #   @param base_amount [Integer] Amount in the lowest denomination of the `base_currency` to convert, often calle
-        #
-        #   @param base_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert, often called the "sell" currency.
-        #
-        #   @param exponent [Integer] The exponent component of the rate. The decimal is calculated as `value` / (10 ^
-        #
-        #   @param rate_string [String] A string representation of the rate.
-        #
-        #   @param target_amount [Integer] Amount in the lowest denomination of the `target_currency`, often called the "bu
-        #
-        #   @param target_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert the `base_currency` to, often called the "buy" currency.
-        #
-        #   @param value [Integer] The whole number component of the rate. The decimal is calculated as `value` / (
-      end
     end
   end
 end

data/lib/modern_treasury/models/foreign_exchange_rate.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ForeignExchangeRate < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute base_amount
+      #   Amount in the lowest denomination of the `base_currency` to convert, often
+      #   called the "sell" amount.
+      #
+      #   @return [Integer]
+      required :base_amount, Integer
+
+      # @!attribute base_currency
+      #   Currency to convert, often called the "sell" currency.
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency]
+      required :base_currency, enum: -> { ModernTreasury::Currency }
+
+      # @!attribute exponent
+      #   The exponent component of the rate. The decimal is calculated as `value` / (10 ^
+      #   `exponent`).
+      #
+      #   @return [Integer]
+      required :exponent, Integer
+
+      # @!attribute rate_string
+      #   A string representation of the rate.
+      #
+      #   @return [String]
+      required :rate_string, String
+
+      # @!attribute target_amount
+      #   Amount in the lowest denomination of the `target_currency`, often called the
+      #   "buy" amount.
+      #
+      #   @return [Integer]
+      required :target_amount, Integer
+
+      # @!attribute target_currency
+      #   Currency to convert the `base_currency` to, often called the "buy" currency.
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency]
+      required :target_currency, enum: -> { ModernTreasury::Currency }
+
+      # @!attribute value
+      #   The whole number component of the rate. The decimal is calculated as `value` /
+      #   (10 ^ `exponent`).
+      #
+      #   @return [Integer]
+      required :value, Integer
+
+      # @!method initialize(base_amount:, base_currency:, exponent:, rate_string:, target_amount:, target_currency:, value:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::ForeignExchangeRate} for more details.
+      #
+      #   @param base_amount [Integer] Amount in the lowest denomination of the `base_currency` to convert, often calle
+      #
+      #   @param base_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert, often called the "sell" currency.
+      #
+      #   @param exponent [Integer] The exponent component of the rate. The decimal is calculated as `value` / (10 ^
+      #
+      #   @param rate_string [String] A string representation of the rate.
+      #
+      #   @param target_amount [Integer] Amount in the lowest denomination of the `target_currency`, often called the "bu
+      #
+      #   @param target_currency [Symbol, ModernTreasury::Models::Currency] Currency to convert the `base_currency` to, often called the "buy" currency.
+      #
+      #   @param value [Integer] The whole number component of the rate. The decimal is calculated as `value` / (
+    end
+  end
+end

data/lib/modern_treasury/models/identification_create_request.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class IdentificationCreateRequest < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id_number
+      #   The ID number of identification document.
+      #
+      #   @return [String]
+      required :id_number, String
+
+      # @!attribute id_type
+      #   The type of ID number.
+      #
+      #   @return [Symbol, ModernTreasury::Models::IdentificationCreateRequest::IDType]
+      required :id_type, enum: -> { ModernTreasury::IdentificationCreateRequest::IDType }
+
+      # @!attribute expiration_date
+      #   The date when the Identification is no longer considered valid by the issuing
+      #   authority.
+      #
+      #   @return [Date, nil]
+      optional :expiration_date, Date, nil?: true
+
+      # @!attribute issuing_country
+      #   The ISO 3166-1 alpha-2 country code of the country that issued the
+      #   identification
+      #
+      #   @return [String, nil]
+      optional :issuing_country, String, nil?: true
+
+      # @!attribute issuing_region
+      #   The region in which the identifcation was issued.
+      #
+      #   @return [String, nil]
+      optional :issuing_region, String, nil?: true
+
+      # @!method initialize(id_number:, id_type:, expiration_date: nil, issuing_country: nil, issuing_region: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::IdentificationCreateRequest} for more details.
+      #
+      #   @param id_number [String] The ID number of identification document.
+      #
+      #   @param id_type [Symbol, ModernTreasury::Models::IdentificationCreateRequest::IDType] The type of ID number.
+      #
+      #   @param expiration_date [Date, nil] The date when the Identification is no longer considered valid by the issuing au
+      #
+      #   @param issuing_country [String, nil] The ISO 3166-1 alpha-2 country code of the country that issued the identificatio
+      #
+      #   @param issuing_region [String, nil] The region in which the identifcation was issued.
+
+      # The type of ID number.
+      #
+      # @see ModernTreasury::Models::IdentificationCreateRequest#id_type
+      module IDType
+        extend ModernTreasury::Internal::Type::Enum
+
+        AR_CUIL = :ar_cuil
+        AR_CUIT = :ar_cuit
+        BR_CNPJ = :br_cnpj
+        BR_CPF = :br_cpf
+        CL_RUN = :cl_run
+        CL_RUT = :cl_rut
+        CO_CEDULAS = :co_cedulas
+        CO_NIT = :co_nit
+        DRIVERS_LICENSE = :drivers_license
+        HN_ID = :hn_id
+        HN_RTN = :hn_rtn
+        IN_LEI = :in_lei
+        KR_BRN = :kr_brn
+        KR_CRN = :kr_crn
+        KR_RRN = :kr_rrn
+        PASSPORT = :passport
+        SA_TIN = :sa_tin
+        SA_VAT = :sa_vat
+        US_EIN = :us_ein
+        US_ITIN = :us_itin
+        US_SSN = :us_ssn
+        VN_TIN = :vn_tin
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/incoming_payment_detail.rb

@@ -260,6 +260,7 @@ module ModernTreasury
         HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
         HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
         ID_SKNBI_CODE = :id_sknbi_code
+        IL_BANK_CODE = :il_bank_code
         IN_IFSC = :in_ifsc
         JP_ZENGIN_CODE = :jp_zengin_code
         MX_BANK_IDENTIFIER = :mx_bank_identifier

data/lib/modern_treasury/models/internal_account.rb

@@ -9,6 +9,16 @@ module ModernTreasury
       #   @return [String]
       required :id, 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::InternalAccount::AccountCapability>]
+      required :account_capabilities,
+               -> {
+                 ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::InternalAccount::AccountCapability]
+               }
+
       # @!attribute account_details
       #   An array of account detail objects.
       #
@@ -52,7 +62,7 @@ module ModernTreasury
       required :ledger_account_id, String, nil?: true
 
       # @!attribute legal_entity_id
-      #   The Legal Entity associated to this account
+      #   The Legal Entity associated to this account.
       #
       #   @return [String, nil]
       required :legal_entity_id, String, nil?: true
@@ -91,8 +101,8 @@ module ModernTreasury
       # @!attribute party_address
       #   The address associated with the owner or null.
       #
-      #   @return [ModernTreasury::Models::InternalAccount::PartyAddress, nil]
-      required :party_address, -> { ModernTreasury::InternalAccount::PartyAddress }, nil?: true
+      #   @return [ModernTreasury::Models::Address, nil]
+      required :party_address, -> { ModernTreasury::Address }, nil?: true
 
       # @!attribute party_name
       #   The legal name of the entity which owns the account.
@@ -117,12 +127,20 @@ module ModernTreasury
       #   @return [Time]
       required :updated_at, Time
 
-      # @!method initialize(id:, account_details:, account_type:, connection:, counterparty_id:, created_at:, currency:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, updated_at:)
+      # @!attribute vendor_id
+      #   The vendor ID associated with this account.
+      #
+      #   @return [String, nil]
+      required :vendor_id, String, nil?: true
+
+      # @!method initialize(id:, account_capabilities:, account_details:, account_type:, connection:, counterparty_id:, created_at:, currency:, ledger_account_id:, legal_entity_id:, live_mode:, metadata:, name:, object:, parent_account_id:, party_address:, party_name:, party_type:, routing_details:, updated_at:, vendor_id:)
       #   Some parameter documentations has been truncated, see
       #   {ModernTreasury::Models::InternalAccount} for more details.
       #
       #   @param id [String]
       #
+      #   @param account_capabilities [Array<ModernTreasury::Models::InternalAccount::AccountCapability>] An array of AccountCapability objects that list the originating abilities of the
+      #
       #   @param account_details [Array<ModernTreasury::Models::AccountDetail>] An array of account detail objects.
       #
       #   @param account_type [Symbol, ModernTreasury::Models::InternalAccount::AccountType, nil] Can be checking, savings or other.
@@ -137,7 +155,7 @@ module ModernTreasury
       #
       #   @param ledger_account_id [String, nil] If the internal account links to a ledger account in Modern Treasury, the id of
       #
-      #   @param legal_entity_id [String, nil] The Legal Entity associated to this account
+      #   @param legal_entity_id [String, nil] The Legal Entity associated to this account.
       #
       #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
       #
@@ -149,7 +167,7 @@ module ModernTreasury
       #
       #   @param parent_account_id [String, nil] The parent InternalAccount of this account.
       #
-      #   @param party_address [ModernTreasury::Models::InternalAccount::PartyAddress, nil] The address associated with the owner or null.
+      #   @param party_address [ModernTreasury::Models::Address, nil] The address associated with the owner or null.
       #
       #   @param party_name [String] The legal name of the entity which owns the account.
       #
@@ -158,58 +176,38 @@ module ModernTreasury
       #   @param routing_details [Array<ModernTreasury::Models::RoutingDetail>] An array of routing detail objects.
       #
       #   @param updated_at [Time]
-
-      # Can be checking, savings or other.
       #
-      # @see ModernTreasury::Models::InternalAccount#account_type
-      module AccountType
-        extend ModernTreasury::Internal::Type::Enum
+      #   @param vendor_id [String, nil] The vendor ID associated with this account.
 
-        BASE_WALLET = :base_wallet
-        CASH = :cash
-        CHECKING = :checking
-        CRYPTO_WALLET = :crypto_wallet
-        ETHEREUM_WALLET = :ethereum_wallet
-        GENERAL_LEDGER = :general_ledger
-        LOAN = :loan
-        NON_RESIDENT = :non_resident
-        OTHER = :other
-        OVERDRAFT = :overdraft
-        POLYGON_WALLET = :polygon_wallet
-        SAVINGS = :savings
-        SOLANA_WALLET = :solana_wallet
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @see ModernTreasury::Models::InternalAccount#party_address
-      class PartyAddress < ModernTreasury::Internal::Type::BaseModel
+      class AccountCapability < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
         required :id, String
 
-        # @!attribute country
-        #   Country code conforms to [ISO 3166-1 alpha-2]
-        #
-        #   @return [String, nil]
-        required :country, String, nil?: true
-
         # @!attribute created_at
         #
         #   @return [Time]
         required :created_at, Time
 
-        # @!attribute line1
+        # @!attribute direction
+        #   One of `debit` or `credit`. Indicates the direction of money movement this
+        #   capability is responsible for.
         #
-        #   @return [String, nil]
-        required :line1, String, nil?: true
+        #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+        required :direction, enum: -> { ModernTreasury::TransactionDirection }
 
-        # @!attribute line2
+        # @!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 :line2, String, nil?: true
+        required :identifier, String, nil?: true
 
         # @!attribute live_mode
         #   This field will be true if this object exists in the live environment or false
@@ -218,61 +216,114 @@ module ModernTreasury
         #   @return [Boolean]
         required :live_mode, ModernTreasury::Internal::Type::Boolean
 
-        # @!attribute locality
-        #   Locality or City.
-        #
-        #   @return [String, nil]
-        required :locality, String, nil?: true
-
         # @!attribute object
         #
         #   @return [String]
         required :object, String
 
-        # @!attribute postal_code
-        #   The postal code of the address.
+        # @!attribute payment_type
+        #   Indicates the the type of payment this capability is responsible for
+        #   originating.
         #
-        #   @return [String, nil]
-        required :postal_code, String, nil?: true
-
-        # @!attribute region
-        #   Region or State.
-        #
-        #   @return [String, nil]
-        required :region, String, nil?: true
+        #   @return [Symbol, ModernTreasury::Models::InternalAccount::AccountCapability::PaymentType]
+        required :payment_type, enum: -> { ModernTreasury::InternalAccount::AccountCapability::PaymentType }
 
         # @!attribute updated_at
         #
         #   @return [Time]
         required :updated_at, Time
 
-        # @!method initialize(id:, country:, created_at:, line1:, line2:, live_mode:, locality:, object:, postal_code:, region:, updated_at:)
+        # @!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::InternalAccount::PartyAddress} for more details.
-        #
-        #   The address associated with the owner or null.
+        #   {ModernTreasury::Models::InternalAccount::AccountCapability} for more details.
         #
         #   @param id [String]
         #
-        #   @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
-        #
         #   @param created_at [Time]
         #
-        #   @param line1 [String, nil]
+        #   @param direction [Symbol, ModernTreasury::Models::TransactionDirection] One of `debit` or `credit`. Indicates the direction of money movement this capab
         #
-        #   @param line2 [String, nil]
+        #   @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 identifier [String, nil] A unique reference assigned by your bank for tracking and recognizing payment fi
         #
-        #   @param locality [String, nil] Locality or City.
+        #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
         #
         #   @param object [String]
         #
-        #   @param postal_code [String, nil] The postal code of the address.
-        #
-        #   @param region [String, nil] Region or State.
+        #   @param payment_type [Symbol, ModernTreasury::Models::InternalAccount::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::InternalAccount::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
+
+      # Can be checking, savings or other.
+      #
+      # @see ModernTreasury::Models::InternalAccount#account_type
+      module AccountType
+        extend ModernTreasury::Internal::Type::Enum
+
+        BASE_WALLET = :base_wallet
+        CASH = :cash
+        CHECKING = :checking
+        CRYPTO_WALLET = :crypto_wallet
+        ETHEREUM_WALLET = :ethereum_wallet
+        GENERAL_LEDGER = :general_ledger
+        LOAN = :loan
+        NON_RESIDENT = :non_resident
+        OTHER = :other
+        OVERDRAFT = :overdraft
+        POLYGON_WALLET = :polygon_wallet
+        SAVINGS = :savings
+        SOLANA_WALLET = :solana_wallet
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # Either individual or business.