modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/counterparty_create_params.rb

@@ -161,21 +161,11 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
         # An optional type to auto-sync the counterparty to your ledger. Either `customer`
         #   or `vendor`.
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :customer
-        #   # ...
-        # in :vendor
-        #   # ...
-        # end
-        # ```
-        class Type < ModernTreasury::Enum
+        module Type
+          extend ModernTreasury::Enum
+
           CUSTOMER = :customer
           VENDOR = :vendor
 
@@ -183,7 +173,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
@@ -367,26 +356,9 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-          # @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
+          module AccountNumberType
+            extend ModernTreasury::Enum
+
             AU_NUMBER = :au_number
             CLABE = :clabe
             HK_NUMBER = :hk_number
@@ -402,7 +374,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -435,20 +406,9 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case contact_identifier_type
-          # in :email
-          #   # ...
-          # in :phone_number
-          #   # ...
-          # in :website
-          #   # ...
-          # end
-          # ```
-          class ContactIdentifierType < ModernTreasury::Enum
+          module ContactIdentifierType
+            extend ModernTreasury::Enum
+
             EMAIL = :email
             PHONE_NUMBER = :phone_number
             WEBSITE = :website
@@ -457,7 +417,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -581,26 +540,12 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::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.
-          #
-          # @example
-          # ```ruby
-          # case ledgerable_type
-          # in :counterparty
-          #   # ...
-          # in :external_account
-          #   # ...
-          # in :internal_account
-          #   # ...
-          # in :virtual_account
-          #   # ...
-          # end
-          # ```
-          class LedgerableType < ModernTreasury::Enum
+          module LedgerableType
+            extend ModernTreasury::Enum
+
             COUNTERPARTY = :counterparty
             EXTERNAL_ACCOUNT = :external_account
             INTERNAL_ACCOUNT = :internal_account
@@ -610,7 +555,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -665,20 +609,10 @@ module ModernTreasury
           # def initialize: (Hash | ModernTreasury::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::Enum
+
           BUSINESS = :business
           INDIVIDUAL = :individual
 
@@ -686,7 +620,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
@@ -721,26 +654,9 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-          # @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
+          module RoutingNumberType
+            extend ModernTreasury::Enum
+
             ABA = :aba
             AU_BSB = :au_bsb
             BR_CODIGO = :br_codigo
@@ -767,30 +683,12 @@ 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
+          module PaymentType
+            extend ModernTreasury::Enum
+
             ACH = :ach
             AU_BECS = :au_becs
             BACS = :bacs
@@ -826,29 +724,18 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
       end
 
-      # @abstract
-      #
       # @deprecated
       #
-      #   An optional type to auto-sync the counterparty to your ledger. Either `customer`
+      # An optional type to auto-sync the counterparty to your ledger. Either `customer`
       #   or `vendor`.
-      #
-      # @example
-      # ```ruby
-      # case ledger_type
-      # in :customer
-      #   # ...
-      # in :vendor
-      #   # ...
-      # end
-      # ```
-      class LedgerType < ModernTreasury::Enum
+      module LedgerType
+        extend ModernTreasury::Enum
+
         CUSTOMER = :customer
         VENDOR = :vendor
 
@@ -856,7 +743,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -1092,20 +978,10 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
         # The type of legal entity.
-        #
-        # @example
-        # ```ruby
-        # case legal_entity_type
-        # in :business
-        #   # ...
-        # in :individual
-        #   # ...
-        # end
-        # ```
-        class LegalEntityType < ModernTreasury::Enum
+        module LegalEntityType
+          extend ModernTreasury::Enum
+
           BUSINESS = :business
           INDIVIDUAL = :individual
 
@@ -1113,7 +989,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
@@ -1176,24 +1051,9 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case address_type
-          # in :business
-          #   # ...
-          # in :mailing
-          #   # ...
-          # in :other
-          #   # ...
-          # in :po_box
-          #   # ...
-          # in :residential
-          #   # ...
-          # end
-          # ```
-          class AddressType < ModernTreasury::Enum
+          module AddressType
+            extend ModernTreasury::Enum
+
             BUSINESS = :business
             MAILING = :mailing
             OTHER = :other
@@ -1204,7 +1064,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -1239,28 +1098,10 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-          # @abstract
-          #
           # The type of ID number.
-          #
-          # @example
-          # ```ruby
-          # case id_type
-          # in :ar_cuil
-          #   # ...
-          # in :ar_cuit
-          #   # ...
-          # in :br_cnpj
-          #   # ...
-          # in :br_cpf
-          #   # ...
-          # in :cl_run
-          #   # ...
-          # in ...
-          #   #...
-          # end
-          # ```
-          class IDType < ModernTreasury::Enum
+          module IDType
+            extend ModernTreasury::Enum
+
             AR_CUIL = :ar_cuil
             AR_CUIT = :ar_cuit
             BR_CNPJ = :br_cnpj
@@ -1287,7 +1128,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -1356,20 +1196,10 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-          # @abstract
-          #
           # A list of relationship types for how the child entity relates to parent entity.
-          #
-          # @example
-          # ```ruby
-          # case relationship_type
-          # in :beneficial_owner
-          #   # ...
-          # in :control_person
-          #   # ...
-          # end
-          # ```
-          class RelationshipType < ModernTreasury::Enum
+          module RelationshipType
+            extend ModernTreasury::Enum
+
             BENEFICIAL_OWNER = :beneficial_owner
             CONTROL_PERSON = :control_person
 
@@ -1377,7 +1207,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
 
@@ -1684,24 +1513,9 @@ module ModernTreasury
 
               # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-              # @abstract
