finch-api 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

data/lib/finch-api/models/directory_event.rb

@@ -48,20 +48,9 @@ module FinchAPI
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case event_type
-      # in :"directory.created"
-      #   # ...
-      # in :"directory.updated"
-      #   # ...
-      # in :"directory.deleted"
-      #   # ...
-      # end
-      # ```
-      class EventType < FinchAPI::Enum
+      module EventType
+        extend FinchAPI::Enum
+
         DIRECTORY_CREATED = :"directory.created"
         DIRECTORY_UPDATED = :"directory.updated"
         DIRECTORY_DELETED = :"directory.deleted"
@@ -70,7 +59,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/finch-api/models/employment_event.rb

@@ -48,20 +48,9 @@ module FinchAPI
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case event_type
-      # in :"employment.created"
-      #   # ...
-      # in :"employment.updated"
-      #   # ...
-      # in :"employment.deleted"
-      #   # ...
-      # end
-      # ```
-      class EventType < FinchAPI::Enum
+      module EventType
+        extend FinchAPI::Enum
+
         EMPLOYMENT_CREATED = :"employment.created"
         EMPLOYMENT_UPDATED = :"employment.updated"
         EMPLOYMENT_DELETED = :"employment.deleted"
@@ -70,7 +59,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/finch-api/models/hris/benefit_contribution.rb

@@ -24,20 +24,10 @@ module FinchAPI
 
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-        # @abstract
-        #
         # Contribution type.
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :fixed
-        #   # ...
-        # in :percent
-        #   # ...
-        # end
-        # ```
-        class Type < FinchAPI::Enum
+        module Type
+          extend FinchAPI::Enum
+
           FIXED = :fixed
           PERCENT = :percent
 
@@ -45,7 +35,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/finch-api/models/hris/benefit_features_and_operations.rb

@@ -124,18 +124,9 @@ module FinchAPI
 
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case company_contribution
-          # in :fixed
-          #   # ...
-          # in :percent
-          #   # ...
-          # end
-          # ```
-          class CompanyContribution < FinchAPI::Enum
+          module CompanyContribution
+            extend FinchAPI::Enum
+
             FIXED = :fixed
             PERCENT = :percent
 
@@ -143,22 +134,12 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case employee_deduction
-          # in :fixed
-          #   # ...
-          # in :percent
-          #   # ...
-          # end
-          # ```
-          class EmployeeDeduction < FinchAPI::Enum
+          module EmployeeDeduction
+            extend FinchAPI::Enum
+
             FIXED = :fixed
             PERCENT = :percent
 
@@ -166,22 +147,12 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case hsa_contribution_limit
-          # in :individual
-          #   # ...
-          # in :family
-          #   # ...
-          # end
-          # ```
-          class HsaContributionLimit < FinchAPI::Enum
+          module HsaContributionLimit
+            extend FinchAPI::Enum
+
             INDIVIDUAL = :individual
             FAMILY = :family
 
@@ -189,7 +160,6 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end

data/lib/finch-api/models/hris/benefit_frequency.rb

@@ -3,20 +3,9 @@
 module FinchAPI
   module Models
     module HRIS
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case benefit_frequency
-      # in :one_time
-      #   # ...
-      # in :every_paycheck
-      #   # ...
-      # in :monthly
-      #   # ...
-      # end
-      # ```
-      class BenefitFrequency < FinchAPI::Enum
+      module BenefitFrequency
+        extend FinchAPI::Enum
+
         ONE_TIME = :one_time
         EVERY_PAYCHECK = :every_paycheck
         MONTHLY = :monthly
@@ -25,7 +14,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/finch-api/models/hris/benefit_type.rb

@@ -3,28 +3,10 @@
 module FinchAPI
   module Models
     module HRIS
-      # @abstract
-      #
       # Type of benefit.
-      #
-      # @example
-      # ```ruby
-      # case benefit_type
-      # in :"401k"
-      #   # ...
-      # in :"401k_roth"
-      #   # ...
-      # in :"401k_loan"
-      #   # ...
-      # in :"403b"
-      #   # ...
-      # in :"403b_roth"
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class BenefitType < FinchAPI::Enum
+      module BenefitType
+        extend FinchAPI::Enum
+
         NUMBER_401K = :"401k"
         NUMBER_401K_ROTH = :"401k_roth"
         NUMBER_401K_LOAN = :"401k_loan"
