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

data/lib/modern_treasury/models/external_account_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class ExternalAccountCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExternalAccounts#create
+    class ExternalAccountCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute counterparty_id
       #
@@ -16,7 +17,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail>, nil]
       optional :account_details,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail>]
@@ -36,7 +37,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::ExternalAccountCreateParams::ContactDetail>, nil]
       optional :contact_details,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ExternalAccountCreateParams::ContactDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ExternalAccountCreateParams::ContactDetail] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::ExternalAccountCreateParams::ContactDetail>]
@@ -44,10 +45,10 @@ module ModernTreasury
 
       # @!attribute [r] ledger_account
       #   Specifies a ledger account object that will be created with the external
-      #     account. The resulting ledger account is linked to the external account for
-      #     auto-ledgering Payment objects. See
-      #     https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
-      #     for more details.
+      #   account. The resulting ledger account is linked to the external account for
+      #   auto-ledgering Payment objects. See
+      #   https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
+      #   for more details.
       #
       #   @return [ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount, nil]
       optional :ledger_account, -> { ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount }
@@ -58,10 +59,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}]
@@ -69,7 +70,7 @@ module ModernTreasury
 
       # @!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]
       optional :name, String, nil?: true
@@ -113,7 +114,7 @@ module ModernTreasury
 
       # @!attribute [r] plaid_processor_token
       #   If you've enabled the Modern Treasury + Plaid integration in your Plaid account,
-      #     you can pass the processor token in this field.
+      #   you can pass the processor token in this field.
       #
       #   @return [String, nil]
       optional :plaid_processor_token, String
@@ -126,7 +127,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail>, nil]
       optional :routing_details,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail>]
@@ -168,9 +169,9 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class AccountDetail < ModernTreasury::BaseModel
+      class AccountDetail < ModernTreasury::Internal::Type::BaseModel
         # @!attribute account_number
         #
         #   @return [String]
@@ -192,28 +193,12 @@ module ModernTreasury
         #   #
         #   def initialize(account_number:, account_number_type: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+        # @see ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail#account_number_type
+        module AccountNumberType
+          extend ModernTreasury::Internal::Type::Enum
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case account_number_type
-        # in :au_number
-        #   # ...
-        # in :clabe
-        #   # ...
-        # in :hk_number
-        #   # ...
-        # in :iban
-        #   # ...
-        # in :id_number
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class AccountNumberType < ModernTreasury::Enum
           AU_NUMBER = :au_number
           CLABE = :clabe
           HK_NUMBER = :hk_number
@@ -229,12 +214,11 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      class ContactDetail < ModernTreasury::BaseModel
+      class ContactDetail < ModernTreasury::Internal::Type::BaseModel
         # @!attribute [r] contact_identifier
         #
         #   @return [String, nil]
@@ -260,22 +244,12 @@ module ModernTreasury
         #   #
         #   def initialize(contact_identifier: nil, contact_identifier_type: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+        # @see ModernTreasury::Models::ExternalAccountCreateParams::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
@@ -284,12 +258,11 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      class LedgerAccount < ModernTreasury::BaseModel
+      class LedgerAccount < ModernTreasury::Internal::Type::BaseModel
         # @!attribute currency
         #   The currency of the ledger account.
         #
@@ -328,10 +301,10 @@ module ModernTreasury
 
         # @!attribute [r] ledger_account_category_ids
         #   The array of ledger account category ids that this ledger account should be a
-        #     child of.
+        #   child of.
         #
         #   @return [Array<String>, nil]
-        optional :ledger_account_category_ids, ModernTreasury::ArrayOf[String]
+        optional :ledger_account_category_ids, ModernTreasury::Internal::Type::ArrayOf[String]
 
         # @!parse
         #   # @return [Array<String>]
@@ -339,7 +312,7 @@ module ModernTreasury
 
         # @!attribute [r] ledgerable_id
         #   If the ledger account links to another object in Modern Treasury, the id will be
-        #     populated here, otherwise null.
+        #   populated here, otherwise null.
         #
         #   @return [String, nil]
         optional :ledgerable_id, String
@@ -350,8 +323,8 @@ module ModernTreasury
 
         # @!attribute [r] ledgerable_type
         #   If the ledger account links to another object in Modern Treasury, the type will
-        #     be populated here, otherwise null. The value is one of internal_account or
-        #     external_account.
+        #   be populated here, otherwise null. The value is one of internal_account or
+        #   external_account.
         #
         #   @return [Symbol, ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount::LedgerableType, nil]
         optional :ledgerable_type,
@@ -363,10 +336,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}]
@@ -374,10 +347,10 @@ module ModernTreasury
 
         # @!parse
         #   # Specifies a ledger account object that will be created with the external
-        #   #   account. The resulting ledger account is linked to the external account for
-        #   #   auto-ledgering Payment objects. See
-        #   #   https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
-        #   #   for more details.
+        #   # account. The resulting ledger account is linked to the external account for
+        #   # auto-ledgering Payment objects. See
+        #   # https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects
+        #   # for more details.
         #   #
         #   # @param currency [String]
         #   # @param ledger_id [String]
