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

data/lib/modern_treasury/models/expected_payment_update_params.rb

@@ -2,21 +2,22 @@
 
 module ModernTreasury
   module Models
-    class ExpectedPaymentUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExpectedPayments#update
+    class ExpectedPaymentUpdateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!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, nil]
       optional :amount_lower_bound, Integer, nil?: true
 
       # @!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, nil]
       optional :amount_upper_bound, Integer, nil?: true
@@ -53,7 +54,7 @@ module ModernTreasury
 
       # @!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::ExpectedPaymentUpdateParams::Direction, nil]
       optional :direction,
@@ -68,10 +69,10 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   Additional data represented as key-value pairs. Both the key and value must be
-      #     strings.
+      #   strings.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -81,49 +82,49 @@ module ModernTreasury
       #   The reconciliation filters you have for this payment.
       #
       #   @return [Object, nil]
-      optional :reconciliation_filters, ModernTreasury::Unknown, nil?: true
+      optional :reconciliation_filters, ModernTreasury::Internal::Type::Unknown, nil?: true
 
       # @!attribute reconciliation_groups
       #   The reconciliation groups you have for this payment.
       #
       #   @return [Object, nil]
-      optional :reconciliation_groups, ModernTreasury::Unknown, nil?: true
+      optional :reconciliation_groups, ModernTreasury::Internal::Type::Unknown, nil?: true
 
       # @!attribute reconciliation_rule_variables
       #   An array of reconciliation rule variables for this payment.
       #
       #   @return [Array<ModernTreasury::Models::ReconciliationRule>, nil]
       optional :reconciliation_rule_variables,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ReconciliationRule] },
                nil?: true
 
       # @!attribute remittance_information
       #   For `ach`, this field will be passed through on an addenda record. For `wire`
-      #     payments the field will be passed through as the "Originator to Beneficiary
-      #     Information", also known as OBI or Fedwire tag 6000.
+      #   payments the field will be passed through as the "Originator to Beneficiary
+      #   Information", also known as OBI or Fedwire tag 6000.
       #
       #   @return [String, nil]
       optional :remittance_information, String, nil?: true
 
       # @!attribute statement_descriptor
       #   The statement description you expect to see on the transaction. For ACH
-      #     payments, this will be the full line item passed from the bank. For wire
-      #     payments, this will be the OBI field on the wire. For check payments, this will
-      #     be the memo field.
+      #   payments, this will be the full line item passed from the bank. For wire
+      #   payments, this will be the OBI field on the wire. For check payments, this will
+      #   be the memo field.
       #
       #   @return [String, nil]
       optional :statement_descriptor, String, nil?: true
 
       # @!attribute status
       #   The Expected Payment's status can be updated from partially_reconciled to
-      #     reconciled.
+      #   reconciled.
       #
       #   @return [Symbol, ModernTreasury::Models::ExpectedPaymentUpdateParams::Status, nil]
       optional :status, enum: -> { ModernTreasury::Models::ExpectedPaymentUpdateParams::Status }, nil?: true
 
       # @!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::ExpectedPaymentType, nil]
       optional :type, enum: -> { ModernTreasury::Models::ExpectedPaymentType }, nil?: true
@@ -172,23 +173,13 @@ 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.
-      #
-      # @example
-      # ```ruby
-      # case direction
-      # in :credit
-      #   # ...
-      # in :debit
-      #   # ...
-      # end
-      # ```
-      class Direction < ModernTreasury::Enum
+      # being charged, use debit.
+      module Direction
+        extend ModernTreasury::Internal::Type::Enum
+
         CREDIT = :credit
         DEBIT = :debit
 
@@ -196,30 +187,20 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The Expected Payment's status can be updated from partially_reconciled to
-      #   reconciled.
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :reconciled
-      #   # ...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # reconciled.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         RECONCILED = :reconciled
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/external_account.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class ExternalAccount < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExternalAccounts#create
+    class ExternalAccount < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -11,7 +12,8 @@ module ModernTreasury
       # @!attribute account_details
       #
       #   @return [Array<ModernTreasury::Models::AccountDetail>]
-      required :account_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::AccountDetail] }
+      required :account_details,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::AccountDetail] }
 
       # @!attribute account_type
       #   Can be `checking`, `savings` or `other`.