@@ -49,7 +31,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/finch-api/models/hris/benefits/enrolled_individual.rb

@@ -71,24 +71,10 @@ module FinchAPI
             # def initialize: (Hash | FinchAPI::BaseModel) -> void
           end
 
-          # @abstract
-          #
           # HTTP status code. Either 201 or 200
-          #
-          # @example
-          # ```ruby
-          # case code
-          # in 200
-          #   # ...
-          # in 201
-          #   # ...
-          # in 404
-          #   # ...
-          # in 403
-          #   # ...
-          # end
-          # ```
-          class Code < FinchAPI::Enum
+          module Code
+            extend FinchAPI::Enum
+
             OK = 200
             CREATED = 201
             NOT_FOUND = 404
@@ -98,7 +84,6 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Integer>]
-            #   #
             #   def self.values; end
           end
         end

data/lib/finch-api/models/hris/benefits/individual_benefit.rb

@@ -93,20 +93,10 @@ module FinchAPI
 
             # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-            # @abstract
-            #
             # Type for HSA contribution limit if the benefit is a HSA.
-            #
-            # @example
-            # ```ruby
-            # case hsa_contribution_limit
-            # in :individual
-            #   # ...
-            # in :family
-            #   # ...
-            # end
-            # ```
-            class HsaContributionLimit < FinchAPI::Enum
+            module HsaContributionLimit
+              extend FinchAPI::Enum
+
               INDIVIDUAL = :individual
               FAMILY = :family
 
@@ -114,7 +104,6 @@ module FinchAPI
 
               # @!parse
               #   # @return [Array<Symbol>]
-              #   #
               #   def self.values; end
             end
           end

data/lib/finch-api/models/hris/benefits/individual_enroll_many_params.rb

@@ -126,21 +126,11 @@ module FinchAPI
 
               # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-              # @abstract
-              #
               # For HSA benefits only - whether the contribution limit is for an individual or
               #   family
-              #
-              # @example
-              # ```ruby
-              # case annual_contribution_limit
-              # in :individual
-              #   # ...
-              # in :family
-              #   # ...
-              # end
-              # ```
-              class AnnualContributionLimit < FinchAPI::Enum
+              module AnnualContributionLimit
+                extend FinchAPI::Enum
+
                 INDIVIDUAL = :individual
                 FAMILY = :family
 
@@ -148,7 +138,6 @@ module FinchAPI
 
                 # @!parse
                 #   # @return [Array<Symbol>]
-                #   #
                 #   def self.values; end
               end
 
@@ -182,18 +171,9 @@ module FinchAPI
 
                 # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-                # @abstract
-                #
-                # @example
-                # ```ruby
-                # case type
-                # in :fixed
-                #   # ...
-                # in :percent
-                #   # ...
-                # end
-                # ```
-                class Type < FinchAPI::Enum
+                module Type
+                  extend FinchAPI::Enum
+
                   FIXED = :fixed
                   PERCENT = :percent
 
@@ -201,7 +181,6 @@ module FinchAPI
 
                   # @!parse
                   #   # @return [Array<Symbol>]
-                  #   #
                   #   def self.values; end
                 end
               end
@@ -236,18 +215,9 @@ module FinchAPI
 
                 # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-                # @abstract
-                #
-                # @example
-                # ```ruby
-                # case type
-                # in :fixed
-                #   # ...
-                # in :percent
-                #   # ...
-                # end
-                # ```
-                class Type < FinchAPI::Enum
+                module Type
+                  extend FinchAPI::Enum
+
                   FIXED = :fixed
                   PERCENT = :percent
 
@@ -255,7 +225,6 @@ module FinchAPI
 
                   # @!parse
                   #   # @return [Array<Symbol>]
-                  #   #
                   #   def self.values; end
                 end
               end

data/lib/finch-api/models/hris/company.rb

@@ -130,20 +130,10 @@ module FinchAPI
 
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-          # @abstract
-          #
           # The type of bank account.
