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

data/lib/modern_treasury/models/routing_detail_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class RoutingDetailCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::RoutingDetails#create
+    class RoutingDetailCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute accounts_type
       #
@@ -20,8 +21,8 @@ module ModernTreasury
 
       # @!attribute routing_number_type
       #   The type of routing number. See
-      #     https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #     more details.
+      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #   more details.
       #
       #   @return [Symbol, ModernTreasury::Models::RoutingDetailCreateParams::RoutingNumberType]
       required :routing_number_type,
@@ -29,7 +30,7 @@ module ModernTreasury
 
       # @!attribute payment_type
       #   If the routing detail is to be used for a specific payment type this field will
-      #     be populated, otherwise null.
+      #   be populated, otherwise null.
       #
       #   @return [Symbol, ModernTreasury::Models::RoutingDetailCreateParams::PaymentType, nil]
       optional :payment_type,
@@ -45,52 +46,26 @@ module ModernTreasury
       #   #
       #   def initialize(accounts_type:, routing_number:, routing_number_type:, payment_type: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      module AccountsType
+        extend ModernTreasury::Internal::Type::Enum
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case accounts_type
-      # in :external_accounts
-      #   # ...
-      # end
-      # ```
-      class AccountsType < ModernTreasury::Enum
         EXTERNAL_ACCOUNTS = :external_accounts
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The type of routing number. See
-      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #   more details.
-      #
-      # @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
+      # https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      # more details.
+      module RoutingNumberType
+        extend ModernTreasury::Internal::Type::Enum
+
         ABA = :aba
         AU_BSB = :au_bsb
         BR_CODIGO = :br_codigo
@@ -117,33 +92,14 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # If the routing detail is to be used for a specific payment type this field will
-      #   be populated, otherwise null.
-      #
-      # @example
-      # ```ruby
-      # case payment_type
-      # in :ach
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in :card
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class PaymentType < ModernTreasury::Enum
+      # be populated, otherwise null.
+      module PaymentType
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -179,7 +135,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/routing_detail_delete_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class RoutingDetailDeleteParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::RoutingDetails#delete
+    class RoutingDetailDeleteParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute accounts_type
       #
@@ -24,25 +25,17 @@ module ModernTreasury
       #   #
       #   def initialize(accounts_type:, account_id:, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      module AccountsType
+        extend ModernTreasury::Internal::Type::Enum
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case accounts_type
-      # in :external_accounts
-      #   # ...
-      # end
-      # ```
-      class AccountsType < ModernTreasury::Enum
         EXTERNAL_ACCOUNTS = :external_accounts
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/routing_detail_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class RoutingDetailListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::RoutingDetails#list
+    class RoutingDetailListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute accounts_type
       #
@@ -34,7 +35,7 @@ module ModernTreasury
       #   #
       #   def initialize(accounts_type:, after_cursor: nil, per_page: nil, 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/routing_detail_retrieve_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class RoutingDetailRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::RoutingDetails#retrieve
+    class RoutingDetailRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute accounts_type
       #
@@ -24,7 +25,7 @@ module ModernTreasury
       #   #
       #   def initialize(accounts_type:, account_id:, 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/routing_number_lookup_request.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class RoutingNumberLookupRequest < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Validations#validate_routing_number
+    class RoutingNumberLookupRequest < ModernTreasury::Internal::Type::BaseModel
       # @!attribute [r] bank_address
       #   The address of the bank.
       #
@@ -35,9 +36,9 @@ module ModernTreasury
 
       # @!attribute [r] routing_number_type
       #   The type of routing number. See
-      #     https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #     more details. In sandbox mode we currently only support `aba` and `swift` with
-      #     routing numbers '123456789' and 'GRINUST0XXX' respectively.
+      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #   more details. In sandbox mode we currently only support `aba` and `swift` with
+      #   routing numbers '123456789' and 'GRINUST0XXX' respectively.
       #
       #   @return [Symbol, ModernTreasury::Models::RoutingNumberLookupRequest::RoutingNumberType, nil]
       optional :routing_number_type,
@@ -49,11 +50,11 @@ module ModernTreasury
 
       # @!attribute [r] sanctions
       #   An object containing key-value pairs, each with a sanctions list as the key and
-      #     a boolean value representing whether the bank is on that particular sanctions
-      #     list. Currently, this includes eu_con, uk_hmt, us_ofac, and un sanctions lists.
+      #   a boolean value representing whether the bank is on that particular sanctions
+      #   list. Currently, this includes eu_con, uk_hmt, us_ofac, and un sanctions lists.
       #
       #   @return [Hash{Symbol=>Object}, nil]
-      optional :sanctions, ModernTreasury::HashOf[ModernTreasury::Unknown]
+      optional :sanctions, ModernTreasury::Internal::Type::HashOf[ModernTreasury::Internal::Type::Unknown]
 
       # @!parse
       #   # @return [Hash{Symbol=>Object}]
