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

data/lib/modern_treasury/models/incoming_payment_detail.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class IncomingPaymentDetail < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::IncomingPaymentDetails#retrieve
+    class IncomingPaymentDetail < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -10,7 +11,7 @@ module ModernTreasury
 
       # @!attribute amount
       #   Value in specified currency's smallest unit. e.g. $10 would be represented
-      #     as 1000.
+      #   as 1000.
       #
       #   @return [Integer]
       required :amount, Integer
@@ -36,7 +37,7 @@ module ModernTreasury
       #   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]
+      required :data, ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::Unknown]
 
       # @!attribute direction
       #   One of `credit` or `debit`.
@@ -46,31 +47,31 @@ module ModernTreasury
 
       # @!attribute internal_account_id
       #   The ID of the Internal Account for the incoming payment detail. This is always
-      #     present.
+      #   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`.
+      #   `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.
+      #   if it exists in the test environment.
       #
       #   @return [Boolean]
-      required :live_mode, ModernTreasury::BooleanModel
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}]
-      required :metadata, ModernTreasury::HashOf[String]
+      required :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!attribute object
       #
@@ -79,7 +80,7 @@ module ModernTreasury
 
       # @!attribute originating_account_number_safe
       #   The last 4 digits of the originating account_number for the incoming payment
-      #     detail.
+      #   detail.
       #
       #   @return [String, nil]
       required :originating_account_number_safe, String, nil?: true
@@ -108,7 +109,7 @@ module ModernTreasury
 
       # @!attribute status
       #   The current status of the incoming payment order. One of `pending`, `completed`,
-      #     or `returned`.
+      #   or `returned`.
       #
       #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetail::Status]
       required :status, enum: -> { ModernTreasury::Models::IncomingPaymentDetail::Status }
@@ -127,7 +128,7 @@ module ModernTreasury
 
       # @!attribute type
       #   One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
-      #     `wire`.
+      #   `wire`.
       #
       #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetail::Type]
       required :type, enum: -> { ModernTreasury::Models::IncomingPaymentDetail::Type }
@@ -145,14 +146,14 @@ module ModernTreasury
 
       # @!attribute virtual_account
       #   If the incoming payment detail is in a virtual account, the serialized virtual
-      #     account object.
+      #   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.
+      #   Account.
       #
       #   @return [String, nil]
       required :virtual_account_id, String, nil?: true
@@ -221,30 +222,14 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # The type of the originating account number for the incoming payment detail.
       #
-      # @example
-      # ```ruby
-      # case originating_account_number_type
-      # in :au_number
-      #   # ...
-      # in :clabe
-      #   # ...
-      # in :hk_number
-      #   # ...
-      # in :iban
-      #   # ...
-      # in :id_number
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class OriginatingAccountNumberType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::IncomingPaymentDetail#originating_account_number_type
+      module OriginatingAccountNumberType
+        extend ModernTreasury::Internal::Type::Enum
+
         AU_NUMBER = :au_number
         CLABE = :clabe
         HK_NUMBER = :hk_number
@@ -260,32 +245,15 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The type of the originating routing number for the incoming payment detail.
       #
-      # @example
-      # ```ruby
-      # case originating_routing_number_type
-      # in :aba
-      #   # ...
-      # in :au_bsb
-      #   # ...
-      # in :br_codigo
-      #   # ...
-      # in :ca_cpa
-      #   # ...
-      # in :chips
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class OriginatingRoutingNumberType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::IncomingPaymentDetail#originating_routing_number_type
+      module OriginatingRoutingNumberType
+        extend ModernTreasury::Internal::Type::Enum
+
         ABA = :aba
         AU_BSB = :au_bsb
         BR_CODIGO = :br_codigo
@@ -312,27 +280,16 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The current status of the incoming payment order. One of `pending`, `completed`,
-      #   or `returned`.
+      # or `returned`.
       #
