gusto_embedded_client 0.2.9 → 0.3.0

data/lib/gusto_embedded/models/shared/employee_benefit_create_request.rb

@@ -0,0 +1,105 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Models
+    module Shared
+
+      class EmployeeBenefitCreateRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The UUID of the company benefit.
+        field :company_benefit_uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_benefit_uuid'), required: true } }
+        # An object representing the company contribution type and value.
+        field :contribution, Crystalline::Nilable.new(Models::Shared::EmployeeBenefitCreateRequestContribution), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contribution') } }
+        # Whether the employee benefit is active.
+        field :active, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
+        # The amount to be deducted, per pay period, from the employee's pay.
+        field :employee_deduction, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction') } }
+        # Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.
+        field :deduct_as_percentage, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduct_as_percentage') } }
+        # The maximum employee deduction amount per year. A null value signifies no limit.
+        field :employee_deduction_annual_maximum, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction_annual_maximum') } }
+        # Whether the company contribution is elective (aka "matching"). For `tiered`, `elective_amount`, and `elective_percentage` contribution types this is ignored and assumed to be `true`.
+        field :elective, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('elective') } }
+        # The maximum company contribution amount per year. A null value signifies no limit.
+        field :company_contribution_annual_maximum, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution_annual_maximum') } }
+        # Some benefits require additional information to determine
+        # their limit.
+        #
+        # `Family` or `Individual`: Applicable to HSA benefit.
+        #
+        # `Joint Filing or Single` or `Married and Filing Separately`: Applicable to Dependent Care FSA benefit.
+        field :limit_option, Crystalline::Nilable.new(Models::Shared::EmployeeBenefitCreateRequestLimitOption), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('limit_option'), 'decoder': ::GustoEmbedded::Utils.enum_from_string(Models::Shared::EmployeeBenefitCreateRequestLimitOption, true) } }
+        # Whether the employee should use a benefit's "catch up" rate. Only Roth 401k and 401k benefits use this value for employees over 50.
+        field :catch_up, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('catch_up') } }
+        # The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.
+        field :coverage_amount, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('coverage_amount') } }
+        # The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set.
+        field :coverage_salary_multiplier, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('coverage_salary_multiplier') } }
+        # Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not "unset", coverage amount and coverage salary multiplier are ignored.
+        field :deduction_reduces_taxable_income, Crystalline::Nilable.new(Models::Shared::EmployeeBenefitCreateRequestDeductionReducesTaxableIncome), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduction_reduces_taxable_income'), 'decoder': ::GustoEmbedded::Utils.enum_from_string(Models::Shared::EmployeeBenefitCreateRequestDeductionReducesTaxableIncome, true) } }
+        # The amount to be paid, per pay period, by the company.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
+        field :company_contribution, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution') } }
+        # Whether the company contribution amount should be treated as a percentage to be deducted from each payroll.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
+        field :contribute_as_percentage, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contribute_as_percentage') } }
+        # The date the employee benefit will start. If not provided, the benefit will be effective from 1970-01-01 (unix epoch).
+        field :effective_date, Crystalline::Nilable.new(::Date), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('effective_date'), 'decoder': ::GustoEmbedded::Utils.date_from_iso_format(true) } }
+        # The date the employee benefit will expire. A null value indicates the benefit will not expire.
+        field :expiration_date, Crystalline::Nilable.new(::Date), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('expiration_date'), 'decoder': ::GustoEmbedded::Utils.date_from_iso_format(true) } }
+
+        sig { params(company_benefit_uuid: ::String, contribution: T.nilable(Models::Shared::EmployeeBenefitCreateRequestContribution), active: T.nilable(T::Boolean), employee_deduction: T.nilable(::String), deduct_as_percentage: T.nilable(T::Boolean), employee_deduction_annual_maximum: T.nilable(::String), elective: T.nilable(T::Boolean), company_contribution_annual_maximum: T.nilable(::String), limit_option: T.nilable(Models::Shared::EmployeeBenefitCreateRequestLimitOption), catch_up: T.nilable(T::Boolean), coverage_amount: T.nilable(::String), coverage_salary_multiplier: T.nilable(::String), deduction_reduces_taxable_income: T.nilable(Models::Shared::EmployeeBenefitCreateRequestDeductionReducesTaxableIncome), company_contribution: T.nilable(::String), contribute_as_percentage: T.nilable(T::Boolean), effective_date: T.nilable(::Date), expiration_date: T.nilable(::Date)).void }
+        def initialize(company_benefit_uuid:, contribution: nil, active: true, employee_deduction: '0.00', deduct_as_percentage: false, employee_deduction_annual_maximum: nil, elective: false, company_contribution_annual_maximum: nil, limit_option: nil, catch_up: false, coverage_amount: nil, coverage_salary_multiplier: '0.00', deduction_reduces_taxable_income: nil, company_contribution: '0.00', contribute_as_percentage: false, effective_date: Date.parse('1970-01-01'), expiration_date: nil)
+          @company_benefit_uuid = company_benefit_uuid
+          @contribution = contribution
+          @active = active
+          @employee_deduction = employee_deduction
+          @deduct_as_percentage = deduct_as_percentage
+          @employee_deduction_annual_maximum = employee_deduction_annual_maximum
+          @elective = elective
+          @company_contribution_annual_maximum = company_contribution_annual_maximum
+          @limit_option = limit_option
+          @catch_up = catch_up
+          @coverage_amount = coverage_amount
+          @coverage_salary_multiplier = coverage_salary_multiplier
+          @deduction_reduces_taxable_income = deduction_reduces_taxable_income
+          @company_contribution = company_contribution
+          @contribute_as_percentage = contribute_as_percentage
+          @effective_date = effective_date
+          @expiration_date = expiration_date
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @company_benefit_uuid == other.company_benefit_uuid
+          return false unless @contribution == other.contribution
+          return false unless @active == other.active
+          return false unless @employee_deduction == other.employee_deduction
+          return false unless @deduct_as_percentage == other.deduct_as_percentage
+          return false unless @employee_deduction_annual_maximum == other.employee_deduction_annual_maximum
+          return false unless @elective == other.elective
+          return false unless @company_contribution_annual_maximum == other.company_contribution_annual_maximum
+          return false unless @limit_option == other.limit_option
+          return false unless @catch_up == other.catch_up
+          return false unless @coverage_amount == other.coverage_amount
+          return false unless @coverage_salary_multiplier == other.coverage_salary_multiplier
+          return false unless @deduction_reduces_taxable_income == other.deduction_reduces_taxable_income
+          return false unless @company_contribution == other.company_contribution
+          return false unless @contribute_as_percentage == other.contribute_as_percentage
+          return false unless @effective_date == other.effective_date
+          return false unless @expiration_date == other.expiration_date
+          true
+        end
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request.rbi

