modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/models/return_object.rb

@@ -19,8 +19,8 @@ module ModernTreasury
       # @!attribute code
       #   The return code. For ACH returns, this is the required ACH return code.
       #
-      #   @return [Symbol, ModernTreasury::Models::ReturnObject::Code, nil]
-      required :code, enum: -> { ModernTreasury::Models::ReturnObject::Code }, nil?: true
+      #   @return [Symbol, ModernTreasury::ReturnObject::Code, nil]
+      required :code, enum: -> { ModernTreasury::ReturnObject::Code }, nil?: true
 
       # @!attribute created_at
       #
@@ -30,15 +30,15 @@ module ModernTreasury
       # @!attribute currency
       #   Currency that this transaction is denominated in.
       #
-      #   @return [Symbol, ModernTreasury::Models::Currency]
-      required :currency, enum: -> { ModernTreasury::Models::Currency }
+      #   @return [Symbol, ModernTreasury::Currency]
+      required :currency, enum: -> { ModernTreasury::Currency }
 
       # @!attribute current_return
       #   If the return's status is `returned`, this will include the return object's data
       #   that is returning this return.
       #
-      #   @return [ModernTreasury::Models::ReturnObject, nil]
-      required :current_return, -> { ModernTreasury::Models::ReturnObject }, nil?: true
+      #   @return [ModernTreasury::ReturnObject, nil]
+      required :current_return, -> { ModernTreasury::ReturnObject }, nil?: true
 
       # @!attribute date_of_death
       #   If the return code is `R14` or `R15` this is the date the deceased counterparty
@@ -88,9 +88,9 @@ module ModernTreasury
       # @!attribute reference_numbers
       #   An array of Payment Reference objects.
       #
-      #   @return [Array<ModernTreasury::Models::ReturnObject::ReferenceNumber>]
+      #   @return [Array<ModernTreasury::ReturnObject::ReferenceNumber>]
       required :reference_numbers,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ReturnObject::ReferenceNumber] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ReturnObject::ReferenceNumber] }
 
       # @!attribute returnable_id
       #   The ID of the object being returned or `null`.
@@ -101,20 +101,20 @@ module ModernTreasury
       # @!attribute returnable_type
       #   The type of object being returned or `null`.
       #
-      #   @return [Symbol, ModernTreasury::Models::ReturnObject::ReturnableType, nil]
-      required :returnable_type, enum: -> { ModernTreasury::Models::ReturnObject::ReturnableType }, nil?: true
+      #   @return [Symbol, ModernTreasury::ReturnObject::ReturnableType, nil]
+      required :returnable_type, enum: -> { ModernTreasury::ReturnObject::ReturnableType }, nil?: true
 
       # @!attribute role
       #   The role of the return, can be `originating` or `receiving`.
       #
-      #   @return [Symbol, ModernTreasury::Models::ReturnObject::Role]
-      required :role, enum: -> { ModernTreasury::Models::ReturnObject::Role }
+      #   @return [Symbol, ModernTreasury::ReturnObject::Role]
+      required :role, enum: -> { ModernTreasury::ReturnObject::Role }
 
       # @!attribute status
       #   The current status of the return.
       #
-      #   @return [Symbol, ModernTreasury::Models::ReturnObject::Status]
-      required :status, enum: -> { ModernTreasury::Models::ReturnObject::Status }
+      #   @return [Symbol, ModernTreasury::ReturnObject::Status]
+      required :status, enum: -> { ModernTreasury::ReturnObject::Status }
 
       # @!attribute transaction_id
       #   The ID of the relevant Transaction or `null`.
@@ -132,8 +132,8 @@ module ModernTreasury
       #   The type of return. Can be one of: `ach`, `ach_noc`, `au_becs`, `bacs`, `eft`,
       #   `interac`, `manual`, `paper_item`, `wire`.
       #
-      #   @return [Symbol, ModernTreasury::Models::ReturnObject::Type]
-      required :type, enum: -> { ModernTreasury::Models::ReturnObject::Type }
+      #   @return [Symbol, ModernTreasury::ReturnObject::Type]
+      required :type, enum: -> { ModernTreasury::ReturnObject::Type }
 
       # @!attribute updated_at
       #
