modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/models/payment_reference_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class PaymentReferenceListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaymentReferences#list
+    class PaymentReferenceListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
       #
@@ -33,7 +34,7 @@ module ModernTreasury
 
       # @!attribute [r] referenceable_id
       #   The id of the referenceable to search for. Must be accompanied by the
-      #     referenceable_type or will return an error.
+      #   referenceable_type or will return an error.
       #
       #   @return [String, nil]
       optional :referenceable_id, String
@@ -44,7 +45,7 @@ module ModernTreasury
 
       # @!attribute [r] referenceable_type
       #   One of the referenceable types. This must be accompanied by the id of the
-      #     referenceable or will return an error.
+      #   referenceable or will return an error.
       #
       #   @return [Symbol, ModernTreasury::Models::PaymentReferenceListParams::ReferenceableType, nil]
       optional :referenceable_type,
@@ -74,25 +75,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # One of the referenceable types. This must be accompanied by the id of the
-      #   referenceable or will return an error.
-      #
-      # @example
-      # ```ruby
-      # case referenceable_type
-      # in :payment_order
-      #   # ...
-      # in :return
-      #   # ...
-      # in :reversal
-      #   # ...
-      # end
-      # ```
-      class ReferenceableType < ModernTreasury::Enum
+      # referenceable or will return an error.
+      module ReferenceableType
+        extend ModernTreasury::Internal::Type::Enum
+
         PAYMENT_ORDER = :payment_order
         RETURN = :return
         REVERSAL = :reversal
@@ -101,7 +90,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/payment_reference_retireve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class PaymentReferenceRetireveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaymentReferences#retireve
+    class PaymentReferenceRetireveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   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::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/payment_reference_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class PaymentReferenceRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::PaymentReferences#retrieve
+    class PaymentReferenceRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   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::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/ping_response.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class PingResponse < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Client#ping
+    class PingResponse < ModernTreasury::Internal::Type::BaseModel
       # @!attribute ping
       #
       #   @return [String]
@@ -13,7 +14,7 @@ module ModernTreasury
       #   #
       #   def initialize(ping:, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/reconciliation_rule.rb

@@ -2,24 +2,24 @@
 
 module ModernTreasury
   module Models
-    class ReconciliationRule < ModernTreasury::BaseModel
+    class ReconciliationRule < ModernTreasury::Internal::Type::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.
+      #   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.
+      #   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.
+      #   being charged, use debit.
       #
       #   @return [Symbol, ModernTreasury::Models::ReconciliationRule::Direction]
       required :direction, enum: -> { ModernTreasury::Models::ReconciliationRule::Direction }
@@ -50,7 +50,7 @@ module ModernTreasury
       #   A hash of custom identifiers for this payment
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :custom_identifiers, ModernTreasury::HashOf[String], nil?: true
+      optional :custom_identifiers, ModernTreasury::Internal::Type::HashOf[String], nil?: true
 
       # @!attribute date_lower_bound
       #   The earliest date the payment may come in. Format is yyyy-mm-dd
@@ -66,7 +66,7 @@ module ModernTreasury
 
       # @!attribute type
       #   One of ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
-      #     sepa, signet wire
+      #   sepa, signet wire
       #
       #   @return [Symbol, ModernTreasury::Models::ReconciliationRule::Type, nil]
       optional :type, enum: -> { ModernTreasury::Models::ReconciliationRule::Type }, nil?: true
@@ -99,23 +99,15 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # One of credit or debit. When you are receiving money, use credit. When you are
-      #   being charged, use debit.
+      # being charged, use debit.
       #
-      # @example
-      # ```ruby
-      # case direction
-      # in :credit
-      #   # ...
-      # in :debit
-      #   # ...
-      # end
-      # ```
-      class Direction < ModernTreasury::Enum
+      # @see ModernTreasury::Models::ReconciliationRule#direction
+      module Direction
+        extend ModernTreasury::Internal::Type::Enum
+
         CREDIT = :credit
         DEBIT = :debit
 
@@ -123,33 +115,16 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of ach, au_becs, bacs, book, check, eft, interac, provxchange, rtp, sen,
-      #   sepa, signet wire
+      # sepa, signet wire
       #
-      # @example
-      # ```ruby
-      # case type
-      # in :ach
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in :card
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Type < ModernTreasury::Enum
+      # @see ModernTreasury::Models::ReconciliationRule#type
+      module Type
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -185,7 +160,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/return_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class ReturnCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Returns#create
+    class ReturnCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute returnable_id
       #   The ID of the object being returned or `null`.