@@ -0,0 +1,45 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequest
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequest
+  def company_benefit_uuid(); end
+  def company_benefit_uuid=(str_); end
+  def contribution(); end
+  def contribution=(str_); end
+  def active(); end
+  def active=(str_); end
+  def employee_deduction(); end
+  def employee_deduction=(str_); end
+  def deduct_as_percentage(); end
+  def deduct_as_percentage=(str_); end
+  def employee_deduction_annual_maximum(); end
+  def employee_deduction_annual_maximum=(str_); end
+  def elective(); end
+  def elective=(str_); end
+  def company_contribution_annual_maximum(); end
+  def company_contribution_annual_maximum=(str_); end
+  def limit_option(); end
+  def limit_option=(str_); end
+  def catch_up(); end
+  def catch_up=(str_); end
+  def coverage_amount(); end
+  def coverage_amount=(str_); end
+  def coverage_salary_multiplier(); end
+  def coverage_salary_multiplier=(str_); end
+  def deduction_reduces_taxable_income(); end
+  def deduction_reduces_taxable_income=(str_); end
+  def company_contribution(); end
+  def company_contribution=(str_); end
+  def contribute_as_percentage(); end
+  def contribute_as_percentage=(str_); end
+  def effective_date(); end
+  def effective_date=(str_); end
+  def expiration_date(); end
+  def expiration_date=(str_); end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_contribution.rb