@@ -61,11 +62,11 @@ module ModernTreasury
 
       # @!attribute [r] supported_payment_types
       #   An array of payment types that are supported for this routing number. This can
-      #     include `ach`, `wire`, `rtp`, `sepa`, `bacs`, `au_becs`, and 'fednow' currently.
+      #   include `ach`, `wire`, `rtp`, `sepa`, `bacs`, `au_becs`, and 'fednow' currently.
       #
       #   @return [Array<Symbol, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType>, nil]
       optional :supported_payment_types,
-               -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType] }
 
       # @!parse
       #   # @return [Array<Symbol, ModernTreasury::Models::RoutingNumberLookupRequest::SupportedPaymentType>]
@@ -91,9 +92,10 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class BankAddress < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::RoutingNumberLookupRequest#bank_address
+      class BankAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -140,34 +142,18 @@ 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
-      #
       # The type of routing number. See
-      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #   more details. In sandbox mode we currently only support `aba` and `swift` with
-      #   routing numbers '123456789' and 'GRINUST0XXX' respectively.
+      # https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      # more details. In sandbox mode we currently only support `aba` and `swift` with
+      # routing numbers '123456789' and 'GRINUST0XXX' respectively.
       #
-      # @example
-      # ```ruby
-      # case routing_number_type
-      # in :aba
-      #   # ...
-      # in :au_bsb
-      #   # ...
-      # in :ca_cpa
-      #   # ...
-      # in :gb_sort_code
-      #   # ...
-      # in :in_ifsc
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class RoutingNumberType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::RoutingNumberLookupRequest#routing_number_type
+      module RoutingNumberType
+        extend ModernTreasury::Internal::Type::Enum
+
         ABA = :aba
         AU_BSB = :au_bsb
         CA_CPA = :ca_cpa
@@ -176,35 +162,18 @@ module ModernTreasury
         NZ_NATIONAL_CLEARING_CODE = :nz_national_clearing_code
         SE_BANKGIRO_CLEARING_CODE = :se_bankgiro_clearing_code
         SWIFT = :swift
+        ZA_NATIONAL_CLEARING_CODE = :za_national_clearing_code
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case supported_payment_type
-      # in :ach
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in :card
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class SupportedPaymentType < ModernTreasury::Enum
+      module SupportedPaymentType
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -240,7 +209,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/transaction.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class Transaction < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Transactions#create
+    class Transaction < 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
@@ -23,14 +24,14 @@ module ModernTreasury
 
       # @!attribute as_of_time
       #   The time on which the transaction occurred. Depending on the granularity of the
-      #     timestamp information received from the bank, it may be `null`.
+      #   timestamp information received from the bank, it may be `null`.
       #
-      #   @return [String, nil]
-      required :as_of_time, String, nil?: true
+      #   @return [Time, nil]
+      required :as_of_time, Time, nil?: true
 
       # @!attribute as_of_timezone
       #   The timezone in which the `as_of_time` is represented. Can be `null` if the bank
-      #     does not provide timezone info.
+      #   does not provide timezone info.
       #
       #   @return [String, nil]
       required :as_of_timezone, String, nil?: true
@@ -48,10 +49,10 @@ module ModernTreasury
 
       # @!attribute custom_identifiers
       #   An object containing key-value pairs, each with a custom identifier as the key
-      #     and a string value.
+      #   and a string value.
       #
       #   @return [Hash{Symbol=>String}]
-      required :custom_identifiers, ModernTreasury::HashOf[String]
+      required :custom_identifiers, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!attribute direction
       #   Either `credit` or `debit`.
@@ -80,17 +81,17 @@ 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 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
       #
@@ -101,19 +102,19 @@ module ModernTreasury
       #   This field will be `true` if the transaction has posted to the account.
       #
       #   @return [Boolean]
-      required :posted, ModernTreasury::BooleanModel
+      required :posted, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute reconciled
       #   This field will be `true` if a transaction is reconciled by the Modern Treasury
-      #     system. This means that it has transaction line items that sum up to the
-      #     transaction's amount.
+      #   system. This means that it has transaction line items that sum up to the
+      #   transaction's amount.
       #
       #   @return [Boolean]
-      required :reconciled, ModernTreasury::BooleanModel
+      required :reconciled, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute type
       #   The type of the transaction. Examples could be
-      #     `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+      #   `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
       #
       #   @return [Symbol, ModernTreasury::Models::Transaction::Type]
       required :type, enum: -> { ModernTreasury::Models::Transaction::Type }
@@ -125,16 +126,16 @@ module ModernTreasury
 
       # @!attribute vendor_code
       #   When applicable, the bank-given code that determines the transaction's category.
-      #     For most banks this is the BAI2/BTRS transaction code.
+      #   For most banks this is the BAI2/BTRS transaction code.
       #
       #   @return [String, nil]
       required :vendor_code, String, nil?: true
 
       # @!attribute vendor_code_type
       #   The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
