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

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

@@ -251,29 +251,11 @@ module FinchAPI
 
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-          # @abstract
-          #
           # The secondary employment type of the individual. Options: `full_time`,
           #   `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
-          #
-          # @example
-          # ```ruby
-          # case subtype
-          # in :full_time
-          #   # ...
-          # in :intern
-          #   # ...
-          # in :part_time
-          #   # ...
-          # in :temp
-          #   # ...
-          # in :seasonal
-          #   # ...
-          # in ...
-          #   #...
-          # end
-          # ```
-          class Subtype < FinchAPI::Enum
+          module Subtype
+            extend FinchAPI::Enum
+
             FULL_TIME = :full_time
             INTERN = :intern
             PART_TIME = :part_time
@@ -285,24 +267,13 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
 
-          # @abstract
-          #
           # The main employment type of the individual.
-          #
-          # @example
-          # ```ruby
-          # case type
-          # in :employee
-          #   # ...
-          # in :contractor
-          #   # ...
-          # end
-          # ```
-          class Type < FinchAPI::Enum
+          module Type
+            extend FinchAPI::Enum
+
             EMPLOYEE = :employee
             CONTRACTOR = :contractor
 
@@ -310,34 +281,15 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
 
-        # @abstract
-        #
         # The detailed employment status of the individual. Available options: `active`,
         #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
-        #
-        # @example
-        # ```ruby
-        # case employment_status
-        # in :active
-        #   # ...
-        # in :deceased
-        #   # ...
-        # in :leave
-        #   # ...
-        # in :onboarding
-        #   # ...
-        # in :prehire
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class EmploymentStatus < FinchAPI::Enum
+        module EmploymentStatus
+          extend FinchAPI::Enum
+
           ACTIVE = :active
           DECEASED = :deceased
           LEAVE = :leave
@@ -350,7 +302,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 

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

@@ -148,18 +148,9 @@ module FinchAPI
 
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case type
-          # in :work
-          #   # ...
-          # in :personal
-          #   # ...
-          # end
-          # ```
-          class Type < FinchAPI::Enum
+          module Type
+            extend FinchAPI::Enum
+
             WORK = :work
             PERSONAL = :personal
 
@@ -167,33 +158,14 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
 
-        # @abstract
-        #
         # The EEOC-defined ethnicity of the individual.
-        #
-        # @example
-        # ```ruby
-        # case ethnicity
-        # in :asian
-        #   # ...
-        # in :white
-        #   # ...
-        # in :black_or_african_american
-        #   # ...
-        # in :native_hawaiian_or_pacific_islander
-        #   # ...
-        # in :american_indian_or_alaska_native
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class Ethnicity < FinchAPI::Enum
+        module Ethnicity
+          extend FinchAPI::Enum
+
           ASIAN = :asian
           WHITE = :white
           BLACK_OR_AFRICAN_AMERICAN = :black_or_african_american
@@ -207,28 +179,13 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
         # The gender of the individual.
-        #
-        # @example
-        # ```ruby
-        # case gender
-        # in :female
-        #   # ...
-        # in :male
-        #   # ...
-        # in :other
-        #   # ...
-        # in :decline_to_specify
-        #   # ...
-        # end
-        # ```
-        class Gender < FinchAPI::Enum
+        module Gender
+          extend FinchAPI::Enum
+
           FEMALE = :female
           MALE = :male
           OTHER = :other
@@ -238,7 +195,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
@@ -261,18 +217,9 @@ module FinchAPI
 
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case type
-          # in :work
-          #   # ...
-          # in :personal
-          #   # ...
-          # end
-          # ```
-          class Type < FinchAPI::Enum
+          module Type
+            extend FinchAPI::Enum
+
             WORK = :work
             PERSONAL = :personal
 
@@ -280,7 +227,6 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end

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

@@ -191,28 +191,10 @@ module FinchAPI
             end
           end
 
-          # @abstract
-          #
           # The type of earning.
