modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/lib/modern_treasury/models/payment_reference_list_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::PaymentReferences#list
     class PaymentReferenceListParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
@@ -13,69 +12,46 @@ module ModernTreasury
       #   @return [String, nil]
       optional :after_cursor, String, nil?: true
 
-      # @!attribute [r] per_page
+      # @!attribute per_page
       #
       #   @return [Integer, nil]
       optional :per_page, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :per_page
-
-      # @!attribute [r] reference_number
+      # @!attribute 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
+      # @!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, nil]
       optional :referenceable_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :referenceable_id
-
-      # @!attribute [r] referenceable_type
+      # @!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::PaymentReferenceListParams::ReferenceableType, nil]
-      optional :referenceable_type,
-               enum: -> { ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType }
+      optional :referenceable_type, enum: -> { ModernTreasury::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::Internal::Type::BaseModel) -> void
+      # @!method initialize(after_cursor: nil, per_page: nil, reference_number: nil, referenceable_id: nil, referenceable_type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::PaymentReferenceListParams} for more details.
+      #
+      #   @param after_cursor [String, nil]
+      #
+      #   @param per_page [Integer]
+      #
+      #   @param reference_number [String] The actual reference number assigned by the bank.
+      #
+      #   @param referenceable_id [String] The id of the referenceable to search for. Must be accompanied by the referencea
+      #
+      #   @param referenceable_type [Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType] One of the referenceable types. This must be accompanied by the id of the refere
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
       # One of the referenceable types. This must be accompanied by the id of the
       # referenceable or will return an error.
@@ -86,11 +62,8 @@ module ModernTreasury
         RETURN = :return
         REVERSAL = :reversal
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/modern_treasury/models/payment_reference_retireve_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::PaymentReferences#retireve
     class PaymentReferenceRetireveParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/payment_reference_retrieve_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::PaymentReferences#retrieve
     class PaymentReferenceRetrieveParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/ping_response.rb

@@ -9,12 +9,8 @@ module ModernTreasury
       #   @return [String]
       required :ping, String
 
-      # @!parse
-      #   # @param ping [String]
-      #   #
-      #   def initialize(ping:, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(ping:)
+      #   @param ping [String]
     end
   end
 end

data/lib/modern_treasury/models/reconciliation_rule.rb

@@ -22,7 +22,7 @@ module ModernTreasury
       #   being charged, use debit.
       #
       #   @return [Symbol, ModernTreasury::Models::ReconciliationRule::Direction]
-      required :direction, enum: -> { ModernTreasury::Models::ReconciliationRule::Direction }
+      required :direction, enum: -> { ModernTreasury::ReconciliationRule::Direction }
 
       # @!attribute internal_account_id
       #   The ID of the Internal Account for the expected payment
@@ -36,15 +36,11 @@ module ModernTreasury
       #   @return [String, nil]
       optional :counterparty_id, String, nil?: true
 
-      # @!attribute [r] currency
+      # @!attribute 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
+      optional :currency, enum: -> { ModernTreasury::Currency }
 
       # @!attribute custom_identifiers
       #   A hash of custom identifiers for this payment
@@ -69,37 +65,31 @@ module ModernTreasury
       #   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::Internal::Type::BaseModel) -> void
+      optional :type, enum: -> { ModernTreasury::ReconciliationRule::Type }, nil?: true
+
+      # @!method 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)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::ReconciliationRule} for more details.
+      #
+      #   @param amount_lower_bound [Integer] The lowest amount this expected payment may be equal to. Value in specified curr
+      #
+      #   @param amount_upper_bound [Integer] The highest amount this expected payment may be equal to. Value in specified cur
+      #
+      #   @param direction [Symbol, ModernTreasury::Models::ReconciliationRule::Direction] One of credit or debit. When you are receiving money, use credit. When you are b
+      #
+      #   @param internal_account_id [String] The ID of the Internal Account for the expected payment
+      #
+      #   @param counterparty_id [String, nil] The ID of the counterparty you expect for this payment
+      #
+      #   @param currency [Symbol, ModernTreasury::Models::Currency] Must conform to ISO 4217. Defaults to the currency of the internal account
+      #
+      #   @param custom_identifiers [Hash{Symbol=>String}, nil] A hash of custom identifiers for this payment
+      #
+      #   @param date_lower_bound [Date, nil] The earliest date the payment may come in. Format is yyyy-mm-dd
+      #
+      #   @param date_upper_bound [Date, nil] The latest date the payment may come in. Format is yyyy-mm-dd
+      #
+      #   @param type [Symbol, ModernTreasury::Models::ReconciliationRule::Type, nil] One of ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen, sep
 
       # One of credit or debit. When you are receiving money, use credit. When you are
       # being charged, use debit.