-      #     `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
-      #     `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
-      #     `swift`, `us_bank`, or others.
+      #   `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
+      #   `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
+      #   `swift`, `us_bank`, or others.
       #
       #   @return [Symbol, ModernTreasury::Models::Transaction::VendorCodeType, nil]
       required :vendor_code_type, enum: -> { ModernTreasury::Models::Transaction::VendorCodeType }, nil?: true
@@ -153,15 +154,15 @@ module ModernTreasury
 
       # @!attribute [r] details
       #   This field contains additional information that the bank provided about the
-      #     transaction. This is structured data. Some of the data in here might overlap
-      #     with what is in the `vendor_description`. For example, the OBI could be a part
-      #     of the vendor description, and it would also be included in here. The attributes
-      #     that are passed through the details field will vary based on your banking
-      #     partner. Currently, the following keys may be in the details object:
-      #     `originator_name`, `originator_to_beneficiary_information`.
+      #   transaction. This is structured data. Some of the data in here might overlap
+      #   with what is in the `vendor_description`. For example, the OBI could be a part
+      #   of the vendor description, and it would also be included in here. The attributes
+      #   that are passed through the details field will vary based on your banking
+      #   partner. Currently, the following keys may be in the details object:
+      #   `originator_name`, `originator_to_beneficiary_information`.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :details, ModernTreasury::HashOf[String]
+      optional :details, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -169,7 +170,7 @@ module ModernTreasury
 
       # @!attribute vendor_description
       #   The transaction detail text that often appears in on your bank statement and in
-      #     your banking portal.
+      #   your banking portal.
       #
       #   @return [String, nil]
       optional :vendor_description, String, nil?: true
@@ -178,7 +179,7 @@ module ModernTreasury
       #   # @param id [String]
       #   # @param amount [Integer]
       #   # @param as_of_date [Date, nil]
-      #   # @param as_of_time [String, nil]
+      #   # @param as_of_time [Time, nil]
       #   # @param as_of_timezone [String, nil]
       #   # @param created_at [Time]
       #   # @param currency [Symbol, ModernTreasury::Models::Currency]
@@ -232,12 +233,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class ForeignExchangeRate < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::Transaction#foreign_exchange_rate
+      class ForeignExchangeRate < ModernTreasury::Internal::Type::BaseModel
         # @!attribute base_amount
         #   Amount in the lowest denomination of the `base_currency` to convert, often
-        #     called the "sell" amount.
+        #   called the "sell" amount.
         #
         #   @return [Integer]
         required :base_amount, Integer
@@ -250,7 +252,7 @@ module ModernTreasury
 
         # @!attribute exponent
         #   The exponent component of the rate. The decimal is calculated as `value` / (10 ^
-        #     `exponent`).
+        #   `exponent`).
         #
         #   @return [Integer]
         required :exponent, Integer
@@ -263,7 +265,7 @@ module ModernTreasury
 
         # @!attribute target_amount
         #   Amount in the lowest denomination of the `target_currency`, often called the
-        #     "buy" amount.
+        #   "buy" amount.
         #
         #   @return [Integer]
         required :target_amount, Integer
@@ -276,7 +278,7 @@ module ModernTreasury
 
         # @!attribute value
         #   The whole number component of the rate. The decimal is calculated as `value` /
-        #     (10 ^ `exponent`).
+        #   (10 ^ `exponent`).
         #
         #   @return [Integer]
         required :value, Integer
@@ -294,32 +296,16 @@ module ModernTreasury
         #   #
         #   def initialize(base_amount:, base_currency:, exponent:, rate_string:, target_amount:, target_currency:, value:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # The type of the transaction. Examples could be
-      #   `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
+      # `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
       #
-      # @example
-      # ```ruby
-      # case type
-      # in :ach
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in :card
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Type < ModernTreasury::Enum
+      # @see ModernTreasury::Models::Transaction#type
+      module Type
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -356,35 +342,18 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
-      #   `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
-      #   `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
-      #   `swift`, `us_bank`, or others.
+      # `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
+      # `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
+      # `swift`, `us_bank`, or others.
       #
-      # @example
-      # ```ruby
-      # case vendor_code_type
-      # in :bai2
-      #   # ...
-      # in :banking_circle
-      #   # ...
-      # in :bankprov
-      #   # ...
-      # in :bnk_dev
-      #   # ...
-      # in :cleartouch
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class VendorCodeType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::Transaction#vendor_code_type
+      module VendorCodeType
+        extend ModernTreasury::Internal::Type::Enum
+
         BAI2 = :bai2
         BANKING_CIRCLE = :banking_circle
         BANKPROV = :bankprov
@@ -400,6 +369,7 @@ module ModernTreasury
         ISO20022 = :iso20022
         JPMC = :jpmc
         MX = :mx
+        PAYPAL = :paypal
         PLAID = :plaid
         PNC = :pnc
         RSPEC_VENDOR = :rspec_vendor
@@ -413,7 +383,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end