-          #
-          # @example
-          # ```ruby
-          # case type
-          # in :salary
-          #   # ...
-          # in :wage
-          #   # ...
-          # in :reimbursement
-          #   # ...
-          # in :overtime
-          #   # ...
-          # in :severance
-          #   # ...
-          # in ...
-          #   #...
-          # end
-          # ```
-          class Type < FinchAPI::Enum
+          module Type
+            extend FinchAPI::Enum
+
             SALARY = :salary
             WAGE = :wage
             REIMBURSEMENT = :reimbursement
@@ -231,7 +213,6 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -410,20 +391,10 @@ module FinchAPI
           end
         end
 
-        # @abstract
-        #
         # The payment method.
-        #
-        # @example
-        # ```ruby
-        # case payment_method
-        # in :check
-        #   # ...
-        # in :direct_deposit
-        #   # ...
-        # end
-        # ```
-        class PaymentMethod < FinchAPI::Enum
+        module PaymentMethod
+          extend FinchAPI::Enum
+
           CHECK = :check
           DIRECT_DEPOSIT = :direct_deposit
 
@@ -431,7 +402,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
@@ -522,24 +492,10 @@ module FinchAPI
             end
           end
 
-          # @abstract
-          #
           # The type of taxes.
-          #
-          # @example
-          # ```ruby
-          # case type
-          # in :state
-          #   # ...
-          # in :federal
-          #   # ...
-          # in :local
-          #   # ...
-          # in :fica
-          #   # ...
-          # end
-          # ```
-          class Type < FinchAPI::Enum
+          module Type
+            extend FinchAPI::Enum
+
             STATE = :state
             FEDERAL = :federal
             LOCAL = :local
@@ -549,27 +505,14 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
 
-        # @abstract
-        #
         # The type of the payment associated with the pay statement.
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :regular_payroll
-        #   # ...
-        # in :off_cycle_payroll
-        #   # ...
-        # in :one_time_payment
-        #   # ...
-        # end
-        # ```
-        class Type < FinchAPI::Enum
+        module Type
+          extend FinchAPI::Enum
+
           REGULAR_PAYROLL = :regular_payroll
           OFF_CYCLE_PAYROLL = :off_cycle_payroll
           ONE_TIME_PAYMENT = :one_time_payment
@@ -578,7 +521,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

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

@@ -109,26 +109,9 @@ module FinchAPI
 
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case pay_frequency
-        # in :annually
-        #   # ...
-        # in :semi_annually
-        #   # ...
-        # in :quarterly
-        #   # ...
-        # in :monthly
-        #   # ...
-        # in :semi_monthly
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class PayFrequency < FinchAPI::Enum
+        module PayFrequency
+          extend FinchAPI::Enum
+
           ANNUALLY = :annually
           SEMI_ANNUALLY = :semi_annually
           QUARTERLY = :quarterly
@@ -143,7 +126,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 

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

@@ -92,18 +92,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
 
@@ -111,22 +102,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
 
@@ -134,22 +115,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
 
@@ -157,7 +128,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

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

@@ -59,15 +59,11 @@ module FinchAPI
           #   # @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption]
           #   attr_writer :exemption
 
-          # @!attribute [r] filing_status
+          # @!attribute filing_status
           #   The individual's filing status for tax purposes.
           #
           #   @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus, nil]
-          optional :filing_status, enum: -> { FinchAPI::Models::HRIS::W42005::Data::FilingStatus }
-
-          # @!parse
-          #   # @return [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus]
-          #   attr_writer :filing_status
+          optional :filing_status, enum: -> { FinchAPI::Models::HRIS::W42005::Data::FilingStatus }, nil?: true
 
           # @!attribute [r] individual_id
           #   The unique identifier for the individual associated with this 2005 W4 form.
@@ -90,7 +86,7 @@ module FinchAPI
           #   #
           #   # @param additional_withholding [Integer, nil]
           #   # @param exemption [Symbol, FinchAPI::Models::HRIS::W42005::Data::Exemption]
