fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/payroll/types/payroll_update_request_employee_compensations_item_paid_time_off_item.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module Payroll
+    class PayrollUpdateRequestEmployeeCompensationsItemPaidTimeOffItem
+    # @return [String] The name of the PTO. This also serves as the unique, immutable identifier for
+#  the PTO. Must pass in name or policy_uuid but not both.
+      attr_reader :name
+    # @return [String] The hours of this PTO taken during the pay period.
+      attr_reader :hours
+    # @return [String] The uuid of the PTO policy. Must pass in name or policy_uuid but not both.
+      attr_reader :policy_uuid
+    # @return [String] The outstanding hours paid upon termination. This field is only applicable for
+#  termination payrolls.
+      attr_reader :final_payout_unused_hours_input
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param name [String] The name of the PTO. This also serves as the unique, immutable identifier for
+#  the PTO. Must pass in name or policy_uuid but not both.
+      # @param hours [String] The hours of this PTO taken during the pay period.
+      # @param policy_uuid [String] The uuid of the PTO policy. Must pass in name or policy_uuid but not both.
+      # @param final_payout_unused_hours_input [String] The outstanding hours paid upon termination. This field is only applicable for
+#  termination payrolls.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Payroll::PayrollUpdateRequestEmployeeCompensationsItemPaidTimeOffItem]
+      def initialize(name: OMIT, hours: OMIT, policy_uuid: OMIT, final_payout_unused_hours_input: OMIT, additional_properties: nil)
+        @name = name if name != OMIT
+        @hours = hours if hours != OMIT
+        @policy_uuid = policy_uuid if policy_uuid != OMIT
+        @final_payout_unused_hours_input = final_payout_unused_hours_input if final_payout_unused_hours_input != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "name": name, "hours": hours, "policy_uuid": policy_uuid, "final_payout_unused_hours_input": final_payout_unused_hours_input }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of
+#  PayrollUpdateRequestEmployeeCompensationsItemPaidTimeOffItem
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Payroll::PayrollUpdateRequestEmployeeCompensationsItemPaidTimeOffItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        name = parsed_json["name"]
+        hours = parsed_json["hours"]
+        policy_uuid = parsed_json["policy_uuid"]
+        final_payout_unused_hours_input = parsed_json["final_payout_unused_hours_input"]
+        new(
+          name: name,
+          hours: hours,
+          policy_uuid: policy_uuid,
+          final_payout_unused_hours_input: final_payout_unused_hours_input,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of
+#  PayrollUpdateRequestEmployeeCompensationsItemPaidTimeOffItem to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+      #
+      # @param obj [Object] 
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.hours&.is_a?(String) != false || raise("Passed value for field obj.hours is not the expected type, validation failed.")
+        obj.policy_uuid&.is_a?(String) != false || raise("Passed value for field obj.policy_uuid is not the expected type, validation failed.")
+        obj.final_payout_unused_hours_input&.is_a?(String) != false || raise("Passed value for field obj.final_payout_unused_hours_input is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/payroll/types/payroll_update_request_employee_compensations_item_payment_method.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Payroll
+# The employee's compensation payment method. Invalid values will be ignored.
+    class PayrollUpdateRequestEmployeeCompensationsItemPaymentMethod
+
+      DIRECT_DEPOSIT = "Direct Deposit"
+      CHECK = "Check"
+
+    end
+  end
+end

data/lib/fern_gusto/payrolls/types/employee_pay_stub.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module Payrolls
+# The representation of an employee pay stub information.
+    class EmployeePayStub
+    # @return [String] The UUID of the employee pay stub.
+      attr_reader :uuid
+    # @return [String] The check date of the pay stub.
+      attr_reader :check_date
+    # @return [String] The gross pay amount for the pay stub.
+      attr_reader :gross_pay
+    # @return [String] The net pay amount for the pay stub.
+      attr_reader :net_pay
+    # @return [String] A unique identifier of the payroll to which the pay stub belongs.
+      attr_reader :payroll_uuid
+    # @return [String] The check amount for the pay stub.
+      attr_reader :check_amount
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param uuid [String] The UUID of the employee pay stub.
+      # @param check_date [String] The check date of the pay stub.
+      # @param gross_pay [String] The gross pay amount for the pay stub.
+      # @param net_pay [String] The net pay amount for the pay stub.
+      # @param payroll_uuid [String] A unique identifier of the payroll to which the pay stub belongs.
+      # @param check_amount [String] The check amount for the pay stub.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Payrolls::EmployeePayStub]
+      def initialize(uuid:, check_date: OMIT, gross_pay: OMIT, net_pay: OMIT, payroll_uuid: OMIT, check_amount: OMIT, additional_properties: nil)
+        @uuid = uuid
+        @check_date = check_date if check_date != OMIT
+        @gross_pay = gross_pay if gross_pay != OMIT
+        @net_pay = net_pay if net_pay != OMIT
+        @payroll_uuid = payroll_uuid if payroll_uuid != OMIT
+        @check_amount = check_amount if check_amount != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "uuid": uuid, "check_date": check_date, "gross_pay": gross_pay, "net_pay": net_pay, "payroll_uuid": payroll_uuid, "check_amount": check_amount }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of EmployeePayStub
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Payrolls::EmployeePayStub]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        uuid = parsed_json["uuid"]
+        check_date = parsed_json["check_date"]
+        gross_pay = parsed_json["gross_pay"]
+        net_pay = parsed_json["net_pay"]
+        payroll_uuid = parsed_json["payroll_uuid"]
+        check_amount = parsed_json["check_amount"]
+        new(
+          uuid: uuid,
+          check_date: check_date,
+          gross_pay: gross_pay,
+          net_pay: net_pay,
+          payroll_uuid: payroll_uuid,
+          check_amount: check_amount,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of EmployeePayStub to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+      #
+      # @param obj [Object] 
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.uuid.is_a?(String) != false || raise("Passed value for field obj.uuid is not the expected type, validation failed.")
+        obj.check_date&.is_a?(String) != false || raise("Passed value for field obj.check_date is not the expected type, validation failed.")
+        obj.gross_pay&.is_a?(String) != false || raise("Passed value for field obj.gross_pay is not the expected type, validation failed.")
+        obj.net_pay&.is_a?(String) != false || raise("Passed value for field obj.net_pay is not the expected type, validation failed.")
+        obj.payroll_uuid&.is_a?(String) != false || raise("Passed value for field obj.payroll_uuid is not the expected type, validation failed.")
+        obj.check_amount&.is_a?(String) != false || raise("Passed value for field obj.check_amount is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/payrolls/types/paid_time_off.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+require_relative "paid_time_off_name"
+require "ostruct"
+require "json"
+
+module Gusto
+  module Payrolls
+# The representation of paid time off in Gusto.
+    class PaidTimeOff
+    # @return [Gusto::Payrolls::PaidTimeOffName] The name of the paid time off type.
+      attr_reader :name
+    # @return [String] The name of the time off policy.
+      attr_reader :policy_name
+    # @return [String] The UUID of the time off policy.
+      attr_reader :policy_uuid
+    # @return [String] The unit the PTO type is accrued in.
+      attr_reader :accrual_unit
+    # @return [String] The number of accrual units accrued per accrual period.
+      attr_reader :accrual_rate
+    # @return [String] The accrual method of the time off policy
+      attr_reader :accrual_method
+    # @return [String] The frequency at which the PTO type is accrued.
+      attr_reader :accrual_period
+    # @return [String] The number of accrual units accrued.
+      attr_reader :accrual_balance
+    # @return [String] The maximum number of accrual units allowed. A null value signifies no maximum.
+      attr_reader :maximum_accrual_balance
+    # @return [Boolean] Whether the accrual balance is paid to the employee upon termination.
+      attr_reader :paid_at_termination
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param name [Gusto::Payrolls::PaidTimeOffName] The name of the paid time off type.
+      # @param policy_name [String] The name of the time off policy.
+      # @param policy_uuid [String] The UUID of the time off policy.
+      # @param accrual_unit [String] The unit the PTO type is accrued in.
+      # @param accrual_rate [String] The number of accrual units accrued per accrual period.
+      # @param accrual_method [String] The accrual method of the time off policy
+      # @param accrual_period [String] The frequency at which the PTO type is accrued.
+      # @param accrual_balance [String] The number of accrual units accrued.
+      # @param maximum_accrual_balance [String] The maximum number of accrual units allowed. A null value signifies no maximum.
+      # @param paid_at_termination [Boolean] Whether the accrual balance is paid to the employee upon termination.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Payrolls::PaidTimeOff]
+      def initialize(name: OMIT, policy_name: OMIT, policy_uuid: OMIT, accrual_unit: OMIT, accrual_rate: OMIT, accrual_method: OMIT, accrual_period: OMIT, accrual_balance: OMIT, maximum_accrual_balance: OMIT, paid_at_termination: OMIT, additional_properties: nil)
+        @name = name if name != OMIT
+        @policy_name = policy_name if policy_name != OMIT
+        @policy_uuid = policy_uuid if policy_uuid != OMIT
+        @accrual_unit = accrual_unit if accrual_unit != OMIT
+        @accrual_rate = accrual_rate if accrual_rate != OMIT
+        @accrual_method = accrual_method if accrual_method != OMIT
+        @accrual_period = accrual_period if accrual_period != OMIT
+        @accrual_balance = accrual_balance if accrual_balance != OMIT
+        @maximum_accrual_balance = maximum_accrual_balance if maximum_accrual_balance != OMIT
+        @paid_at_termination = paid_at_termination if paid_at_termination != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "name": name, "policy_name": policy_name, "policy_uuid": policy_uuid, "accrual_unit": accrual_unit, "accrual_rate": accrual_rate, "accrual_method": accrual_method, "accrual_period": accrual_period, "accrual_balance": accrual_balance, "maximum_accrual_balance": maximum_accrual_balance, "paid_at_termination": paid_at_termination }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of PaidTimeOff
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Payrolls::PaidTimeOff]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        name = parsed_json["name"]
+        policy_name = parsed_json["policy_name"]
+        policy_uuid = parsed_json["policy_uuid"]
+        accrual_unit = parsed_json["accrual_unit"]
+        accrual_rate = parsed_json["accrual_rate"]
+        accrual_method = parsed_json["accrual_method"]
+        accrual_period = parsed_json["accrual_period"]
+        accrual_balance = parsed_json["accrual_balance"]
+        maximum_accrual_balance = parsed_json["maximum_accrual_balance"]
+        paid_at_termination = parsed_json["paid_at_termination"]
+        new(
+          name: name,
+          policy_name: policy_name,
+          policy_uuid: policy_uuid,
+          accrual_unit: accrual_unit,
+          accrual_rate: accrual_rate,
+          accrual_method: accrual_method,
+          accrual_period: accrual_period,
+          accrual_balance: accrual_balance,
+          maximum_accrual_balance: maximum_accrual_balance,
+          paid_at_termination: paid_at_termination,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of PaidTimeOff to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+      #
+      # @param obj [Object] 
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.name&.is_a?(Gusto::Payrolls::PaidTimeOffName) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.policy_name&.is_a?(String) != false || raise("Passed value for field obj.policy_name is not the expected type, validation failed.")
+        obj.policy_uuid&.is_a?(String) != false || raise("Passed value for field obj.policy_uuid is not the expected type, validation failed.")
+        obj.accrual_unit&.is_a?(String) != false || raise("Passed value for field obj.accrual_unit is not the expected type, validation failed.")
+        obj.accrual_rate&.is_a?(String) != false || raise("Passed value for field obj.accrual_rate is not the expected type, validation failed.")
+        obj.accrual_method&.is_a?(String) != false || raise("Passed value for field obj.accrual_method is not the expected type, validation failed.")
+        obj.accrual_period&.is_a?(String) != false || raise("Passed value for field obj.accrual_period is not the expected type, validation failed.")
+        obj.accrual_balance&.is_a?(String) != false || raise("Passed value for field obj.accrual_balance is not the expected type, validation failed.")
+        obj.maximum_accrual_balance&.is_a?(String) != false || raise("Passed value for field obj.maximum_accrual_balance is not the expected type, validation failed.")
+        obj.paid_at_termination&.is_a?(Boolean) != false || raise("Passed value for field obj.paid_at_termination is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/payrolls/types/paid_time_off_name.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Payrolls
+# The name of the paid time off type.
+    class PaidTimeOffName
+
+      VACATION_HOURS = "Vacation Hours"
+      SICK_HOURS = "Sick Hours"
+      HOLIDAY_HOURS = "Holiday Hours"
+
+    end
+  end
+end

data/lib/fern_gusto/payrolls/types/pay_period.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require_relative "pay_period_payroll"
+require "ostruct"
+require "json"
+
+module Gusto
+  module Payrolls
+# The representation of a pay period.
+    class PayPeriod
+    # @return [String] The start date, inclusive, of the pay period.
+      attr_reader :start_date
+    # @return [String] The end date, inclusive, of the pay period.
+      attr_reader :end_date
+    # @return [String] A unique identifier of the pay schedule to which the pay period belongs.
+      attr_reader :pay_schedule_uuid
+    # @return [Gusto::Payrolls::PayPeriodPayroll] Information about the payroll for the pay period.
+      attr_reader :payroll
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param start_date [String] The start date, inclusive, of the pay period.
+      # @param end_date [String] The end date, inclusive, of the pay period.
+      # @param pay_schedule_uuid [String] A unique identifier of the pay schedule to which the pay period belongs.
+      # @param payroll [Gusto::Payrolls::PayPeriodPayroll] Information about the payroll for the pay period.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Payrolls::PayPeriod]
+      def initialize(start_date: OMIT, end_date: OMIT, pay_schedule_uuid: OMIT, payroll: OMIT, additional_properties: nil)
+        @start_date = start_date if start_date != OMIT
+        @end_date = end_date if end_date != OMIT
+        @pay_schedule_uuid = pay_schedule_uuid if pay_schedule_uuid != OMIT
+        @payroll = payroll if payroll != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "start_date": start_date, "end_date": end_date, "pay_schedule_uuid": pay_schedule_uuid, "payroll": payroll }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of PayPeriod
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Payrolls::PayPeriod]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        start_date = parsed_json["start_date"]
+        end_date = parsed_json["end_date"]
+        pay_schedule_uuid = parsed_json["pay_schedule_uuid"]
+        unless parsed_json["payroll"].nil?
+          payroll = parsed_json["payroll"].to_json
+          payroll = Gusto::Payrolls::PayPeriodPayroll.from_json(json_object: payroll)
+        else
+          payroll = nil
+        end
+        new(
+          start_date: start_date,
+          end_date: end_date,
+          pay_schedule_uuid: pay_schedule_uuid,
+          payroll: payroll,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of PayPeriod to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+      #
+      # @param obj [Object] 
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.start_date&.is_a?(String) != false || raise("Passed value for field obj.start_date is not the expected type, validation failed.")
+        obj.end_date&.is_a?(String) != false || raise("Passed value for field obj.end_date is not the expected type, validation failed.")
+        obj.pay_schedule_uuid&.is_a?(String) != false || raise("Passed value for field obj.pay_schedule_uuid is not the expected type, validation failed.")
+        obj.payroll.nil? || Gusto::Payrolls::PayPeriodPayroll.validate_raw(obj: obj.payroll)
+      end
+    end
+  end
+end

data/lib/fern_gusto/payrolls/types/pay_period_payroll.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+require "date"
+require_relative "pay_period_payroll_payroll_type"
+require "ostruct"
+require "json"
+
+module Gusto
+  module Payrolls
+# Information about the payroll for the pay period.
+    class PayPeriodPayroll
+    # @return [String] The UUID of the payroll for this pay period.
+      attr_reader :payroll_uuid
+    # @return [String] The date on which employees will be paid for the payroll if the payroll is
+#  submitted on time.
+      attr_reader :check_date
+    # @return [Boolean] Whether or not the payroll has been successfully processed. Note that processed
+#  payrolls cannot be updated. Additionally, a payroll is not guaranteed to be
+#  processed just because the payroll deadline has passed. Late payrolls are not
+#  uncommon. Conversely, users may choose to run payroll before the payroll
+#  deadline.
+      attr_reader :processed
+    # @return [DateTime] The date by which payroll should be run for employees to be paid on time.
+#  Payroll data, such as time and attendance data, should be submitted on or before
+#  this date.
+      attr_reader :payroll_deadline
+    # @return [Gusto::Payrolls::PayPeriodPayrollPayrollType] Whether it is regular pay period or transition pay period.
+      attr_reader :payroll_type
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param payroll_uuid [String] The UUID of the payroll for this pay period.
+      # @param check_date [String] The date on which employees will be paid for the payroll if the payroll is
+#  submitted on time.
+      # @param processed [Boolean] Whether or not the payroll has been successfully processed. Note that processed
+#  payrolls cannot be updated. Additionally, a payroll is not guaranteed to be
+#  processed just because the payroll deadline has passed. Late payrolls are not
+#  uncommon. Conversely, users may choose to run payroll before the payroll
+#  deadline.
+      # @param payroll_deadline [DateTime] The date by which payroll should be run for employees to be paid on time.
+#  Payroll data, such as time and attendance data, should be submitted on or before
+#  this date.
+      # @param payroll_type [Gusto::Payrolls::PayPeriodPayrollPayrollType] Whether it is regular pay period or transition pay period.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Payrolls::PayPeriodPayroll]
+      def initialize(payroll_uuid: OMIT, check_date: OMIT, processed: OMIT, payroll_deadline: OMIT, payroll_type: OMIT, additional_properties: nil)
+        @payroll_uuid = payroll_uuid if payroll_uuid != OMIT
+        @check_date = check_date if check_date != OMIT
+        @processed = processed if processed != OMIT
+        @payroll_deadline = payroll_deadline if payroll_deadline != OMIT
+        @payroll_type = payroll_type if payroll_type != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "payroll_uuid": payroll_uuid, "check_date": check_date, "processed": processed, "payroll_deadline": payroll_deadline, "payroll_type": payroll_type }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of PayPeriodPayroll
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Payrolls::PayPeriodPayroll]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        payroll_uuid = parsed_json["payroll_uuid"]
+        check_date = parsed_json["check_date"]
+        processed = parsed_json["processed"]
+        payroll_deadline = unless parsed_json["payroll_deadline"].nil?
+  DateTime.parse(parsed_json["payroll_deadline"])
+else
+  nil
+end
+        payroll_type = parsed_json["payroll_type"]
+        new(
+          payroll_uuid: payroll_uuid,
+          check_date: check_date,
+          processed: processed,
+          payroll_deadline: payroll_deadline,
+          payroll_type: payroll_type,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of PayPeriodPayroll to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+      #
+      # @param obj [Object] 
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.payroll_uuid&.is_a?(String) != false || raise("Passed value for field obj.payroll_uuid is not the expected type, validation failed.")
+        obj.check_date&.is_a?(String) != false || raise("Passed value for field obj.check_date is not the expected type, validation failed.")
+        obj.processed&.is_a?(Boolean) != false || raise("Passed value for field obj.processed is not the expected type, validation failed.")
+        obj.payroll_deadline&.is_a?(DateTime) != false || raise("Passed value for field obj.payroll_deadline is not the expected type, validation failed.")
+        obj.payroll_type&.is_a?(Gusto::Payrolls::PayPeriodPayrollPayrollType) != false || raise("Passed value for field obj.payroll_type is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/payrolls/types/pay_period_payroll_payroll_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Payrolls
+# Whether it is regular pay period or transition pay period.
+    class PayPeriodPayrollPayrollType
+
+      REGULAR = "regular"
+      TRANSITION = "transition"
+
+    end
+  end
+end