@@ -23,7 +25,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::ExternalAccount::ContactDetail>]
       required :contact_details,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ExternalAccount::ContactDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ExternalAccount::ContactDetail] }
 
       # @!attribute counterparty_id
       #
@@ -42,28 +44,28 @@ module ModernTreasury
 
       # @!attribute ledger_account_id
       #   If the external account links to a ledger account in Modern Treasury, the id of
-      #     the ledger account will be populated here.
+      #   the ledger account will be populated here.
       #
       #   @return [String, nil]
       required :ledger_account_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 name
       #   A nickname for the external account. This is only for internal usage and won't
-      #     affect any payments
+      #   affect any payments
       #
       #   @return [String, nil]
       required :name, String, nil?: true
@@ -94,7 +96,8 @@ module ModernTreasury
       # @!attribute routing_details
       #
       #   @return [Array<ModernTreasury::Models::RoutingDetail>]
-      required :routing_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::RoutingDetail] }
+      required :routing_details,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::RoutingDetail] }
 
       # @!attribute updated_at
       #
@@ -159,9 +162,9 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class ContactDetail < ModernTreasury::BaseModel
+      class ContactDetail < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -190,10 +193,10 @@ module ModernTreasury
 
         # @!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 object
         #
@@ -229,22 +232,12 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+        # @see ModernTreasury::Models::ExternalAccount::ContactDetail#contact_identifier_type
+        module ContactIdentifierType
+          extend ModernTreasury::Internal::Type::Enum
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case contact_identifier_type
-        # in :email
-        #   # ...
-        # in :phone_number
-        #   # ...
-        # in :website
-        #   # ...
-        # end
-        # ```
-        class ContactIdentifierType < ModernTreasury::Enum
           EMAIL = :email
           PHONE_NUMBER = :phone_number
           WEBSITE = :website
@@ -253,12 +246,12 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      class PartyAddress < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::ExternalAccount#party_address
+      class PartyAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -287,10 +280,10 @@ module ModernTreasury
 
         # @!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 locality
         #   Locality or City.
@@ -352,23 +345,15 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # Either `individual` or `business`.
       #
-      # @example
-      # ```ruby
-      # case party_type
-      # in :business
-      #   # ...
-      # in :individual
-      #   # ...
-      # end
-      # ```
-      class PartyType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::ExternalAccount#party_type
+      module PartyType
+        extend ModernTreasury::Internal::Type::Enum
+
         BUSINESS = :business
         INDIVIDUAL = :individual
 
@@ -376,24 +361,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case verification_source
-      # in :ach_prenote
-      #   # ...
-      # in :microdeposits
-      #   # ...
-      # in :plaid
-      #   # ...
-      # end
-      # ```
-      class VerificationSource < ModernTreasury::Enum
+      # @see ModernTreasury::Models::ExternalAccount#verification_source
+      module VerificationSource
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH_PRENOTE = :ach_prenote
         MICRODEPOSITS = :microdeposits
         PLAID = :plaid
@@ -402,24 +376,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case verification_status
-      # in :pending_verification
-      #   # ...
-      # in :unverified
-      #   # ...
-      # in :verified
-      #   # ...
-      # end
-      # ```
-      class VerificationStatus < ModernTreasury::Enum
+      # @see ModernTreasury::Models::ExternalAccount#verification_status
+      module VerificationStatus
+        extend ModernTreasury::Internal::Type::Enum
+
         PENDING_VERIFICATION = :pending_verification
         UNVERIFIED = :unverified
         VERIFIED = :verified
@@ -428,7 +391,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/external_account_complete_verification_params.rb

@@ -2,15 +2,16 @@
 
 module ModernTreasury
   module Models
-    class ExternalAccountCompleteVerificationParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExternalAccounts#complete_verification
+    class ExternalAccountCompleteVerificationParams < 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] amounts
       #
       #   @return [Array<Integer>, nil]
-      optional :amounts, ModernTreasury::ArrayOf[Integer]
+      optional :amounts, ModernTreasury::Internal::Type::ArrayOf[Integer]
 
       # @!parse
       #   # @return [Array<Integer>]
@@ -22,7 +23,7 @@ module ModernTreasury
       #   #
       #   def initialize(amounts: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end