@@ -153,67 +153,61 @@ module ModernTreasury
       #   @return [Object, nil]
       optional :data, ModernTreasury::Internal::Type::Unknown, nil?: true
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param amount [Integer]
-      #   # @param code [Symbol, ModernTreasury::Models::ReturnObject::Code, nil]
-      #   # @param created_at [Time]
-      #   # @param currency [Symbol, ModernTreasury::Models::Currency]
-      #   # @param current_return [ModernTreasury::Models::ReturnObject, nil]
-      #   # @param date_of_death [Date, nil]
-      #   # @param failure_reason [String, nil]
-      #   # @param internal_account_id [String, nil]
-      #   # @param ledger_transaction_id [String, nil]
-      #   # @param live_mode [Boolean]
-      #   # @param object [String]
-      #   # @param reason [String, nil]
-      #   # @param reference_numbers [Array<ModernTreasury::Models::ReturnObject::ReferenceNumber>]
-      #   # @param returnable_id [String, nil]
-      #   # @param returnable_type [Symbol, ModernTreasury::Models::ReturnObject::ReturnableType, nil]
-      #   # @param role [Symbol, ModernTreasury::Models::ReturnObject::Role]
-      #   # @param status [Symbol, ModernTreasury::Models::ReturnObject::Status]
-      #   # @param transaction_id [String, nil]
-      #   # @param transaction_line_item_id [String, nil]
-      #   # @param type [Symbol, ModernTreasury::Models::ReturnObject::Type]
-      #   # @param updated_at [Time]
-      #   # @param additional_information [String, nil]
-      #   # @param data [Object, nil]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     amount:,
-      #     code:,
-      #     created_at:,
-      #     currency:,
-      #     current_return:,
-      #     date_of_death:,
-      #     failure_reason:,
-      #     internal_account_id:,
-      #     ledger_transaction_id:,
-      #     live_mode:,
-      #     object:,
-      #     reason:,
-      #     reference_numbers:,
-      #     returnable_id:,
-      #     returnable_type:,
-      #     role:,
-      #     status:,
-      #     transaction_id:,
-      #     transaction_line_item_id:,
-      #     type:,
-      #     updated_at:,
-      #     additional_information: nil,
-      #     data: nil,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, amount:, code:, created_at:, currency:, current_return:, date_of_death:, failure_reason:, internal_account_id:, ledger_transaction_id:, live_mode:, object:, reason:, reference_numbers:, returnable_id:, returnable_type:, role:, status:, transaction_id:, transaction_line_item_id:, type:, updated_at:, additional_information: nil, data: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::ReturnObject} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param amount [Integer] Value in specified currency's smallest unit. e.g. $10 would be represented as 10
+      #
+      #   @param code [Symbol, ModernTreasury::ReturnObject::Code, nil] The return code. For ACH returns, this is the required ACH return code.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param currency [Symbol, ModernTreasury::Currency] Currency that this transaction is denominated in.
+      #
+      #   @param current_return [ModernTreasury::ReturnObject, nil] If the return's status is `returned`, this will include the return object's data
+      #
+      #   @param date_of_death [Date, nil] If the return code is `R14` or `R15` this is the date the deceased counterparty
+      #
+      #   @param failure_reason [String, nil] If an originating return failed to be processed by the bank, a description of th
+      #
+      #   @param internal_account_id [String, nil] The ID of the relevant Internal Account.
+      #
+      #   @param ledger_transaction_id [String, nil] The ID of the ledger transaction linked to the return.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param reason [String, nil] Often the bank will provide an explanation for the return, which is a short huma
+      #
+      #   @param reference_numbers [Array<ModernTreasury::ReturnObject::ReferenceNumber>] An array of Payment Reference objects.
+      #
+      #   @param returnable_id [String, nil] The ID of the object being returned or `null`.
+      #
+      #   @param returnable_type [Symbol, ModernTreasury::ReturnObject::ReturnableType, nil] The type of object being returned or `null`.
+      #
+      #   @param role [Symbol, ModernTreasury::ReturnObject::Role] The role of the return, can be `originating` or `receiving`.
+      #
+      #   @param status [Symbol, ModernTreasury::ReturnObject::Status] The current status of the return.
+      #
+      #   @param transaction_id [String, nil] The ID of the relevant Transaction or `null`.
+      #
+      #   @param transaction_line_item_id [String, nil] The ID of the relevant Transaction Line Item or `null`.
+      #
+      #   @param type [Symbol, ModernTreasury::ReturnObject::Type] The type of return. Can be one of: `ach`, `ach_noc`, `au_becs`, `bacs`, `eft`, `
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param additional_information [String, nil] Some returns may include additional information from the bank. In these cases, t
+      #
+      #   @param data [Object, nil] The raw data from the return file that we get from the bank.
 
       # The return code. For ACH returns, this is the required ACH return code.
       #
-      # @see ModernTreasury::Models::ReturnObject#code
+      # @see ModernTreasury::ReturnObject#code
       module Code
         extend ModernTreasury::Internal::Type::Enum
 