@@ -0,0 +1,44 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Models
+    module Shared
+      # An object representing the company contribution type and value.
+      class EmployeeBenefitCreateRequestContribution
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The company contribution scheme.
+        #
+        # `amount`: The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+        #
+        # `percentage`: The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+        #
+        # `tiered`: The size of the company contribution corresponds to the size of the employee deduction relative to a tiered matching scheme.
+        field :type, Crystalline::Nilable.new(Models::Shared::EmployeeBenefitCreateRequestType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type'), 'decoder': ::GustoEmbedded::Utils.enum_from_string(Models::Shared::EmployeeBenefitCreateRequestType, true) } }
+        # For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage.
+        #
+        # For the `tiered` contribution type, an array of tiers.
+        field :value, Crystalline::Nilable.new(Crystalline::Union.new(::String, Crystalline::Array.new(Models::Shared::EmployeeBenefitCreateRequestValue2))), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+        sig { params(type: T.nilable(Models::Shared::EmployeeBenefitCreateRequestType), value: T.nilable(T.any(::String, T::Array[Models::Shared::EmployeeBenefitCreateRequestValue2]))).void }
+        def initialize(type: nil, value: nil)
+          @type = type
+          @value = value
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @type == other.type
+          return false unless @value == other.value
+          true
+        end
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_contribution.rbi

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestContribution
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestContribution
+  def type(); end
+  def type=(str_); end
+  def value(); end
+  def value=(str_); end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_deduction_reduces_taxable_income.rb

@@ -0,0 +1,20 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Models
+    module Shared
+      # EmployeeBenefitCreateRequestDeductionReducesTaxableIncome - Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not "unset", coverage amount and coverage salary multiplier are ignored.
+      class EmployeeBenefitCreateRequestDeductionReducesTaxableIncome < T::Enum
+        enums do
+          UNSET = new('unset')
+          REDUCES_TAXABLE_INCOME = new('reduces_taxable_income')
+          DOES_NOT_REDUCE_TAXABLE_INCOME = new('does_not_reduce_taxable_income')
+        end
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_deduction_reduces_taxable_income.rbi

@@ -0,0 +1,11 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestDeductionReducesTaxableIncome
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestDeductionReducesTaxableIncome
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_limit_option.rb

@@ -0,0 +1,26 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Models
+    module Shared
+      # EmployeeBenefitCreateRequestLimitOption - Some benefits require additional information to determine
+      # their limit.
+      #
+      # `Family` or `Individual`: Applicable to HSA benefit.
+      #
+      # `Joint Filing or Single` or `Married and Filing Separately`: Applicable to Dependent Care FSA benefit.
+      class EmployeeBenefitCreateRequestLimitOption < T::Enum
+        enums do
+          FAMILY = new('Family')
+          INDIVIDUAL = new('Individual')
+          JOINT_FILING_OR_SINGLE = new('Joint Filing or Single')
+          MARRIED_AND_FILING_SEPARATELY = new('Married and Filing Separately')
+        end
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_limit_option.rbi

@@ -0,0 +1,11 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestLimitOption
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestLimitOption
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_type.rb

@@ -0,0 +1,26 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Models
+    module Shared
+      # EmployeeBenefitCreateRequestType - The company contribution scheme.
+      #
+      # `amount`: The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+      #
+      # `percentage`: The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+      #
+      # `tiered`: The size of the company contribution corresponds to the size of the employee deduction relative to a tiered matching scheme.
+      class EmployeeBenefitCreateRequestType < T::Enum
+        enums do
+          TIERED = new('tiered')
+          PERCENTAGE = new('percentage')
+          AMOUNT = new('amount')
+        end
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_type.rbi

@@ -0,0 +1,11 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestType
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestType
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_value.rb

@@ -0,0 +1,29 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Models
+    module Shared
+      # For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage.
+      #
+      # For the `tiered` contribution type, an array of tiers.
+      class EmployeeBenefitCreateRequestValue
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+
+        
+        def initialize; end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          true
+        end
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_value.rbi

@@ -0,0 +1,11 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestValue
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestValue
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_value_2.rb

@@ -0,0 +1,44 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Models
+    module Shared
+      # A single tier of a tiered matching scheme.
+      class EmployeeBenefitCreateRequestValue2
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The percentage of employee deduction within this tier the company contribution will match.
+        field :rate, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('rate') } }
+        # Specifies the upper limit (inclusive) percentage of the employee contribution that this tier applies to.
+        #
+        # Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.
+        #
+        # For example:
+        #
+        # If the first tier has a threshold of "3", and rate of "100", the company will match 100% of employee contributions from 0% up to and including 3% of payroll.
+        #
+        # If the next tier has a threshold of "5" and a rate of "50", the company will match 50% of contributions from above 3% up to and including 5% of payroll.
+        field :threshold, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('threshold') } }
+
+        sig { params(rate: T.nilable(::String), threshold: T.nilable(::String)).void }
+        def initialize(rate: nil, threshold: nil)
+          @rate = rate
+          @threshold = threshold
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @rate == other.rate
+          return false unless @threshold == other.threshold
+          true
+        end
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_create_request_value_2.rbi

