modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/external_account_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # Can be `checking`, `savings` or `other`.
+    module ExternalAccountType
+      extend ModernTreasury::Enum
+
+      CASH = :cash
+      CHECKING = :checking
+      GENERAL_LEDGER = :general_ledger
+      LOAN = :loan
+      NON_RESIDENT = :non_resident
+      OTHER = :other
+      OVERDRAFT = :overdraft
+      SAVINGS = :savings
+
+      finalize!
+
+      # @!parse
+      #   # @return [Array<Symbol>]
+      #   def self.values; end
+    end
+  end
+end

data/lib/modern_treasury/models/external_account_update_params.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ExternalAccountUpdateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute [r] account_type
+      #   Can be `checking`, `savings` or `other`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountType, nil]
+      optional :account_type, enum: -> { ModernTreasury::Models::ExternalAccountType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::ExternalAccountType]
+      #   attr_writer :account_type
+
+      # @!attribute counterparty_id
+      #
+      #   @return [String, nil]
+      optional :counterparty_id, String, nil?: true
+
+      # @!attribute [r] metadata
+      #   Additional data in the form of key-value pairs. Pairs can be removed by passing
+      #     an empty string or `null` as the value.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!attribute name
+      #   A nickname for the external account. This is only for internal usage and won't
+      #     affect any payments
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute [r] party_address
+      #
+      #   @return [ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress, nil]
+      optional :party_address, -> { ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress }
+
+      # @!parse
+      #   # @return [ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress]
+      #   attr_writer :party_address
+
+      # @!attribute [r] party_name
+      #   If this value isn't provided, it will be inherited from the counterparty's name.
+      #
+      #   @return [String, nil]
+      optional :party_name, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :party_name
+
+      # @!attribute party_type
+      #   Either `individual` or `business`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountUpdateParams::PartyType, nil]
+      optional :party_type,
+               enum: -> { ModernTreasury::Models::ExternalAccountUpdateParams::PartyType },
+               nil?: true
+
+      # @!parse
+      #   # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType]
+      #   # @param counterparty_id [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param name [String, nil]
+      #   # @param party_address [ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress]
+      #   # @param party_name [String]
+      #   # @param party_type [Symbol, ModernTreasury::Models::ExternalAccountUpdateParams::PartyType, nil]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     account_type: nil,
+      #     counterparty_id: nil,
+      #     metadata: nil,
+      #     name: nil,
+      #     party_address: nil,
+      #     party_name: nil,
+      #     party_type: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class PartyAddress < ModernTreasury::BaseModel
+        # @!attribute country
+        #   Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute line1
+        #
+        #   @return [String, nil]
+        optional :line1, String, nil?: true
+
+        # @!attribute line2
+        #
+        #   @return [String, nil]
+        optional :line2, String, nil?: true
+
+        # @!attribute locality
+        #   Locality or City.
+        #
+        #   @return [String, nil]
+        optional :locality, String, nil?: true
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, nil?: true
+
+        # @!attribute region
+        #   Region or State.
+        #
+        #   @return [String, nil]
+        optional :region, String, nil?: true
+
+        # @!parse
+        #   # @param country [String, nil]
+        #   # @param line1 [String, nil]
+        #   # @param line2 [String, nil]
+        #   # @param locality [String, nil]
+        #   # @param postal_code [String, nil]
+        #   # @param region [String, nil]
+        #   #
+        #   def initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+
+      # Either `individual` or `business`.
+      module PartyType
+        extend ModernTreasury::Enum
+
+        BUSINESS = :business
+        INDIVIDUAL = :individual
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/external_account_verify_params.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ExternalAccountVerifyParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute originating_account_id
+      #   The ID of the internal account where the micro-deposits originate from. Both
+      #     credit and debit capabilities must be enabled.
+      #
+      #   @return [String]
+      required :originating_account_id, String
+
+      # @!attribute payment_type
+      #   Can be `ach`, `eft`, or `rtp`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::PaymentType]
+      required :payment_type, enum: -> { ModernTreasury::Models::ExternalAccountVerifyParams::PaymentType }
+
+      # @!attribute [r] currency
+      #   Defaults to the currency of the originating account.
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency, nil]
+      optional :currency, enum: -> { ModernTreasury::Models::Currency }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::Currency]
+      #   attr_writer :currency
+
+      # @!attribute [r] fallback_type
+      #   A payment type to fallback to if the original type is not valid for the
+      #     receiving account. Currently, this only supports falling back from RTP to ACH
+      #     (payment_type=rtp and fallback_type=ach)
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType, nil]
+      optional :fallback_type, enum: -> { ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType]
+      #   attr_writer :fallback_type
+
+      # @!attribute [r] priority
+      #   Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
+      #     transfer. This will apply to both `payment_type` and `fallback_type`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::Priority, nil]
+      optional :priority, enum: -> { ModernTreasury::Models::ExternalAccountVerifyParams::Priority }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::Priority]
+      #   attr_writer :priority
+
+      # @!parse
+      #   # @param originating_account_id [String]
+      #   # @param payment_type [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::PaymentType]
+      #   # @param currency [Symbol, ModernTreasury::Models::Currency]
+      #   # @param fallback_type [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType]
+      #   # @param priority [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::Priority]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     originating_account_id:,
+      #     payment_type:,
+      #     currency: nil,
+      #     fallback_type: nil,
+      #     priority: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # Can be `ach`, `eft`, or `rtp`.
+      module PaymentType
+        extend ModernTreasury::Enum
+
+        ACH = :ach
+        AU_BECS = :au_becs
+        BACS = :bacs
+        BOOK = :book
+        CARD = :card
+        CHATS = :chats
+        CHECK = :check
+        CROSS_BORDER = :cross_border
+        DK_NETS = :dk_nets
+        EFT = :eft
+        HU_ICS = :hu_ics
+        INTERAC = :interac
+        MASAV = :masav
+        MX_CCEN = :mx_ccen
+        NEFT = :neft
+        NICS = :nics
+        NZ_BECS = :nz_becs
+        PL_ELIXIR = :pl_elixir
+        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
+        WIRE = :wire
+        ZENGIN = :zengin
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # A payment type to fallback to if the original type is not valid for the
+      #   receiving account. Currently, this only supports falling back from RTP to ACH
+      #   (payment_type=rtp and fallback_type=ach)
+      module FallbackType
+        extend ModernTreasury::Enum
+
+        ACH = :ach
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
+      #   transfer. This will apply to both `payment_type` and `fallback_type`.
+      module Priority
+        extend ModernTreasury::Enum
+
+        HIGH = :high
+        NORMAL = :normal
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/external_account_verify_response.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    module ExternalAccountVerifyResponse
+      extend ModernTreasury::Union
+
+      variant -> { ModernTreasury::Models::ExternalAccount }
+
+      variant -> { ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt }
+
+      class ExternalAccountVerificationAttempt < ModernTreasury::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute external_account_id
+        #   The ID of the external account.
+        #
+        #   @return [String]
+        required :external_account_id, String
+
+        # @!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::BooleanModel
+
+        # @!attribute object
+        #
+        #   @return [String]
+        required :object, String
+
+        # @!attribute originating_account_id
+        #   The ID of the internal account where the micro-deposits originate from.
+        #
+        #   @return [String]
+        required :originating_account_id, String
+
+        # @!attribute payment_type
+        #   The type of payment that can be made to this account. Can be `ach`, `eft`, or
+        #     `rtp`.
+        #
+        #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType]
+        required :payment_type,
+                 enum: -> { ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType }
+
+        # @!attribute priority
+        #   The priority of the payment. Can be `normal` or `high`.
+        #
+        #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority, nil]
+        required :priority,
+                 enum: -> { ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority },
+                 nil?: true
+
+        # @!attribute status
+        #   The status of the verification attempt. Can be `pending_verification`,
+        #     `verified`, `failed`, or `cancelled`.
+        #
+        #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status]
+        required :status,
+                 enum: -> { ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!parse
+        #   # @param id [String]
+        #   # @param created_at [Time]
+        #   # @param external_account_id [String]
+        #   # @param live_mode [Boolean]
+        #   # @param object [String]
+        #   # @param originating_account_id [String]
+        #   # @param payment_type [Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::PaymentType]
+        #   # @param priority [Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Priority, nil]
+        #   # @param status [Symbol, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt::Status]
+        #   # @param updated_at [Time]
+        #   #
+        #   def initialize(
+        #     id:,
+        #     created_at:,
+        #     external_account_id:,
+        #     live_mode:,
+        #     object:,
+        #     originating_account_id:,
+        #     payment_type:,
+        #     priority:,
+        #     status:,
+        #     updated_at:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+        # The type of payment that can be made to this account. Can be `ach`, `eft`, or
+        #   `rtp`.
+        module PaymentType
+          extend ModernTreasury::Enum
+
+          ACH = :ach
+          AU_BECS = :au_becs
+          BACS = :bacs
+          BOOK = :book
+          CARD = :card
+          CHATS = :chats
+          CHECK = :check
+          CROSS_BORDER = :cross_border
+          DK_NETS = :dk_nets
+          EFT = :eft
+          HU_ICS = :hu_ics
+          INTERAC = :interac
+          MASAV = :masav
+          MX_CCEN = :mx_ccen
+          NEFT = :neft
+          NICS = :nics
+          NZ_BECS = :nz_becs
+          PL_ELIXIR = :pl_elixir
+          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
+          WIRE = :wire
+          ZENGIN = :zengin
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        # The priority of the payment. Can be `normal` or `high`.
+        module Priority
+          extend ModernTreasury::Enum
+
+          HIGH = :high
+          NORMAL = :normal
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        # The status of the verification attempt. Can be `pending_verification`,
+        #   `verified`, `failed`, or `cancelled`.
+        module Status
+          extend ModernTreasury::Enum
+
+          CANCELLED = :cancelled
+          FAILED = :failed
+          PENDING_VERIFICATION = :pending_verification
+          VERIFIED = :verified
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+
+      # @!parse
+      #   # @return [Array(ModernTreasury::Models::ExternalAccount, ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt)]
+      #   def self.variants; end
+    end
+  end
+end

data/lib/modern_treasury/models/foreign_exchange_quote.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ForeignExchangeQuote < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute effective_at
+      #   The timestamp until when the quoted rate is valid.
+      #
+      #   @return [Time]
+      required :effective_at, Time
+
+      # @!attribute expires_at
+      #   The timestamp until which the quote must be booked by.
+      #
+      #   @return [Time]
+      required :expires_at, Time
+
+      # @!attribute foreign_exchange_indicator
+      #   Either `fixed_to_variable` if the `base_amount` was specified, or
+      #     `variable_to_fixed` if the `target_amount` was specified when requesting the
+      #     quote.
+      #
+      #   @return [String]
+      required :foreign_exchange_indicator, String
+
+      # @!attribute foreign_exchange_rate
+      #   The serialized rate information represented by this quote.
+      #
+      #   @return [ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate]
+      required :foreign_exchange_rate, -> { ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate }
+
+      # @!attribute internal_account_id
+      #   The ID for the `InternalAccount` this quote is associated with.
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!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::BooleanModel
+
+      # @!attribute metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, ModernTreasury::HashOf[String]
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute [r] vendor_id
+      #   This vendor assigned ID for this quote.
+      #
+      #   @return [String, nil]
+      optional :vendor_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :vendor_id
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param created_at [Time]
+      #   # @param effective_at [Time]
+      #   # @param expires_at [Time]
+      #   # @param foreign_exchange_indicator [String]
+      #   # @param foreign_exchange_rate [ModernTreasury::Models::ForeignExchangeQuote::ForeignExchangeRate]
+      #   # @param internal_account_id [String]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param object [String]
+      #   # @param updated_at [Time]
+      #   # @param vendor_id [String]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     created_at:,
+      #     effective_at:,
+      #     expires_at:,
+      #     foreign_exchange_indicator:,
+      #     foreign_exchange_rate:,
+      #     internal_account_id:,
+      #     live_mode:,
+      #     metadata:,
+      #     object:,
+      #     updated_at:,
+      #     vendor_id: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class ForeignExchangeRate < ModernTreasury::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::Models::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::Models::Currency }
+
+        # @!attribute value
+        #   The whole number component of the rate. The decimal is calculated as `value` /
+        #     (10 ^ `exponent`).
+        #
+        #   @return [Integer]
+        required :value, Integer
+
+        # @!parse
+        #   # The serialized rate information represented by this quote.
+        #   #
+        #   # @param base_amount [Integer]
+        #   # @param base_currency [Symbol, ModernTreasury::Models::Currency]
+        #   # @param exponent [Integer]
+        #   # @param rate_string [String]
+        #   # @param target_amount [Integer]
+        #   # @param target_currency [Symbol, ModernTreasury::Models::Currency]
+        #   # @param value [Integer]
+        #   #
+        #   def initialize(base_amount:, base_currency:, exponent:, rate_string:, target_amount:, target_currency:, value:, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+    end
+  end
+end