-              #
-              # @example
-              # ```ruby
-              # case address_type
-              # in :business
-              #   # ...
-              # in :mailing
-              #   # ...
-              # in :other
-              #   # ...
-              # in :po_box
-              #   # ...
-              # in :residential
-              #   # ...
-              # end
-              # ```
-              class AddressType < ModernTreasury::Enum
+              module AddressType
+                extend ModernTreasury::Enum
+
                 BUSINESS = :business
                 MAILING = :mailing
                 OTHER = :other
@@ -1712,7 +1526,6 @@ module ModernTreasury
 
                 # @!parse
                 #   # @return [Array<Symbol>]
-                #   #
                 #   def self.values; end
               end
             end
@@ -1747,28 +1560,10 @@ module ModernTreasury
 
               # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-              # @abstract
-              #
               # The type of ID number.
-              #
-              # @example
-              # ```ruby
-              # case id_type
-              # in :ar_cuil
-              #   # ...
-              # in :ar_cuit
-              #   # ...
-              # in :br_cnpj
-              #   # ...
-              # in :br_cpf
-              #   # ...
-              # in :cl_run
-              #   # ...
-              # in ...
-              #   #...
-              # end
-              # ```
-              class IDType < ModernTreasury::Enum
+              module IDType
+                extend ModernTreasury::Enum
+
                 AR_CUIL = :ar_cuil
                 AR_CUIT = :ar_cuit
                 BR_CNPJ = :br_cnpj
@@ -1795,25 +1590,14 @@ module ModernTreasury
 
                 # @!parse
                 #   # @return [Array<Symbol>]
-                #   #
                 #   def self.values; end
               end
             end
 
-            # @abstract
-            #
             # The type of legal entity.
-            #
-            # @example
-            # ```ruby
-            # case legal_entity_type
-            # in :business
-            #   # ...
-            # in :individual
-            #   # ...
-            # end
-            # ```
-            class LegalEntityType < ModernTreasury::Enum
+            module LegalEntityType
+              extend ModernTreasury::Enum
+
               BUSINESS = :business
               INDIVIDUAL = :individual
 
@@ -1821,32 +1605,13 @@ module ModernTreasury
 
               # @!parse
               #   # @return [Array<Symbol>]
-              #   #
               #   def self.values; end
             end
 
-            # @abstract
-            #
             # The business's legal structure.
-            #
-            # @example
-            # ```ruby
-            # case legal_structure
-            # in :corporation
-            #   # ...
-            # in :llc
-            #   # ...
-            # in :non_profit
-            #   # ...
-            # in :partnership
-            #   # ...
-            # in :sole_proprietorship
-            #   # ...
-            # in ...
-            #   #...
-            # end
-            # ```
-            class LegalStructure < ModernTreasury::Enum
+            module LegalStructure
+              extend ModernTreasury::Enum
+
               CORPORATION = :corporation
               LLC = :llc
               NON_PROFIT = :non_profit
@@ -1858,7 +1623,6 @@ module ModernTreasury
 
               # @!parse
               #   # @return [Array<Symbol>]
-              #   #
               #   def self.values; end
             end
 
@@ -1882,22 +1646,10 @@ module ModernTreasury
               # def initialize: (Hash | ModernTreasury::BaseModel) -> void
             end
 
-            # @abstract
-            #
             # The risk rating of the legal entity. One of low, medium, high.
-            #
-            # @example
-            # ```ruby
-            # case risk_rating
-            # in :low
-            #   # ...
-            # in :medium
-            #   # ...
-            # in :high
-            #   # ...
-            # end
-            # ```
-            class RiskRating < ModernTreasury::Enum
+            module RiskRating
+              extend ModernTreasury::Enum
+
               LOW = :low
               MEDIUM = :medium
               HIGH = :high
@@ -1906,34 +1658,15 @@ module ModernTreasury
 
               # @!parse
               #   # @return [Array<Symbol>]
-              #   #
               #   def self.values; end
             end
           end
         end
 
-        # @abstract
-        #
         # The business's legal structure.
-        #
-        # @example
-        # ```ruby
-        # case legal_structure
-        # in :corporation
-        #   # ...
-        # in :llc
-        #   # ...
-        # in :non_profit
-        #   # ...
-        # in :partnership
-        #   # ...
-        # in :sole_proprietorship
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class LegalStructure < ModernTreasury::Enum
+        module LegalStructure
+          extend ModernTreasury::Enum
+
           CORPORATION = :corporation
           LLC = :llc
           NON_PROFIT = :non_profit
@@ -1945,7 +1678,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
@@ -1969,22 +1701,10 @@ module ModernTreasury
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
         end
 
-        # @abstract
-        #
         # The risk rating of the legal entity. One of low, medium, high.
-        #
-        # @example
-        # ```ruby
-        # case risk_rating
-        # in :low
-        #   # ...
-        # in :medium
-        #   # ...
-        # in :high
-        #   # ...
-        # end
-        # ```
-        class RiskRating < ModernTreasury::Enum
+        module RiskRating
+          extend ModernTreasury::Enum
+
           LOW = :low
           MEDIUM = :medium
           HIGH = :high
@@ -1993,29 +1713,14 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      # @abstract
-      #
       # The verification status of the counterparty.
-      #
-      # @example
-      # ```ruby
-      # case verification_status
-      # in :denied
-      #   # ...
-      # in :needs_approval
-      #   # ...
-      # in :unverified
-      #   # ...
-      # in :verified
-      #   # ...
-      # end
-      # ```
-      class VerificationStatus < ModernTreasury::Enum
+      module VerificationStatus
+        extend ModernTreasury::Enum
+
         DENIED = :denied
         NEEDS_APPROVAL = :needs_approval
         UNVERIFIED = :unverified
@@ -2025,7 +1730,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end