@@ -0,0 +1,15 @@
+# typed: true
+# frozen_string_literal: true
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestValue2
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+
+class GustoEmbedded::Models::Shared::EmployeeBenefitCreateRequestValue2
+  def rate(); end
+  def rate=(str_); end
+  def threshold(); end
+  def threshold=(str_); end
+end

data/lib/gusto_embedded/models/shared/employee_benefit_for_company_benefit.rb

@@ -5,75 +5,119 @@
 
 
 module GustoEmbedded
-  module Shared
-  
-    # The representation of an employee benefit for a company benefit.
-    class EmployeeBenefitForCompanyBenefit < ::Crystalline::FieldAugmented
-      extend T::Sig
+  module Models
+    module Shared
+      # The representation of an employee benefit for a company benefit.
+      class EmployeeBenefitForCompanyBenefit
+        extend T::Sig
+        include Crystalline::MetadataFields
 
-      # The UUID of the employee to which the benefit belongs.
-      field :employee_uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_uuid') } }
-      # Whether the employee benefit is active.
-      field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
-      # Whether the employee should use a benefit’s "catch up" rate. Only Roth 401k and 401k benefits use this value for employees over 50.
-      field :catch_up, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('catch_up') } }
-      # The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types.
-      # 
-      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
-      field :company_contribution, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution') } }
-      # The maximum company contribution amount per year. A null value signifies no limit.
-      field :company_contribution_annual_maximum, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution_annual_maximum') } }
-      # Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types.
-      # 
-      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
-      field :contribute_as_percentage, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contribute_as_percentage') } }
-      # An object representing the type and value of the company contribution.
-      field :contribution, T.nilable(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitContribution), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contribution') } }
-      # The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.
-      field :coverage_amount, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('coverage_amount') } }
-      # The coverage amount as a multiple of the employee’s salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set.
-      field :coverage_salary_multiplier, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('coverage_salary_multiplier') } }
-      # Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.
-      field :deduct_as_percentage, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduct_as_percentage') } }
-      # Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not "unset", coverage amount and coverage salary multiplier are ignored.
-      field :deduction_reduces_taxable_income, T.nilable(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduction_reduces_taxable_income'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome, true) } }
-      # Whether the company contribution is elective (aka matching). For "tiered" contribution types, this is always true.
-      field :elective, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('elective') } }
-      # The amount to be deducted, per pay period, from the employee's pay.
-      field :employee_deduction, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction') } }
-      # The maximum employee deduction amount per year. A null value signifies no limit.
-      field :employee_deduction_annual_maximum, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction_annual_maximum') } }
-      # Some benefits require additional information to determine their limit.
-      # 
-      # `Family` and `Individual` are applicable to HSA benefit.
-      # 
-      # `Joint Filing or Single` and `Married and Filing Separately` are applicable to Dependent Care FSA benefit.
-      field :limit_option, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('limit_option') } }
-      # Identifier for a 401(k) loan assigned by the 401(k) provider
-      field :retirement_loan_identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('retirement_loan_identifier') } }
-      # The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field.
-      field :version, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('version') } }
+        # The UUID of the employee to which the benefit belongs.
+        field :employee_uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_uuid'), required: true } }
+        # The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field.
+        field :version, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('version') } }
+        # An object representing the type and value of the company contribution.
+        field :contribution, Crystalline::Nilable.new(Models::Shared::EmployeeBenefitForCompanyBenefitContribution), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contribution') } }
+        # The date the employee benefit will start.
+        field :effective_date, Crystalline::Nilable.new(::Date), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('effective_date'), 'decoder': ::GustoEmbedded::Utils.date_from_iso_format(true) } }
+        # The UUID of the employee benefit. Required for updating an effective dated employee benefit.
+        field :uuid, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+        # The action to perform on the employee benefit. Required for creating/updating an effective dated employee benefit.
+        field :action, Crystalline::Nilable.new(Models::Shared::Action), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('action'), 'decoder': ::GustoEmbedded::Utils.enum_from_string(Models::Shared::Action, true) } }
 
