modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/payment_reference.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class PaymentReference < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!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 reference_number
+      #   The actual reference number assigned by the bank.
+      #
+      #   @return [String]
+      required :reference_number, String
+
+      # @!attribute reference_number_type
+      #   The type of reference number.
+      #
+      #   @return [Symbol, ModernTreasury::Models::PaymentReference::ReferenceNumberType]
+      required :reference_number_type,
+               enum: -> { ModernTreasury::Models::PaymentReference::ReferenceNumberType }
+
+      # @!attribute referenceable_id
+      #   The id of the referenceable to search for. Must be accompanied by the
+      #     referenceable_type or will return an error.
+      #
+      #   @return [String]
+      required :referenceable_id, String
+
+      # @!attribute referenceable_type
+      #   One of the referenceable types. This must be accompanied by the id of the
+      #     referenceable or will return an error.
+      #
+      #   @return [Symbol, ModernTreasury::Models::PaymentReference::ReferenceableType]
+      required :referenceable_type, enum: -> { ModernTreasury::Models::PaymentReference::ReferenceableType }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param created_at [Time]
+      #   # @param live_mode [Boolean]
+      #   # @param object [String]
+      #   # @param reference_number [String]
+      #   # @param reference_number_type [Symbol, ModernTreasury::Models::PaymentReference::ReferenceNumberType]
+      #   # @param referenceable_id [String]
+      #   # @param referenceable_type [Symbol, ModernTreasury::Models::PaymentReference::ReferenceableType]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     created_at:,
+      #     live_mode:,
+      #     object:,
+      #     reference_number:,
+      #     reference_number_type:,
+      #     referenceable_id:,
+      #     referenceable_type:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # The type of reference number.
+      module ReferenceNumberType
+        extend ModernTreasury::Enum
+
+        ACH_ORIGINAL_TRACE_NUMBER = :ach_original_trace_number
+        ACH_TRACE_NUMBER = :ach_trace_number
+        BANKPROV_PAYMENT_ACTIVITY_DATE = :bankprov_payment_activity_date
+        BANKPROV_PAYMENT_ID = :bankprov_payment_id
+        BNK_DEV_PRENOTIFICATION_ID = :bnk_dev_prenotification_id
+        BNK_DEV_TRANSFER_ID = :bnk_dev_transfer_id
+        BOFA_END_TO_END_ID = :bofa_end_to_end_id
+        BOFA_TRANSACTION_ID = :bofa_transaction_id
+        CHECK_NUMBER = :check_number
+        CITIBANK_REFERENCE_NUMBER = :citibank_reference_number
+        CITIBANK_WORLDLINK_CLEARING_SYSTEM_REFERENCE_NUMBER =
+          :citibank_worldlink_clearing_system_reference_number
+        COLUMN_FX_QUOTE_ID = :column_fx_quote_id
+        COLUMN_REVERSAL_PAIR_TRANSFER_ID = :column_reversal_pair_transfer_id
+        COLUMN_TRANSFER_ID = :column_transfer_id
+        CROSS_RIVER_PAYMENT_ID = :cross_river_payment_id
+        CROSS_RIVER_SERVICE_MESSAGE = :cross_river_service_message
+        CROSS_RIVER_TRANSACTION_ID = :cross_river_transaction_id
+        CURRENCYCLOUD_CONVERSION_ID = :currencycloud_conversion_id
+        CURRENCYCLOUD_PAYMENT_ID = :currencycloud_payment_id
+        DC_BANK_TRANSACTION_ID = :dc_bank_transaction_id
+        DWOLLA_TRANSACTION_ID = :dwolla_transaction_id
+        EFT_TRACE_NUMBER = :eft_trace_number
+        EVOLVE_TRANSACTION_ID = :evolve_transaction_id
+        FEDWIRE_IMAD = :fedwire_imad
+        FEDWIRE_OMAD = :fedwire_omad
+        FIRST_REPUBLIC_INTERNAL_ID = :first_republic_internal_id
+        GOLDMAN_SACHS_COLLECTION_REQUEST_ID = :goldman_sachs_collection_request_id
+        GOLDMAN_SACHS_END_TO_END_ID = :goldman_sachs_end_to_end_id
+        GOLDMAN_SACHS_PAYMENT_REQUEST_ID = :goldman_sachs_payment_request_id
+        GOLDMAN_SACHS_REQUEST_ID = :goldman_sachs_request_id
+        GOLDMAN_SACHS_UNIQUE_PAYMENT_ID = :goldman_sachs_unique_payment_id
+        INTERAC_MESSAGE_ID = :interac_message_id
+        JPMC_CCN = :jpmc_ccn
+        JPMC_CLEARING_SYSTEM_REFERENCE = :jpmc_clearing_system_reference
+        JPMC_CUSTOMER_REFERENCE_ID = :jpmc_customer_reference_id
+        JPMC_END_TO_END_ID = :jpmc_end_to_end_id
+        JPMC_FIRM_ROOT_ID = :jpmc_firm_root_id
+        JPMC_FX_TRN_ID = :jpmc_fx_trn_id
+        JPMC_P3_ID = :jpmc_p3_id
+        JPMC_PAYMENT_BATCH_ID = :jpmc_payment_batch_id
+        JPMC_PAYMENT_INFORMATION_ID = :jpmc_payment_information_id
+        JPMC_PAYMENT_RETURNED_DATETIME = :jpmc_payment_returned_datetime
+        LOB_CHECK_ID = :lob_check_id
+        OTHER = :other
+        PARTIAL_SWIFT_MIR = :partial_swift_mir
+        PNC_CLEARING_REFERENCE = :pnc_clearing_reference
+        PNC_INSTRUCTION_ID = :pnc_instruction_id
+        PNC_MULTIPAYMENT_ID = :pnc_multipayment_id
+        PNC_PAYMENT_TRACE_ID = :pnc_payment_trace_id
+        PNC_TRANSACTION_REFERENCE_NUMBER = :pnc_transaction_reference_number
+        RSPEC_VENDOR_PAYMENT_ID = :rspec_vendor_payment_id
+        RTP_INSTRUCTION_ID = :rtp_instruction_id
+        SIGNET_API_REFERENCE_ID = :signet_api_reference_id
+        SIGNET_CONFIRMATION_ID = :signet_confirmation_id
+        SIGNET_REQUEST_ID = :signet_request_id
+        SILVERGATE_PAYMENT_ID = :silvergate_payment_id
+        SVB_END_TO_END_ID = :svb_end_to_end_id
+        SVB_PAYMENT_ID = :svb_payment_id
+        SVB_TRANSACTION_CLEARED_FOR_SANCTIONS_REVIEW = :svb_transaction_cleared_for_sanctions_review
+        SVB_TRANSACTION_HELD_FOR_SANCTIONS_REVIEW = :svb_transaction_held_for_sanctions_review
+        SWIFT_MIR = :swift_mir
+        SWIFT_UETR = :swift_uetr
+        UMB_PRODUCT_PARTNER_ACCOUNT_NUMBER = :umb_product_partner_account_number
+        USBANK_PAYMENT_APPLICATION_REFERENCE_ID = :usbank_payment_application_reference_id
+        USBANK_PAYMENT_ID = :usbank_payment_id
+        USBANK_PENDING_RTP_PAYMENT_ID = :usbank_pending_rtp_payment_id
+        USBANK_POSTED_RTP_PAYMENT_ID = :usbank_posted_rtp_payment_id
+        WELLS_FARGO_END_TO_END_ID = :wells_fargo_end_to_end_id
+        WELLS_FARGO_PAYMENT_ID = :wells_fargo_payment_id
+        WELLS_FARGO_TRACE_NUMBER = :wells_fargo_trace_number
+        WELLS_FARGO_UETR = :wells_fargo_uetr
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # One of the referenceable types. This must be accompanied by the id of the
+      #   referenceable or will return an error.
+      module ReferenceableType
+        extend ModernTreasury::Enum
+
+        PAYMENT_ORDER = :payment_order
+        REVERSAL = :reversal
+        RETURN = :return
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/payment_reference_list_params.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class PaymentReferenceListParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute after_cursor
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String, nil?: true
+
+      # @!attribute [r] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!attribute [r] reference_number
+      #   The actual reference number assigned by the bank.
+      #
+      #   @return [String, nil]
+      optional :reference_number, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :reference_number
+
+      # @!attribute [r] referenceable_id
+      #   The id of the referenceable to search for. Must be accompanied by the
+      #     referenceable_type or will return an error.
+      #
+      #   @return [String, nil]
+      optional :referenceable_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :referenceable_id
+
+      # @!attribute [r] referenceable_type
+      #   One of the referenceable types. This must be accompanied by the id of the
+      #     referenceable or will return an error.
+      #
+      #   @return [Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType, nil]
+      optional :referenceable_type,
+               enum: -> { ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType]
+      #   attr_writer :referenceable_type
+
+      # @!parse
+      #   # @param after_cursor [String, nil]
+      #   # @param per_page [Integer]
+      #   # @param reference_number [String]
+      #   # @param referenceable_id [String]
+      #   # @param referenceable_type [Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     after_cursor: nil,
+      #     per_page: nil,
+      #     reference_number: nil,
+      #     referenceable_id: nil,
+      #     referenceable_type: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # One of the referenceable types. This must be accompanied by the id of the
+      #   referenceable or will return an error.
+      module ReferenceableType
+        extend ModernTreasury::Enum
+
+        PAYMENT_ORDER = :payment_order
+        RETURN = :return
+        REVERSAL = :reversal
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/payment_reference_retireve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class PaymentReferenceRetireveParams < 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/payment_reference_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class PaymentReferenceRetrieveParams < 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/ping_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class PingResponse < ModernTreasury::BaseModel
+      # @!attribute ping
+      #
+      #   @return [String]
+      required :ping, String
+
+      # @!parse
+      #   # @param ping [String]
+      #   #
+      #   def initialize(ping:, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/reconciliation_rule.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ReconciliationRule < ModernTreasury::BaseModel
+      # @!attribute amount_lower_bound
+      #   The lowest amount this expected payment may be equal to. Value in specified
+      #     currency's smallest unit. e.g. $10 would be represented as 1000.
+      #
+      #   @return [Integer]
+      required :amount_lower_bound, Integer
+
+      # @!attribute amount_upper_bound
+      #   The highest amount this expected payment may be equal to. Value in specified
+      #     currency's smallest unit. e.g. $10 would be represented as 1000.
+      #
+      #   @return [Integer]
+      required :amount_upper_bound, Integer
+
+      # @!attribute direction
+      #   One of credit or debit. When you are receiving money, use credit. When you are
+      #     being charged, use debit.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ReconciliationRule::Direction]
+      required :direction, enum: -> { ModernTreasury::Models::ReconciliationRule::Direction }
+
+      # @!attribute internal_account_id
+      #   The ID of the Internal Account for the expected payment
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!attribute counterparty_id
+      #   The ID of the counterparty you expect for this payment
+      #
+      #   @return [String, nil]
+      optional :counterparty_id, String, nil?: true
+
+      # @!attribute [r] currency
+      #   Must conform to ISO 4217. Defaults to the currency of the internal account
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency, nil]
+      optional :currency, enum: -> { ModernTreasury::Models::Currency }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::Currency]
+      #   attr_writer :currency
+
+      # @!attribute custom_identifiers
+      #   A hash of custom identifiers for this payment
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :custom_identifiers, ModernTreasury::HashOf[String], nil?: true
+
+      # @!attribute date_lower_bound
+      #   The earliest date the payment may come in. Format is yyyy-mm-dd
+      #
+      #   @return [Date, nil]
+      optional :date_lower_bound, Date, nil?: true
+
+      # @!attribute date_upper_bound
+      #   The latest date the payment may come in. Format is yyyy-mm-dd
+      #
+      #   @return [Date, nil]
+      optional :date_upper_bound, Date, nil?: true
+
+      # @!attribute type
+      #   One of ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+      #     sepa, signet wire
+      #
+      #   @return [Symbol, ModernTreasury::Models::ReconciliationRule::Type, nil]
+      optional :type, enum: -> { ModernTreasury::Models::ReconciliationRule::Type }, nil?: true
+
+      # @!parse
+      #   # @param amount_lower_bound [Integer]
+      #   # @param amount_upper_bound [Integer]
+      #   # @param direction [Symbol, ModernTreasury::Models::ReconciliationRule::Direction]
+      #   # @param internal_account_id [String]
+      #   # @param counterparty_id [String, nil]
+      #   # @param currency [Symbol, ModernTreasury::Models::Currency]
+      #   # @param custom_identifiers [Hash{Symbol=>String}, nil]
+      #   # @param date_lower_bound [Date, nil]
+      #   # @param date_upper_bound [Date, nil]
+      #   # @param type [Symbol, ModernTreasury::Models::ReconciliationRule::Type, nil]
+      #   #
+      #   def initialize(
+      #     amount_lower_bound:,
+      #     amount_upper_bound:,
+      #     direction:,
+      #     internal_account_id:,
+      #     counterparty_id: nil,
+      #     currency: nil,
+      #     custom_identifiers: nil,
+      #     date_lower_bound: nil,
+      #     date_upper_bound: nil,
+      #     type: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # One of credit or debit. When you are receiving money, use credit. When you are
+      #   being charged, use debit.
+      module Direction
+        extend ModernTreasury::Enum
+
+        CREDIT = :credit
+        DEBIT = :debit
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # One of ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
+      #   sepa, signet wire
+      module Type
+        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
+    end
+  end
+end