@@ -111,11 +101,8 @@ module ModernTreasury
         CREDIT = :credit
         DEBIT = :debit
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # One of ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
@@ -128,6 +115,7 @@ module ModernTreasury
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
+        BASE = :base
         BOOK = :book
         CARD = :card
         CHATS = :chats
@@ -135,6 +123,7 @@ module ModernTreasury
         CROSS_BORDER = :cross_border
         DK_NETS = :dk_nets
         EFT = :eft
+        ETHEREUM = :ethereum
         HU_ICS = :hu_ics
         INTERAC = :interac
         MASAV = :masav
@@ -143,6 +132,7 @@ module ModernTreasury
         NICS = :nics
         NZ_BECS = :nz_becs
         PL_ELIXIR = :pl_elixir
+        POLYGON = :polygon
         PROVXCHANGE = :provxchange
         RO_SENT = :ro_sent
         RTP = :rtp
@@ -153,14 +143,12 @@ module ModernTreasury
         SIC = :sic
         SIGNET = :signet
         SKNBI = :sknbi
+        SOLANA = :solana
         WIRE = :wire
         ZENGIN = :zengin
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/modern_treasury/models/return_create_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Returns#create
     class ReturnCreateParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute returnable_id
@@ -19,7 +18,7 @@ module ModernTreasury
       #   incoming_payment_detail.
       #
       #   @return [Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType]
-      required :returnable_type, enum: -> { ModernTreasury::Models::ReturnCreateParams::ReturnableType }
+      required :returnable_type, enum: -> { ModernTreasury::ReturnCreateParams::ReturnableType }
 
       # @!attribute additional_information
       #   Some returns may include additional information from the bank. In these cases,
@@ -32,7 +31,7 @@ module ModernTreasury
       #   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
+      optional :code, enum: -> { ModernTreasury::ReturnCreateParams::Code }, nil?: true
 
       # @!attribute data
       #   The raw data from the return file that we get from the bank.
@@ -54,31 +53,25 @@ module ModernTreasury
       #   @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 data [Object, 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,
-      #     data: nil,
-      #     date_of_death: nil,
-      #     reason: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(returnable_id:, returnable_type:, additional_information: nil, code: nil, data: nil, date_of_death: nil, reason: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::ReturnCreateParams} for more details.
+      #
+      #   @param returnable_id [String, nil] The ID of the object being returned or `null`.
+      #
+      #   @param returnable_type [Symbol, ModernTreasury::Models::ReturnCreateParams::ReturnableType] The type of object being returned. Currently, this may only be incoming*payment*
+      #
+      #   @param additional_information [String, nil] Some returns may include additional information from the bank. In these cases, t
+      #
+      #   @param code [Symbol, ModernTreasury::Models::ReturnCreateParams::Code, nil] The return code. For ACH returns, this is the required ACH return code.
+      #
+      #   @param data [Object, nil] The raw data from the return file that we get from the bank.
+      #
+      #   @param date_of_death [Date, nil] If the return code is `R14` or `R15` this is the date the deceased counterparty
+      #
+      #   @param reason [String, nil] An optional description of the reason for the return. This is for internal usage
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of object being returned. Currently, this may only be
       # incoming_payment_detail.
@@ -87,11 +80,8 @@ module ModernTreasury
 
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # The return code. For ACH returns, this is the required ACH return code.
@@ -132,31 +122,68 @@ module ModernTreasury
         R10 = :R10
         R11 = :R11
         R12 = :R12
+        R13 = :R13
         R14 = :R14
         R15 = :R15
         R16 = :R16
         R17 = :R17
+        R18 = :R18
+        R19 = :R19
         R20 = :R20
         R21 = :R21
         R22 = :R22
         R23 = :R23
         R24 = :R24
