modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/foreign_exchange_quote_create_params.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ForeignExchangeQuoteCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute internal_account_id
+      #   The ID for the `InternalAccount` this quote is associated with.
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!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 [r] base_amount
+      #   Amount in the lowest denomination of the `base_currency` to convert, often
+      #     called the "sell" amount.
+      #
+      #   @return [Integer, nil]
+      optional :base_amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :base_amount
+
+      # @!attribute [r] base_currency
+      #   Currency to convert, often called the "sell" currency.
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency, nil]
+      optional :base_currency, enum: -> { ModernTreasury::Models::Currency }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::Currency]
+      #   attr_writer :base_currency
+
+      # @!attribute [r] effective_at
+      #   The timestamp until when the quoted rate is valid.
+      #
+      #   @return [Time, nil]
+      optional :effective_at, Time
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :effective_at
+
+      # @!attribute [r] target_amount
+      #   Amount in the lowest denomination of the `target_currency`, often called the
+      #     "buy" amount.
+      #
+      #   @return [Integer, nil]
+      optional :target_amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :target_amount
+
+      # @!parse
+      #   # @param internal_account_id [String]
+      #   # @param target_currency [Symbol, ModernTreasury::Models::Currency]
+      #   # @param base_amount [Integer]
+      #   # @param base_currency [Symbol, ModernTreasury::Models::Currency]
+      #   # @param effective_at [Time]
+      #   # @param target_amount [Integer]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     internal_account_id:,
+      #     target_currency:,
+      #     base_amount: nil,
+      #     base_currency: nil,
+      #     effective_at: nil,
+      #     target_amount: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/foreign_exchange_quote_list_params.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ForeignExchangeQuoteListParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute after_cursor
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String, nil?: true
+
+      # @!attribute [r] base_currency
+      #   Currency to convert, often called the "sell" currency.
+      #
+      #   @return [String, nil]
+      optional :base_currency, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :base_currency
+
+      # @!attribute [r] effective_at_end
+      #   An inclusive upper bound for searching effective_at
+      #
+      #   @return [Date, nil]
+      optional :effective_at_end, Date
+
+      # @!parse
+      #   # @return [Date]
+      #   attr_writer :effective_at_end
+
+      # @!attribute [r] effective_at_start
+      #   An inclusive lower bound for searching effective_at
+      #
+      #   @return [Date, nil]
+      optional :effective_at_start, Date
+
+      # @!parse
+      #   # @return [Date]
+      #   attr_writer :effective_at_start
+
+      # @!attribute [r] expires_at
+      #   The timestamp until which the quote must be booked by.
+      #
+      #   @return [Time, nil]
+      optional :expires_at, Time
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :expires_at
+
+      # @!attribute [r] internal_account_id
+      #   The ID for the `InternalAccount` this quote is associated with.
+      #
+      #   @return [String, nil]
+      optional :internal_account_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :internal_account_id
+
+      # @!attribute [r] metadata
+      #   For example, if you want to query for records with metadata key `Type` and value
+      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #     parameters.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!attribute [r] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!attribute [r] target_currency
+      #   Currency to convert the `base_currency` to, often called the "buy" currency.
+      #
+      #   @return [String, nil]
+      optional :target_currency, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :target_currency
+
+      # @!parse
+      #   # @param after_cursor [String, nil]
+      #   # @param base_currency [String]
+      #   # @param effective_at_end [Date]
+      #   # @param effective_at_start [Date]
+      #   # @param expires_at [Time]
+      #   # @param internal_account_id [String]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param per_page [Integer]
+      #   # @param target_currency [String]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     after_cursor: nil,
+      #     base_currency: nil,
+      #     effective_at_end: nil,
+      #     effective_at_start: nil,
+      #     expires_at: nil,
+      #     internal_account_id: nil,
+      #     metadata: nil,
+      #     per_page: nil,
+      #     target_currency: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/foreign_exchange_quote_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ForeignExchangeQuoteRetrieveParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!parse
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/incoming_payment_detail.rb