@@ -271,11 +265,8 @@ module ModernTreasury
         R53 = :R53
         CURRENCYCLOUD = :currencycloud
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       class ReferenceNumber < ModernTreasury::Internal::Type::BaseModel
@@ -310,31 +301,36 @@ module ModernTreasury
         # @!attribute reference_number_type
         #   The type of the reference number. Referring to the vendor payment id.
         #
-        #   @return [Symbol, ModernTreasury::Models::ReturnObject::ReferenceNumber::ReferenceNumberType]
+        #   @return [Symbol, ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType]
         required :reference_number_type,
-                 enum: -> { ModernTreasury::Models::ReturnObject::ReferenceNumber::ReferenceNumberType }
+                 enum: -> { ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType }
 
         # @!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::ReturnObject::ReferenceNumber::ReferenceNumberType]
-        #   # @param updated_at [Time]
-        #   #
-        #   def initialize(id:, created_at:, live_mode:, object:, reference_number:, reference_number_type:, updated_at:, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, created_at:, live_mode:, object:, reference_number:, reference_number_type:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::ReturnObject::ReferenceNumber} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+        #
+        #   @param object [String]
+        #
+        #   @param reference_number [String] The vendor reference number.
+        #
+        #   @param reference_number_type [Symbol, ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType] The type of the reference number. Referring to the vendor payment id.
+        #
+        #   @param updated_at [Time]
 
         # The type of the reference number. Referring to the vendor payment id.
         #
-        # @see ModernTreasury::Models::ReturnObject::ReferenceNumber#reference_number_type
+        # @see ModernTreasury::ReturnObject::ReferenceNumber#reference_number_type
         module ReferenceNumberType
           extend ModernTreasury::Internal::Type::Enum
 
@@ -414,17 +410,14 @@ module ModernTreasury
           WELLS_FARGO_TRACE_NUMBER = :wells_fargo_trace_number
           WELLS_FARGO_UETR = :wells_fargo_uetr
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
 
       # The type of object being returned or `null`.
       #
-      # @see ModernTreasury::Models::ReturnObject#returnable_type
+      # @see ModernTreasury::ReturnObject#returnable_type
       module ReturnableType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -434,32 +427,26 @@ module ModernTreasury
         RETURN = :return
         REVERSAL = :reversal
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # The role of the return, can be `originating` or `receiving`.
       #
-      # @see ModernTreasury::Models::ReturnObject#role
+      # @see ModernTreasury::ReturnObject#role
       module Role
         extend ModernTreasury::Internal::Type::Enum
 
         ORIGINATING = :originating
         RECEIVING = :receiving
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # The current status of the return.
       #
-      # @see ModernTreasury::Models::ReturnObject#status
+      # @see ModernTreasury::ReturnObject#status
       module Status
         extend ModernTreasury::Internal::Type::Enum
 
@@ -470,17 +457,14 @@ module ModernTreasury
         RETURNED = :returned
         SENT = :sent
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # The type of return. Can be one of: `ach`, `ach_noc`, `au_becs`, `bacs`, `eft`,
       # `interac`, `manual`, `paper_item`, `wire`.
       #
-      # @see ModernTreasury::Models::ReturnObject#type
+      # @see ModernTreasury::ReturnObject#type
       module Type
         extend ModernTreasury::Internal::Type::Enum
 
@@ -498,11 +482,8 @@ module ModernTreasury
         SEPA = :sepa
         WIRE = :wire
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/modern_treasury/models/return_retrieve_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Returns#retrieve
     class ReturnRetrieveParams < 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/routing_detail.rb

@@ -11,8 +11,8 @@ module ModernTreasury
 
       # @!attribute bank_address
       #
-      #   @return [ModernTreasury::Models::RoutingDetail::BankAddress, nil]
-      required :bank_address, -> { ModernTreasury::Models::RoutingDetail::BankAddress }, nil?: true
+      #   @return [ModernTreasury::RoutingDetail::BankAddress, nil]
+      required :bank_address, -> { ModernTreasury::RoutingDetail::BankAddress }, nil?: true
 
       # @!attribute bank_name
       #   The name of the bank.
@@ -46,8 +46,8 @@ module ModernTreasury
       #   If the routing detail is to be used for a specific payment type this field will
       #   be populated, otherwise null.
       #
-      #   @return [Symbol, ModernTreasury::Models::RoutingDetail::PaymentType, nil]
-      required :payment_type, enum: -> { ModernTreasury::Models::RoutingDetail::PaymentType }, nil?: true
+      #   @return [Symbol, ModernTreasury::RoutingDetail::PaymentType, nil]
+      required :payment_type, enum: -> { ModernTreasury::RoutingDetail::PaymentType }, nil?: true
 
       # @!attribute routing_number
       #   The routing number of the bank.