-          #   # @param filing_status [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus]
+          #   # @param filing_status [Symbol, FinchAPI::Models::HRIS::W42005::Data::FilingStatus, nil]
           #   # @param individual_id [String]
           #   # @param total_number_of_allowances [Integer, nil]
           #   #
@@ -107,20 +103,10 @@ module FinchAPI
 
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-          # @abstract
-          #
           # Indicates exemption status from federal tax withholding.
-          #
-          # @example
-          # ```ruby
-          # case exemption
-          # in :exempt
-          #   # ...
-          # in :non_exempt
-          #   # ...
-          # end
-          # ```
-          class Exemption < FinchAPI::Enum
+          module Exemption
+            extend FinchAPI::Enum
+
             EXEMPT = :exempt
             NON_EXEMPT = :non_exempt
 
@@ -128,26 +114,13 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
 
-          # @abstract
-          #
           # The individual's filing status for tax purposes.
-          #
-          # @example
-          # ```ruby
-          # case filing_status
-          # in :married
-          #   # ...
-          # in :married_but_withhold_at_higher_single_rate
-          #   # ...
-          # in :single
-          #   # ...
-          # end
-          # ```
-          class FilingStatus < FinchAPI::Enum
+          module FilingStatus
+            extend FinchAPI::Enum
+
             MARRIED = :married
             MARRIED_BUT_WITHHOLD_AT_HIGHER_SINGLE_RATE = :married_but_withhold_at_higher_single_rate
             SINGLE = :single
@@ -156,30 +129,20 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
 
-        # @abstract
-        #
         # Specifies the form type, indicating that this document is a 2005 W4 form.
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :w4_2005
-        #   # ...
-        # end
-        # ```
-        class Type < FinchAPI::Enum
+        module Type
+          extend FinchAPI::Enum
+
           W4_2005 = :w4_2005
 
           finalize!
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

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

@@ -124,54 +124,33 @@ module FinchAPI
 
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-          # @abstract
-          #
           # The individual's filing status for tax purposes.
-          #
-          # @example
-          # ```ruby
-          # case filing_status
-          # in :head_of_household
-          #   # ...
-          # in :married_filing_jointly_or_qualifying_surviving_spouse
-          #   # ...
-          # in :single_or_married_filing_separately
-          #   # ...
-          # end
-          # ```
-          class FilingStatus < FinchAPI::Enum
+          module FilingStatus
+            extend FinchAPI::Enum
+
             HEAD_OF_HOUSEHOLD = :head_of_household
-            MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE = :married_filing_jointly_or_qualifying_surviving_spouse
+            MARRIED_FILING_JOINTLY_OR_QUALIFYING_SURVIVING_SPOUSE =
+              :married_filing_jointly_or_qualifying_surviving_spouse
             SINGLE_OR_MARRIED_FILING_SEPARATELY = :single_or_married_filing_separately
 
             finalize!
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
 
-        # @abstract
-        #
         # Specifies the form type, indicating that this document is a 2020 W4 form.
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :w4_2020
-        #   # ...
-        # end
-        # ```
-        class Type < FinchAPI::Enum
+        module Type
+          extend FinchAPI::Enum
+
           W4_2020 = :w4_2020
 
           finalize!
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

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

@@ -42,29 +42,11 @@ module FinchAPI
 
       # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-      # @abstract
-      #
       # The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
       #   `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
-      #
-      # @example
-      # ```ruby
-      # case unit
-      # in :yearly
-      #   # ...
-      # in :quarterly
-      #   # ...
-      # in :monthly
-      #   # ...
-      # in :semi_monthly
-      #   # ...
-      # in :bi_weekly
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Unit < FinchAPI::Enum
+      module Unit
+        extend FinchAPI::Enum
+
         YEARLY = :yearly
         QUARTERLY = :quarterly
         MONTHLY = :monthly
@@ -79,7 +61,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end