+        field :additional_properties, Crystalline::Nilable.new(Crystalline::Hash.new(Symbol, ::Object)), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('additional_properties'), 'additional_properties': true } }
+        # Whether the employee benefit is active.
+        field :active, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
+        # The amount to be deducted, per pay period, from the employee's pay.
+        field :employee_deduction, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction') } }
+        # Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.
+        field :deduct_as_percentage, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduct_as_percentage') } }
+        # The maximum employee deduction amount per year. A null value signifies no limit.
+        field :employee_deduction_annual_maximum, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction_annual_maximum') } }
+        # Whether the company contribution is elective (aka matching). For "tiered" contribution types, this is always true.
+        field :elective, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('elective') } }
+        # The maximum company contribution amount per year. A null value signifies no limit.
+        field :company_contribution_annual_maximum, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution_annual_maximum') } }
+        # Some benefits require additional information to determine their limit.
+        #
+        # `Family` and `Individual` are applicable to HSA benefit.
+        #
+        # `Joint Filing or Single` and `Married and Filing Separately` are applicable to Dependent Care FSA benefit.
+        field :limit_option, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('limit_option') } }
+        # Identifier for a 401(k) loan assigned by the 401(k) provider
+        field :retirement_loan_identifier, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('retirement_loan_identifier') } }
+        # The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.
+        field :coverage_amount, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('coverage_amount') } }
+        # The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
+        field :company_contribution, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution') } }
+        # Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types.
+        #
+        # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
+        field :contribute_as_percentage, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contribute_as_percentage') } }
+        # The date the employee benefit will expire. A null value indicates the benefit will not expire.
+        field :expiration_date, Crystalline::Nilable.new(::Date), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('expiration_date'), 'decoder': ::GustoEmbedded::Utils.date_from_iso_format(true) } }
+        # Whether the employee should use a benefit's "catch up" rate. Only Roth 401k and 401k benefits use this value for employees over 50.
+        field :catch_up, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('catch_up') } }
+        # Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not "unset", coverage amount and coverage salary multiplier are ignored.
+        field :deduction_reduces_taxable_income, Crystalline::Nilable.new(Models::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduction_reduces_taxable_income'), 'decoder': ::GustoEmbedded::Utils.enum_from_string(Models::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome, true) } }
+        # The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set.
+        field :coverage_salary_multiplier, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('coverage_salary_multiplier') } }
 