-          #
-          # @example
-          # ```ruby
-          # case account_type
-          # in :checking
-          #   # ...
-          # in :savings
-          #   # ...
-          # end
-          # ```
-          class AccountType < FinchAPI::Enum
+          module AccountType
+            extend FinchAPI::Enum
+
             CHECKING = :checking
             SAVINGS = :savings
 
@@ -151,7 +141,6 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -218,22 +207,10 @@ module FinchAPI
 
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-          # @abstract
-          #
           # The tax payer subtype of the company.
-          #
-          # @example
-          # ```ruby
-          # case subtype
-          # in :s_corporation
-          #   # ...
-          # in :c_corporation
-          #   # ...
-          # in :b_corporation
-          #   # ...
-          # end
-          # ```
-          class Subtype < FinchAPI::Enum
+          module Subtype
+            extend FinchAPI::Enum
+
             S_CORPORATION = :s_corporation
             C_CORPORATION = :c_corporation
             B_CORPORATION = :b_corporation
@@ -242,32 +219,13 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
 
-          # @abstract
-          #
           # The tax payer type of the company.
-          #
-          # @example
-          # ```ruby
-          # case type
-          # in :llc
-          #   # ...
-          # in :lp
-          #   # ...
-          # in :corporation
-          #   # ...
-          # in :sole_proprietor
-          #   # ...
-          # in :non_profit
-          #   # ...
-          # in ...
-          #   #...
-          # end
-          # ```
-          class Type < FinchAPI::Enum
+          module Type
+            extend FinchAPI::Enum
+
             LLC = :llc
             LP = :lp
             CORPORATION = :corporation
@@ -280,7 +238,6 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end

data/lib/finch-api/models/hris/document_list_params.rb

@@ -61,18 +61,9 @@ module FinchAPI
 
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :w4_2020
-        #   # ...
-        # in :w4_2005
-        #   # ...
-        # end
-        # ```
-        class Type < FinchAPI::Enum
+        module Type
+          extend FinchAPI::Enum
+
           W4_2020 = :w4_2020
           W4_2005 = :w4_2005
 
@@ -80,7 +71,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/finch-api/models/hris/document_response.rb

@@ -59,20 +59,10 @@ module FinchAPI
 
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-        # @abstract
-        #
         # The type of document.
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :w4_2020
-        #   # ...
-        # in :w4_2005
-        #   # ...
-        # end
-        # ```
-        class Type < FinchAPI::Enum
+        module Type
+          extend FinchAPI::Enum
+
           W4_2020 = :w4_2020
           W4_2005 = :w4_2005
 
@@ -80,7 +70,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/finch-api/models/hris/document_retreive_response.rb

@@ -3,31 +3,11 @@
 module FinchAPI
   module Models
     module HRIS
-      # @abstract
-      #
       # A 2020 version of the W-4 tax form containing information on an individual's
       #   filing status, dependents, and withholding details.
-      #
-      # @example
-      # ```ruby
-      # case document_retreive_response
-      # in {type: "w4_2020", data: FinchAPI::Models::HRIS::W42020::Data, year: Float}
-      #   # FinchAPI::Models::HRIS::W42020 ...
-      # in {type: "w4_2005", data: FinchAPI::Models::HRIS::W42005::Data, year: Float}
-      #   # FinchAPI::Models::HRIS::W42005 ...
-      # end
-      # ```
-      #
-      # @example
-      # ```ruby
-      # case document_retreive_response
-      # in FinchAPI::Models::HRIS::W42020
-      #   # ...
-      # in FinchAPI::Models::HRIS::W42005
-      #   # ...
-      # end
-      # ```
-      class DocumentRetreiveResponse < FinchAPI::Union
+      module DocumentRetreiveResponse
+        extend FinchAPI::Union
+
         discriminator :type
 
         # A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.
@@ -35,6 +15,10 @@ module FinchAPI
 
         # A 2005 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.
         variant :w4_2005, -> { FinchAPI::Models::HRIS::W42005 }
+
+        # @!parse
+        #   # @return [Array(FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005)]
+        #   def self.variants; end
       end
     end
   end