-      # @example
-      # ```ruby
-      # case status
-      # in :completed
-      #   # ...
-      # in :pending
-      #   # ...
-      # in :returned
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # @see ModernTreasury::Models::IncomingPaymentDetail#status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         COMPLETED = :completed
         PENDING = :pending
         RETURNED = :returned
@@ -341,38 +298,25 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
-      #   `wire`.
+      # `wire`.
       #
-      # @example
-      # ```ruby
-      # case type
-      # in :ach
-      #   # ...
-      # in :book
-      #   # ...
-      # in :check
-      #   # ...
-      # in :eft
-      #   # ...
-      # in :interac
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Type < ModernTreasury::Enum
+      # @see ModernTreasury::Models::IncomingPaymentDetail#type
+      module Type
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
+        AU_BECS = :au_becs
+        BACS = :bacs
         BOOK = :book
         CHECK = :check
         EFT = :eft
         INTERAC = :interac
+        NEFT = :neft
+        NZ_BECS = :nz_becs
         RTP = :rtp
         SEPA = :sepa
         SIGNET = :signet
@@ -382,7 +326,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/incoming_payment_detail_create_async_params.rb

@@ -2,14 +2,15 @@
 
 module ModernTreasury
   module Models
-    class IncomingPaymentDetailCreateAsyncParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::IncomingPaymentDetails#create_async
+    class IncomingPaymentDetailCreateAsyncParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute [r] amount
       #   Value in specified currency's smallest unit. e.g. $10 would be represented
-      #     as 1000.
+      #   as 1000.
       #
       #   @return [Integer, nil]
       optional :amount, Integer
@@ -30,6 +31,13 @@ module ModernTreasury
       #   @return [Symbol, ModernTreasury::Models::Currency, nil]
       optional :currency, enum: -> { ModernTreasury::Models::Currency }, nil?: true
 
+      # @!attribute data
+      #   An object passed through to the simulated IPD that could reflect what a vendor
+      #   would pass.
+      #
+      #   @return [Object, nil]
+      optional :data, ModernTreasury::Internal::Type::Unknown, nil?: true
+
       # @!attribute description
       #   Defaults to a random description.
       #
@@ -69,7 +77,7 @@ module ModernTreasury
 
       # @!attribute virtual_account_id
       #   An optional parameter to associate the incoming payment detail to a virtual
-      #     account.
+      #   account.
       #
       #   @return [String, nil]
       optional :virtual_account_id, String, nil?: true
@@ -78,6 +86,7 @@ module ModernTreasury
       #   # @param amount [Integer]
       #   # @param as_of_date [Date, nil]
       #   # @param currency [Symbol, ModernTreasury::Models::Currency, nil]
+      #   # @param data [Object, nil]
       #   # @param description [String, nil]
       #   # @param direction [Symbol, ModernTreasury::Models::IncomingPaymentDetailCreateAsyncParams::Direction]
       #   # @param internal_account_id [String]
@@ -89,6 +98,7 @@ module ModernTreasury
       #     amount: nil,
       #     as_of_date: nil,
       #     currency: nil,
+      #     data: nil,
       #     description: nil,
       #     direction: nil,
       #     internal_account_id: nil,
@@ -100,22 +110,12 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # One of `credit`, `debit`.
-      #
-      # @example
-      # ```ruby
-      # case direction
-      # in :credit
-      #   # ...
-      # in :debit
-      #   # ...
-      # end
-      # ```
-      class Direction < ModernTreasury::Enum
+      module Direction
+        extend ModernTreasury::Internal::Type::Enum
+
         CREDIT = :credit
         DEBIT = :debit
 
@@ -123,37 +123,22 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of `ach`, `wire`, `check`.
-      #
-      # @example
-      # ```ruby
-      # case type
-      # in :ach
-      #   # ...
-      # in :book
-      #   # ...
-      # in :check
-      #   # ...
-      # in :eft
-      #   # ...
-      # in :interac
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Type < ModernTreasury::Enum
+      module Type
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
+        AU_BECS = :au_becs
+        BACS = :bacs
         BOOK = :book
         CHECK = :check
         EFT = :eft
         INTERAC = :interac