+        R25 = :R25
+        R26 = :R26
+        R27 = :R27
+        R28 = :R28
         R29 = :R29
+        R30 = :R30
         R31 = :R31
+        R32 = :R32
         R33 = :R33
+        R34 = :R34
+        R35 = :R35
+        R36 = :R36
         R37 = :R37
         R38 = :R38
         R39 = :R39
+        R40 = :R40
+        R41 = :R41
+        R42 = :R42
+        R43 = :R43
+        R44 = :R44
+        R45 = :R45
+        R46 = :R46
+        R47 = :R47
+        R50 = :R50
         R51 = :R51
         R52 = :R52
         R53 = :R53
+        R61 = :R61
+        R62 = :R62
+        R67 = :R67
+        R68 = :R68
+        R69 = :R69
+        R70 = :R70
+        R71 = :R71
+        R72 = :R72
+        R73 = :R73
+        R74 = :R74
+        R75 = :R75
+        R76 = :R76
+        R77 = :R77
+        R80 = :R80
+        R81 = :R81
+        R82 = :R82
+        R83 = :R83
+        R84 = :R84
+        R85 = :R85
         CURRENCYCLOUD = :currencycloud
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/modern_treasury/models/return_list_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Returns#list
     class ReturnListParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
@@ -13,81 +12,55 @@ module ModernTreasury
       #   @return [String, nil]
       optional :after_cursor, String, nil?: true
 
-      # @!attribute [r] counterparty_id
+      # @!attribute counterparty_id
       #   Specify `counterparty_id` if you wish to see returns that occurred with a
       #   specific counterparty.
       #
       #   @return [String, nil]
       optional :counterparty_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :counterparty_id
-
-      # @!attribute [r] internal_account_id
+      # @!attribute internal_account_id
       #   Specify `internal_account_id` if you wish to see returns to/from a specific
       #   account.
       #
       #   @return [String, nil]
       optional :internal_account_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :internal_account_id
-
-      # @!attribute [r] per_page
+      # @!attribute per_page
       #
       #   @return [Integer, nil]
       optional :per_page, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :per_page
-
-      # @!attribute [r] returnable_id
+      # @!attribute returnable_id
       #   The ID of a valid returnable. Must be accompanied by `returnable_type`.
       #
       #   @return [String, nil]
       optional :returnable_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :returnable_id
-
-      # @!attribute [r] returnable_type
+      # @!attribute returnable_type
       #   One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
       #   Must be accompanied by `returnable_id`.
       #
       #   @return [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType, nil]
-      optional :returnable_type, enum: -> { ModernTreasury::Models::ReturnListParams::ReturnableType }
+      optional :returnable_type, enum: -> { ModernTreasury::ReturnListParams::ReturnableType }
 
-      # @!parse
-      #   # @return [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType]
-      #   attr_writer :returnable_type
-
-      # @!parse
-      #   # @param after_cursor [String, nil]
-      #   # @param counterparty_id [String]
-      #   # @param internal_account_id [String]
-      #   # @param per_page [Integer]
-      #   # @param returnable_id [String]
-      #   # @param returnable_type [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     after_cursor: nil,
-      #     counterparty_id: nil,
-      #     internal_account_id: nil,
-      #     per_page: nil,
-      #     returnable_id: nil,
-      #     returnable_type: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(after_cursor: nil, counterparty_id: nil, internal_account_id: nil, per_page: nil, returnable_id: nil, returnable_type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::ReturnListParams} for more details.
+      #
+      #   @param after_cursor [String, nil]
+      #
+      #   @param counterparty_id [String] Specify `counterparty_id` if you wish to see returns that occurred with a specif
+      #
+      #   @param internal_account_id [String] Specify `internal_account_id` if you wish to see returns to/from a specific acco
+      #
+      #   @param per_page [Integer]
+      #
+      #   @param returnable_id [String] The ID of a valid returnable. Must be accompanied by `returnable_type`.
+      #
+      #   @param returnable_type [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType] One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
       # One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
       # Must be accompanied by `returnable_id`.
@@ -100,11 +73,8 @@ module ModernTreasury
         RETURN = :return
         REVERSAL = :reversal
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end