@@ -406,28 +379,16 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        # @abstract
-        #
         # If the ledger account links to another object in Modern Treasury, the type will
-        #   be populated here, otherwise null. The value is one of internal_account or
-        #   external_account.
+        # be populated here, otherwise null. The value is one of internal_account or
+        # external_account.
         #
-        # @example
-        # ```ruby
-        # case ledgerable_type
-        # in :counterparty
-        #   # ...
-        # in :external_account
-        #   # ...
-        # in :internal_account
-        #   # ...
-        # in :virtual_account
-        #   # ...
-        # end
-        # ```
-        class LedgerableType < ModernTreasury::Enum
+        # @see ModernTreasury::Models::ExternalAccountCreateParams::LedgerAccount#ledgerable_type
+        module LedgerableType
+          extend ModernTreasury::Internal::Type::Enum
+
           COUNTERPARTY = :counterparty
           EXTERNAL_ACCOUNT = :external_account
           INTERNAL_ACCOUNT = :internal_account
@@ -437,12 +398,11 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      class PartyAddress < ModernTreasury::BaseModel
+      class PartyAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -489,23 +449,13 @@ module ModernTreasury
         #   #
         #   def initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil, **) = super
 
-        # 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
+      module PartyType
+        extend ModernTreasury::Internal::Type::Enum
+
         BUSINESS = :business
         INDIVIDUAL = :individual
 
@@ -513,11 +463,10 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      class RoutingDetail < ModernTreasury::BaseModel
+      class RoutingDetail < ModernTreasury::Internal::Type::BaseModel
         # @!attribute routing_number
         #
         #   @return [String]
@@ -546,28 +495,12 @@ module ModernTreasury
         #   #
         #   def initialize(routing_number:, routing_number_type:, payment_type: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+        # @see ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail#routing_number_type
+        module RoutingNumberType
+          extend ModernTreasury::Internal::Type::Enum
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case routing_number_type
-        # in :aba
-        #   # ...
-        # in :au_bsb
-        #   # ...
-        # in :br_codigo
-        #   # ...
-        # in :ca_cpa
-        #   # ...
-        # in :chips
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class RoutingNumberType < ModernTreasury::Enum
           ABA = :aba
           AU_BSB = :au_bsb
           BR_CODIGO = :br_codigo
@@ -594,30 +527,13 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case payment_type
-        # in :ach
-        #   # ...
-        # in :au_becs
-        #   # ...
-        # in :bacs
-        #   # ...
-        # in :book
-        #   # ...
-        # in :card
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class PaymentType < ModernTreasury::Enum
+        # @see ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail#payment_type
+        module PaymentType
+          extend ModernTreasury::Internal::Type::Enum
+
           ACH = :ach
           AU_BECS = :au_becs
           BACS = :bacs
@@ -653,7 +569,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/modern_treasury/models/external_account_delete_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class ExternalAccountDeleteParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExternalAccounts#delete
+    class ExternalAccountDeleteParams < 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/external_account_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class ExternalAccountListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExternalAccounts#list
+    class ExternalAccountListParams < 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
       #
@@ -23,11 +24,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}]
@@ -72,7 +73,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/external_account_retrieve_params.rb

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

@@ -2,28 +2,10 @@
 
 module ModernTreasury
   module Models
-    # @abstract
-    #
     # Can be `checking`, `savings` or `other`.
-    #
-    # @example
-    # ```ruby
-    # case external_account_type
-    # in :cash
-    #   # ...
-    # in :checking
-    #   # ...
-    # in :general_ledger
-    #   # ...
-    # in :loan
-    #   # ...
-    # in :non_resident
-    #   # ...
-    # in ...
-    #   #...
-    # end
-    # ```
-    class ExternalAccountType < ModernTreasury::Enum
+    module ExternalAccountType
+      extend ModernTreasury::Internal::Type::Enum
+
       CASH = :cash
       CHECKING = :checking
       GENERAL_LEDGER = :general_ledger
@@ -37,7 +19,6 @@ module ModernTreasury
 
       # @!parse
       #   # @return [Array<Symbol>]
-      #   #
       #   def self.values; end
     end
   end

data/lib/modern_treasury/models/external_account_update_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class ExternalAccountUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::ExternalAccounts#update
+    class ExternalAccountUpdateParams < 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] account_type
       #   Can be `checking`, `savings` or `other`.
@@ -24,10 +25,10 @@ module ModernTreasury
 
       # @!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}]
@@ -35,7 +36,7 @@ module ModernTreasury
 
       # @!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]
       optional :name, String, nil?: true
@@ -91,9 +92,9 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class PartyAddress < ModernTreasury::BaseModel
+      class PartyAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -138,23 +139,13 @@ module ModernTreasury
         #   #
         #   def initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil, **) = super
 
-        # 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
+      module PartyType
+        extend ModernTreasury::Internal::Type::Enum
+
         BUSINESS = :business
         INDIVIDUAL = :individual
 
@@ -162,7 +153,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end