@@ -15,14 +16,14 @@ module ModernTreasury
 
       # @!attribute returnable_type
       #   The type of object being returned. Currently, this may only be
-      #     incoming_payment_detail.
+      #   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.
+      #   this string will be present.
       #
       #   @return [String, nil]
       optional :additional_information, String, nil?: true
@@ -33,16 +34,22 @@ module ModernTreasury
       #   @return [Symbol, ModernTreasury::Models::ReturnCreateParams::Code, nil]
       optional :code, enum: -> { ModernTreasury::Models::ReturnCreateParams::Code }, nil?: true
 
+      # @!attribute data
+      #   The raw data from the return file that we get from the bank.
+      #
+      #   @return [Object, nil]
+      optional :data, ModernTreasury::Internal::Type::Unknown, nil?: true
+
       # @!attribute date_of_death
       #   If the return code is `R14` or `R15` this is the date the deceased counterparty
-      #     passed away.
+      #   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.”
+      #   and will not be transmitted to the bank.”
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
@@ -52,6 +59,7 @@ module ModernTreasury
       #   # @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}]
@@ -61,6 +69,7 @@ module ModernTreasury
       #     returnable_type:,
       #     additional_information: nil,
       #     code: nil,
+      #     data: nil,
       #     date_of_death: nil,
       #     reason: nil,
       #     request_options: {},
@@ -69,65 +78,38 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # The type of object being returned. Currently, this may only be
-      #   incoming_payment_detail.
-      #
-      # @example
-      # ```ruby
-      # case returnable_type
-      # in :incoming_payment_detail
-      #   # ...
-      # end
-      # ```
-      class ReturnableType < ModernTreasury::Enum
+      # incoming_payment_detail.
+      module ReturnableType
+        extend ModernTreasury::Internal::Type::Enum
+
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The return code. For ACH returns, this is the required ACH return code.
-      #
-      # @example
-      # ```ruby
-      # case code
-      # in :"901"
-      #   # ...
-      # in :"902"
-      #   # ...
-      # in :"903"
-      #   # ...
-      # in :"904"
-      #   # ...
-      # in :"905"
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Code < 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"
+      module Code
+        extend ModernTreasury::Internal::Type::Enum
+
+        CODE_901 = :"901"
+        CODE_902 = :"902"
+        CODE_903 = :"903"
+        CODE_904 = :"904"
+        CODE_905 = :"905"
+        CODE_907 = :"907"
+        CODE_908 = :"908"
+        CODE_909 = :"909"
+        CODE_910 = :"910"
+        CODE_911 = :"911"
+        CODE_912 = :"912"
+        CODE_914 = :"914"
         C01 = :C01
         C02 = :C02
         C03 = :C03
@@ -174,7 +156,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/return_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class ReturnListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Returns#list
+    class ReturnListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
       #
@@ -14,7 +15,7 @@ module ModernTreasury
 
       # @!attribute [r] counterparty_id
       #   Specify `counterparty_id` if you wish to see returns that occurred with a
-      #     specific counterparty.
+      #   specific counterparty.
       #
       #   @return [String, nil]
       optional :counterparty_id, String
@@ -25,7 +26,7 @@ module ModernTreasury
 
       # @!attribute [r] internal_account_id
       #   Specify `internal_account_id` if you wish to see returns to/from a specific
-      #     account.
+      #   account.
       #
       #   @return [String, nil]
       optional :internal_account_id, String
@@ -55,7 +56,7 @@ module ModernTreasury
 
       # @!attribute [r] returnable_type
       #   One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
-      #     Must be accompanied by `returnable_id`.
+      #   Must be accompanied by `returnable_id`.
       #
       #   @return [Symbol, ModernTreasury::Models::ReturnListParams::ReturnableType, nil]
       optional :returnable_type, enum: -> { ModernTreasury::Models::ReturnListParams::ReturnableType }
@@ -86,29 +87,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
-      #   Must be accompanied by `returnable_id`.
-      #
-      # @example
-      # ```ruby
-      # case returnable_type
-      # in :incoming_payment_detail
-      #   # ...
-      # in :paper_item
-      #   # ...
-      # in :payment_order
-      #   # ...
-      # in :return
-      #   # ...
-      # in :reversal
-      #   # ...
-      # end
-      # ```
-      class ReturnableType < ModernTreasury::Enum
+      # Must be accompanied by `returnable_id`.
+      module ReturnableType
+        extend ModernTreasury::Internal::Type::Enum
+
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
         PAPER_ITEM = :paper_item
         PAYMENT_ORDER = :payment_order
@@ -119,7 +104,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end