@@ -0,0 +1,320 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class IncomingPaymentDetail < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   Value in specified currency's smallest unit. e.g. $10 would be represented
+      #     as 1000.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute as_of_date
+      #   The date on which the corresponding transaction will occur.
+      #
+      #   @return [Date]
+      required :as_of_date, Date
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The currency of the incoming payment detail.
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency]
+      required :currency, enum: -> { ModernTreasury::Models::Currency }
+
+      # @!attribute data
+      #   The raw data from the payment pre-notification file that we get from the bank.
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :data, ModernTreasury::HashOf[ModernTreasury::Unknown]
+
+      # @!attribute direction
+      #   One of `credit` or `debit`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::TransactionDirection]
+      required :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
+
+      # @!attribute internal_account_id
+      #   The ID of the Internal Account for the incoming payment detail. This is always
+      #     present.
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!attribute ledger_transaction_id
+      #   The ID of the ledger transaction linked to the incoming payment detail or
+      #     `null`.
+      #
+      #   @return [String, nil]
+      required :ledger_transaction_id, 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::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 originating_account_number_safe
+      #   The last 4 digits of the originating account_number for the incoming payment
+      #     detail.
+      #
+      #   @return [String, nil]
+      required :originating_account_number_safe, String, nil?: true
+
+      # @!attribute originating_account_number_type
+      #   The type of the originating account number for the incoming payment detail.
+      #
+      #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetail::OriginatingAccountNumberType, nil]
+      required :originating_account_number_type,
+               enum: -> { ModernTreasury::Models::IncomingPaymentDetail::OriginatingAccountNumberType },
+               nil?: true
+
+      # @!attribute originating_routing_number
+      #   The routing number of the originating account for the incoming payment detail.
+      #
+      #   @return [String, nil]
+      required :originating_routing_number, String, nil?: true
+
+      # @!attribute originating_routing_number_type
+      #   The type of the originating routing number for the incoming payment detail.
+      #
+      #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetail::OriginatingRoutingNumberType, nil]
+      required :originating_routing_number_type,
+               enum: -> { ModernTreasury::Models::IncomingPaymentDetail::OriginatingRoutingNumberType },
+               nil?: true
+
+      # @!attribute status
+      #   The current status of the incoming payment order. One of `pending`, `completed`,
+      #     or `returned`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetail::Status]
+      required :status, enum: -> { ModernTreasury::Models::IncomingPaymentDetail::Status }
+
+      # @!attribute transaction_id
+      #   The ID of the reconciled Transaction or `null`.
+      #
+      #   @return [String, nil]
+      required :transaction_id, String, nil?: true
+
+      # @!attribute transaction_line_item_id
+      #   The ID of the reconciled Transaction Line Item or `null`.
+      #
+      #   @return [String, nil]
+      required :transaction_line_item_id, String, nil?: true
+
+      # @!attribute type
+      #   One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
+      #     `wire`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetail::Type]
+      required :type, enum: -> { ModernTreasury::Models::IncomingPaymentDetail::Type }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute vendor_id
+      #   The identifier of the vendor bank.
+      #
+      #   @return [String, nil]
+      required :vendor_id, String, nil?: true
+
+      # @!attribute virtual_account
+      #   If the incoming payment detail is in a virtual account, the serialized virtual
+      #     account object.
+      #
+      #   @return [ModernTreasury::Models::VirtualAccount, nil]
+      required :virtual_account, -> { ModernTreasury::Models::VirtualAccount }, nil?: true
+
+      # @!attribute virtual_account_id
+      #   If the incoming payment detail is in a virtual account, the ID of the Virtual
+      #     Account.
+      #
+      #   @return [String, nil]
+      required :virtual_account_id, String, nil?: true
+
+      # @!attribute originating_account_number
+      #   The account number of the originating account for the incoming payment detail.
+      #
+      #   @return [String, nil]
+      optional :originating_account_number, String, nil?: true
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param amount [Integer]
+      #   # @param as_of_date [Date]
+      #   # @param created_at [Time]
+      #   # @param currency [Symbol, ModernTreasury::Models::Currency]
+      #   # @param data [Hash{Symbol=>Object}]
+      #   # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
+      #   # @param internal_account_id [String]
+      #   # @param ledger_transaction_id [String, nil]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param object [String]
+      #   # @param originating_account_number_safe [String, nil]
+      #   # @param originating_account_number_type [Symbol, ModernTreasury::Models::IncomingPaymentDetail::OriginatingAccountNumberType, nil]
+      #   # @param originating_routing_number [String, nil]
+      #   # @param originating_routing_number_type [Symbol, ModernTreasury::Models::IncomingPaymentDetail::OriginatingRoutingNumberType, nil]
+      #   # @param status [Symbol, ModernTreasury::Models::IncomingPaymentDetail::Status]
+      #   # @param transaction_id [String, nil]
+      #   # @param transaction_line_item_id [String, nil]
+      #   # @param type [Symbol, ModernTreasury::Models::IncomingPaymentDetail::Type]
+      #   # @param updated_at [Time]
+      #   # @param vendor_id [String, nil]
+      #   # @param virtual_account [ModernTreasury::Models::VirtualAccount, nil]
+      #   # @param virtual_account_id [String, nil]
+      #   # @param originating_account_number [String, nil]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     amount:,
+      #     as_of_date:,
+      #     created_at:,
+      #     currency:,
+      #     data:,
+      #     direction:,
+      #     internal_account_id:,
+      #     ledger_transaction_id:,
+      #     live_mode:,
+      #     metadata:,
+      #     object:,
+      #     originating_account_number_safe:,
+      #     originating_account_number_type:,
+      #     originating_routing_number:,
+      #     originating_routing_number_type:,
+      #     status:,
+      #     transaction_id:,
+      #     transaction_line_item_id:,
+      #     type:,
+      #     updated_at:,
+      #     vendor_id:,
+      #     virtual_account:,
+      #     virtual_account_id:,
+      #     originating_account_number: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # The type of the originating account number for the incoming payment detail.
+      module OriginatingAccountNumberType
+        extend ModernTreasury::Enum
+
+        AU_NUMBER = :au_number
+        CLABE = :clabe
+        HK_NUMBER = :hk_number
+        IBAN = :iban
+        ID_NUMBER = :id_number
+        NZ_NUMBER = :nz_number
+        OTHER = :other
+        PAN = :pan
+        SG_NUMBER = :sg_number
+        WALLET_ADDRESS = :wallet_address
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # The type of the originating routing number for the incoming payment detail.
+      module OriginatingRoutingNumberType
+        extend ModernTreasury::Enum
+
+        ABA = :aba
+        AU_BSB = :au_bsb
+        BR_CODIGO = :br_codigo
+        CA_CPA = :ca_cpa
+        CHIPS = :chips
+        CNAPS = :cnaps
+        DK_INTERBANK_CLEARING_CODE = :dk_interbank_clearing_code
+        GB_SORT_CODE = :gb_sort_code
+        HK_INTERBANK_CLEARING_CODE = :hk_interbank_clearing_code
+        HU_INTERBANK_CLEARING_CODE = :hu_interbank_clearing_code
+        ID_SKNBI_CODE = :id_sknbi_code
+        IN_IFSC = :in_ifsc
+        JP_ZENGIN_CODE = :jp_zengin_code
+        MX_BANK_IDENTIFIER = :mx_bank_identifier
+        MY_BRANCH_CODE = :my_branch_code
+        NZ_NATIONAL_CLEARING_CODE = :nz_national_clearing_code
+        PL_NATIONAL_CLEARING_CODE = :pl_national_clearing_code
+        SE_BANKGIRO_CLEARING_CODE = :se_bankgiro_clearing_code
+        SG_INTERBANK_CLEARING_CODE = :sg_interbank_clearing_code
+        SWIFT = :swift
+        ZA_NATIONAL_CLEARING_CODE = :za_national_clearing_code
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # The current status of the incoming payment order. One of `pending`, `completed`,
+      #   or `returned`.
+      module Status
+        extend ModernTreasury::Enum
+
+        COMPLETED = :completed
+        PENDING = :pending
+        RETURNED = :returned
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
+      #   `wire`.
+      module Type
+        extend ModernTreasury::Enum
+
+        ACH = :ach
+        BOOK = :book
+        CHECK = :check
+        EFT = :eft
+        INTERAC = :interac
+        RTP = :rtp
+        SEPA = :sepa
+        SIGNET = :signet
+        WIRE = :wire
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class IncomingPaymentDetailCreateAsyncParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute [r] amount
+      #   Value in specified currency's smallest unit. e.g. $10 would be represented
+      #     as 1000.
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :amount
+
+      # @!attribute as_of_date
+      #   Defaults to today.
+      #
+      #   @return [Date, nil]
+      optional :as_of_date, Date, nil?: true
+
+      # @!attribute currency
+      #   Defaults to the currency of the originating account.
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency, nil]
+      optional :currency, enum: -> { ModernTreasury::Models::Currency }, nil?: true
+
+      # @!attribute description
+      #   Defaults to a random description.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute [r] direction
+      #   One of `credit`, `debit`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction, nil]
+      optional :direction,
+               enum: -> { ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction]
+      #   attr_writer :direction
+
+      # @!attribute [r] internal_account_id
+      #   The ID of one of your internal accounts.
+      #
+      #   @return [String, nil]
+      optional :internal_account_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :internal_account_id
+
+      # @!attribute [r] type
+      #   One of `ach`, `wire`, `check`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Type, nil]
+      optional :type, enum: -> { ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Type }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Type]
+      #   attr_writer :type
+
+      # @!attribute virtual_account_id
+      #   An optional parameter to associate the incoming payment detail to a virtual
+      #     account.
+      #
+      #   @return [String, nil]
+      optional :virtual_account_id, String, nil?: true
+
+      # @!parse
+      #   # @param amount [Integer]
+      #   # @param as_of_date [Date, nil]
+      #   # @param currency [Symbol, ModernTreasury::Models::Currency, nil]
+      #   # @param description [String, nil]
+      #   # @param direction [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction]
+      #   # @param internal_account_id [String]
+      #   # @param type [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Type]
+      #   # @param virtual_account_id [String, nil]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     amount: nil,
+      #     as_of_date: nil,
+      #     currency: nil,
+      #     description: nil,
+      #     direction: nil,
+      #     internal_account_id: nil,
+      #     type: nil,
+      #     virtual_account_id: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # One of `credit`, `debit`.
+      module Direction
+        extend ModernTreasury::Enum
+
+        CREDIT = :credit
+        DEBIT = :debit
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # One of `ach`, `wire`, `check`.
+      module Type
+        extend ModernTreasury::Enum
+
+        ACH = :ach
+        BOOK = :book
+        CHECK = :check
+        EFT = :eft
+        INTERAC = :interac
+        RTP = :rtp
+        SEPA = :sepa
+        SIGNET = :signet
+        WIRE = :wire
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end