-      sig { params(employee_uuid: ::String, active: T.nilable(T::Boolean), catch_up: T.nilable(T::Boolean), company_contribution: T.nilable(::String), company_contribution_annual_maximum: T.nilable(::String), contribute_as_percentage: T.nilable(T::Boolean), contribution: T.nilable(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitContribution), coverage_amount: T.nilable(::String), coverage_salary_multiplier: T.nilable(::String), deduct_as_percentage: T.nilable(T::Boolean), deduction_reduces_taxable_income: T.nilable(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome), elective: T.nilable(T::Boolean), employee_deduction: T.nilable(::String), employee_deduction_annual_maximum: T.nilable(::String), limit_option: T.nilable(::String), retirement_loan_identifier: T.nilable(::String), version: T.nilable(::String)).void }
-      def initialize(employee_uuid: nil, active: nil, catch_up: nil, company_contribution: nil, company_contribution_annual_maximum: nil, contribute_as_percentage: nil, contribution: nil, coverage_amount: nil, coverage_salary_multiplier: nil, deduct_as_percentage: nil, deduction_reduces_taxable_income: nil, elective: nil, employee_deduction: nil, employee_deduction_annual_maximum: nil, limit_option: nil, retirement_loan_identifier: nil, version: nil)
-        @employee_uuid = employee_uuid
-        @active = active
-        @catch_up = catch_up
-        @company_contribution = company_contribution
-        @company_contribution_annual_maximum = company_contribution_annual_maximum
-        @contribute_as_percentage = contribute_as_percentage
-        @contribution = contribution
-        @coverage_amount = coverage_amount
-        @coverage_salary_multiplier = coverage_salary_multiplier
-        @deduct_as_percentage = deduct_as_percentage
-        @deduction_reduces_taxable_income = deduction_reduces_taxable_income
-        @elective = elective
-        @employee_deduction = employee_deduction
-        @employee_deduction_annual_maximum = employee_deduction_annual_maximum
-        @limit_option = limit_option
-        @retirement_loan_identifier = retirement_loan_identifier
-        @version = version
+        sig { params(employee_uuid: ::String, version: T.nilable(::String), contribution: T.nilable(Models::Shared::EmployeeBenefitForCompanyBenefitContribution), effective_date: T.nilable(::Date), uuid: T.nilable(::String), action: T.nilable(Models::Shared::Action), additional_properties: T.nilable(T::Hash[Symbol, ::Object]), active: T.nilable(T::Boolean), employee_deduction: T.nilable(::String), deduct_as_percentage: T.nilable(T::Boolean), employee_deduction_annual_maximum: T.nilable(::String), elective: T.nilable(T::Boolean), company_contribution_annual_maximum: T.nilable(::String), limit_option: T.nilable(::String), retirement_loan_identifier: T.nilable(::String), coverage_amount: T.nilable(::String), company_contribution: T.nilable(::String), contribute_as_percentage: T.nilable(T::Boolean), expiration_date: T.nilable(::Date), catch_up: T.nilable(T::Boolean), deduction_reduces_taxable_income: T.nilable(Models::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome), coverage_salary_multiplier: T.nilable(::String)).void }
+        def initialize(employee_uuid:, version: nil, contribution: nil, effective_date: nil, uuid: nil, action: nil, additional_properties: nil, active: true, employee_deduction: '0.00', deduct_as_percentage: false, employee_deduction_annual_maximum: nil, elective: false, company_contribution_annual_maximum: nil, limit_option: nil, retirement_loan_identifier: nil, coverage_amount: nil, company_contribution: '0.00', contribute_as_percentage: false, expiration_date: nil, catch_up: false, deduction_reduces_taxable_income: Models::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome::UNSET, coverage_salary_multiplier: '0.00')
+          @employee_uuid = employee_uuid
+          @version = version
+          @contribution = contribution
+          @effective_date = effective_date
+          @uuid = uuid
+          @action = action
+          @additional_properties = additional_properties
+          @active = active
+          @employee_deduction = employee_deduction
+          @deduct_as_percentage = deduct_as_percentage
+          @employee_deduction_annual_maximum = employee_deduction_annual_maximum
+          @elective = elective
+          @company_contribution_annual_maximum = company_contribution_annual_maximum
+          @limit_option = limit_option
+          @retirement_loan_identifier = retirement_loan_identifier
+          @coverage_amount = coverage_amount
+          @company_contribution = company_contribution
+          @contribute_as_percentage = contribute_as_percentage
+          @expiration_date = expiration_date
+          @catch_up = catch_up
+          @deduction_reduces_taxable_income = deduction_reduces_taxable_income
+          @coverage_salary_multiplier = coverage_salary_multiplier
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a? self.class
+          return false unless @employee_uuid == other.employee_uuid
+          return false unless @version == other.version
+          return false unless @contribution == other.contribution
+          return false unless @effective_date == other.effective_date
+          return false unless @uuid == other.uuid
+          return false unless @action == other.action
+          return false unless @additional_properties == other.additional_properties
+          return false unless @active == other.active
+          return false unless @employee_deduction == other.employee_deduction
+          return false unless @deduct_as_percentage == other.deduct_as_percentage
+          return false unless @employee_deduction_annual_maximum == other.employee_deduction_annual_maximum
+          return false unless @elective == other.elective
+          return false unless @company_contribution_annual_maximum == other.company_contribution_annual_maximum
+          return false unless @limit_option == other.limit_option
+          return false unless @retirement_loan_identifier == other.retirement_loan_identifier
+          return false unless @coverage_amount == other.coverage_amount
+          return false unless @company_contribution == other.company_contribution
+          return false unless @contribute_as_percentage == other.contribute_as_percentage
+          return false unless @expiration_date == other.expiration_date
+          return false unless @catch_up == other.catch_up
+          return false unless @deduction_reduces_taxable_income == other.deduction_reduces_taxable_income
+          return false unless @coverage_salary_multiplier == other.coverage_salary_multiplier
+          true
+        end
       end
     end
   end