data/lib/modern_treasury/models/return_create_params.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ReturnCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute returnable_id
+      #   The ID of the object being returned or `null`.
+      #
+      #   @return [String, nil]
+      required :returnable_id, String, nil?: true
+
+      # @!attribute returnable_type
+      #   The type of object being returned. Currently, this may only be
+      #     incoming_payment_detail.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType]
+      required :returnable_type, enum: -> { ModernTreasury::Models::ReturnCreateParams::ReturnableType }
+
+      # @!attribute additional_information
+      #   Some returns may include additional information from the bank. In these cases,
+      #     this string will be present.
+      #
+      #   @return [String, nil]
+      optional :additional_information, String, nil?: true
+
+      # @!attribute code
+      #   The return code. For ACH returns, this is the required ACH return code.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ReturnCreateParams::Code, nil]
+      optional :code, enum: -> { ModernTreasury::Models::ReturnCreateParams::Code }, nil?: true
+
+      # @!attribute date_of_death
+      #   If the return code is `R14` or `R15` this is the date the deceased counterparty
+      #     passed away.
+      #
+      #   @return [Date, nil]
+      optional :date_of_death, Date, nil?: true
+
+      # @!attribute reason
+      #   An optional description of the reason for the return. This is for internal usage
+      #     and will not be transmitted to the bank.”
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!parse
+      #   # @param returnable_id [String, nil]
+      #   # @param returnable_type [Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType]
+      #   # @param additional_information [String, nil]
+      #   # @param code [Symbol, ModernTreasury::Models::ReturnCreateParams::Code, nil]
+      #   # @param date_of_death [Date, nil]
+      #   # @param reason [String, nil]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     returnable_id:,
+      #     returnable_type:,
+      #     additional_information: nil,
+      #     code: nil,
+      #     date_of_death: nil,
+      #     reason: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # The type of object being returned. Currently, this may only be
+      #   incoming_payment_detail.
+      module ReturnableType
+        extend ModernTreasury::Enum
+
+        INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # The return code. For ACH returns, this is the required ACH return code.
+      module Code
+        extend ModernTreasury::Enum
+
+        NUMBER_901 = :"901"
+        NUMBER_902 = :"902"
+        NUMBER_903 = :"903"
+        NUMBER_904 = :"904"
+        NUMBER_905 = :"905"
+        NUMBER_907 = :"907"
+        NUMBER_908 = :"908"
+        NUMBER_909 = :"909"
+        NUMBER_910 = :"910"
+        NUMBER_911 = :"911"
+        NUMBER_912 = :"912"
+        NUMBER_914 = :"914"
+        C01 = :C01
+        C02 = :C02
+        C03 = :C03
+        C05 = :C05
+        C06 = :C06
+        C07 = :C07
+        C08 = :C08
+        C09 = :C09
+        C13 = :C13
+        C14 = :C14
+        R01 = :R01
+        R02 = :R02
+        R03 = :R03
+        R04 = :R04
+        R05 = :R05
+        R06 = :R06
+        R07 = :R07
+        R08 = :R08
+        R09 = :R09
+        R10 = :R10
+        R11 = :R11
+        R12 = :R12
+        R14 = :R14
+        R15 = :R15
+        R16 = :R16
+        R17 = :R17
+        R20 = :R20
+        R21 = :R21
+        R22 = :R22
+        R23 = :R23
+        R24 = :R24
+        R29 = :R29
+        R31 = :R31
+        R33 = :R33
+        R37 = :R37
+        R38 = :R38
+        R39 = :R39
+        R51 = :R51
+        R52 = :R52
+        R53 = :R53
+        CURRENCYCLOUD = :currencycloud
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end