@@ -60,47 +60,41 @@ module ModernTreasury
       #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
       #   more details.
       #
-      #   @return [Symbol, ModernTreasury::Models::RoutingDetail::RoutingNumberType]
-      required :routing_number_type, enum: -> { ModernTreasury::Models::RoutingDetail::RoutingNumberType }
+      #   @return [Symbol, ModernTreasury::RoutingDetail::RoutingNumberType]
+      required :routing_number_type, enum: -> { ModernTreasury::RoutingDetail::RoutingNumberType }
 
       # @!attribute updated_at
       #
       #   @return [Time]
       required :updated_at, Time
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param bank_address [ModernTreasury::Models::RoutingDetail::BankAddress, nil]
-      #   # @param bank_name [String]
-      #   # @param created_at [Time]
-      #   # @param discarded_at [Time, nil]
-      #   # @param live_mode [Boolean]
-      #   # @param object [String]
-      #   # @param payment_type [Symbol, ModernTreasury::Models::RoutingDetail::PaymentType, nil]
-      #   # @param routing_number [String]
-      #   # @param routing_number_type [Symbol, ModernTreasury::Models::RoutingDetail::RoutingNumberType]
-      #   # @param updated_at [Time]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     bank_address:,
-      #     bank_name:,
-      #     created_at:,
-      #     discarded_at:,
-      #     live_mode:,
-      #     object:,
-      #     payment_type:,
-      #     routing_number:,
-      #     routing_number_type:,
-      #     updated_at:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, bank_address:, bank_name:, created_at:, discarded_at:, live_mode:, object:, payment_type:, routing_number:, routing_number_type:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::RoutingDetail} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param bank_address [ModernTreasury::RoutingDetail::BankAddress, nil]
+      #
+      #   @param bank_name [String] The name of the bank.
+      #
+      #   @param created_at [Time]
+      #
+      #   @param discarded_at [Time, nil]
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param payment_type [Symbol, ModernTreasury::RoutingDetail::PaymentType, nil] If the routing detail is to be used for a specific payment type this field will
+      #
+      #   @param routing_number [String] The routing number of the bank.
+      #
+      #   @param routing_number_type [Symbol, ModernTreasury::RoutingDetail::RoutingNumberType] The type of routing number. See https://docs.moderntreasury.com/platform/referen
+      #
+      #   @param updated_at [Time]
 
-      # @see ModernTreasury::Models::RoutingDetail#bank_address
+      # @see ModernTreasury::RoutingDetail#bank_address
       class BankAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
@@ -163,43 +157,37 @@ module ModernTreasury
         #   @return [Time]
         required :updated_at, Time
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param country [String, nil]
-        #   # @param created_at [Time]
-        #   # @param line1 [String, nil]
-        #   # @param line2 [String, nil]
-        #   # @param live_mode [Boolean]
-        #   # @param locality [String, nil]
-        #   # @param object [String]
-        #   # @param postal_code [String, nil]
-        #   # @param region [String, nil]
-        #   # @param updated_at [Time]
-        #   #
-        #   def initialize(
-        #     id:,
-        #     country:,
-        #     created_at:,
-        #     line1:,
-        #     line2:,
-        #     live_mode:,
-        #     locality:,
-        #     object:,
-        #     postal_code:,
-        #     region:,
-        #     updated_at:,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, country:, created_at:, line1:, line2:, live_mode:, locality:, object:, postal_code:, region:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::RoutingDetail::BankAddress} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param line1 [String, nil]
+        #
+        #   @param line2 [String, nil]
+        #
+        #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+        #
+        #   @param locality [String, nil] Locality or City.
+        #
+        #   @param object [String]
+        #
+        #   @param postal_code [String, nil] The postal code of the address.
+        #
+        #   @param region [String, nil] Region or State.
+        #
+        #   @param updated_at [Time]
       end
 
       # If the routing detail is to be used for a specific payment type this field will
       # be populated, otherwise null.
       #
-      # @see ModernTreasury::Models::RoutingDetail#payment_type
+      # @see ModernTreasury::RoutingDetail#payment_type
       module PaymentType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -234,18 +222,15 @@ module ModernTreasury
         WIRE = :wire
         ZENGIN = :zengin
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # The type of routing number. See
       # https://docs.moderntreasury.com/platform/reference/routing-detail-object for
       # more details.
       #
-      # @see ModernTreasury::Models::RoutingDetail#routing_number_type
+      # @see ModernTreasury::RoutingDetail#routing_number_type
       module RoutingNumberType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -271,11 +256,8 @@ module ModernTreasury
         SWIFT = :swift
         ZA_NATIONAL_CLEARING_CODE = :za_national_clearing_code
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end