+        NEFT = :neft
+        NZ_BECS = :nz_becs
         RTP = :rtp
         SEPA = :sepa
         SIGNET = :signet
@@ -163,7 +148,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/incoming_payment_detail_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class IncomingPaymentDetailListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::IncomingPaymentDetails#list
+    class IncomingPaymentDetailListParams < 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] as_of_date_end
       #   Filters incoming payment details with an as_of_date starting on or before the
-      #     specified date (YYYY-MM-DD).
+      #   specified date (YYYY-MM-DD).
       #
       #   @return [Date, nil]
       optional :as_of_date_end, Date
@@ -25,7 +26,7 @@ module ModernTreasury
 
       # @!attribute [r] as_of_date_start
       #   Filters incoming payment details with an as_of_date starting on or after the
-      #     specified date (YYYY-MM-DD).
+      #   specified date (YYYY-MM-DD).
       #
       #   @return [Date, nil]
       optional :as_of_date_start, Date
@@ -46,11 +47,11 @@ module ModernTreasury
 
       # @!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.
+      #   `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #   parameters.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -67,7 +68,7 @@ module ModernTreasury
 
       # @!attribute [r] status
       #   The current status of the incoming payment order. One of `pending`, `completed`,
-      #     or `returned`.
+      #   or `returned`.
       #
       #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Status, nil]
       optional :status, enum: -> { ModernTreasury::Models::IncomingPaymentDetailListParams::Status }
@@ -78,7 +79,7 @@ module ModernTreasury
 
       # @!attribute [r] type
       #   One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
-      #     `wire`.
+      #   `wire`.
       #
       #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type, nil]
       optional :type, enum: -> { ModernTreasury::Models::IncomingPaymentDetailListParams::Type }
@@ -89,7 +90,7 @@ module ModernTreasury
 
       # @!attribute [r] virtual_account_id
       #   If the incoming payment detail is in a virtual account, the ID of the Virtual
-      #     Account.
+      #   Account.
       #
       #   @return [String, nil]
       optional :virtual_account_id, String
@@ -126,25 +127,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # The current status of the incoming payment order. One of `pending`, `completed`,
-      #   or `returned`.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :completed
-      #   # ...
-      # in :pending
-      #   # ...
-      # in :returned
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # or `returned`.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         COMPLETED = :completed
         PENDING = :pending
         RETURNED = :returned
@@ -153,38 +142,23 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
-      #   `wire`.
-      #
-      # @example
-      # ```ruby
-      # case type
-      # in :ach
-      #   # ...
-      # in :book
-      #   # ...
-      # in :check
-      #   # ...
-      # in :eft
-      #   # ...
-      # in :interac
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Type < ModernTreasury::Enum
+      # `wire`.
+      module Type
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
+        AU_BECS = :au_becs
+        BACS = :bacs
         BOOK = :book
         CHECK = :check
         EFT = :eft
         INTERAC = :interac
+        NEFT = :neft
+        NZ_BECS = :nz_becs
         RTP = :rtp
         SEPA = :sepa
         SIGNET = :signet
@@ -194,7 +168,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/incoming_payment_detail_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class IncomingPaymentDetailRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::IncomingPaymentDetails#retrieve
+    class IncomingPaymentDetailRetrieveParams < 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/incoming_payment_detail_update_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class IncomingPaymentDetailUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::IncomingPaymentDetails#update
+    class IncomingPaymentDetailUpdateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute [r] metadata
       #   Additional data in the form of key-value pairs. Pairs can be removed by passing
-      #     an empty string or `null` as the value.
+      #   an empty string or `null` as the value.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -24,7 +25,7 @@ module ModernTreasury
       #   #
       #   def initialize(metadata: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end