fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/types/entity_error_object.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+require_relative "entity_error_object_errors_item"
+require "ostruct"
+require "json"
+
+module Gusto
+  class EntityErrorObject
+  # @return [String] Specifies where the error occurs. Typically this key identifies the
+#  attribute/parameter related to the error.
+    attr_reader :error_key
+  # @return [String] Specifies the type of error. The category provides error groupings and can be
+#  used to build custom error handling in your integration. If category is
+#  `nested_errors`, the object will contain a nested `errors` property with entity
+#  errors.
+    attr_reader :category
+  # @return [String] Provides details about the error - generally this message can be surfaced to an
+#  end user.
+    attr_reader :message
+  # @return [Hash{String => Object}] Contains relevant data to identify the resource in question when applicable. For
+#  example, to identify an entity `entity_type` and `entity_uuid` will be provided.
+    attr_reader :metadata
+  # @return [Array<Gusto::EntityErrorObjectErrorsItem>] Will only exist if category is `nested_errors`. It is possible to have multiple
+#  levels of nested errors.
+    attr_reader :errors
+  # @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 error_key [String] Specifies where the error occurs. Typically this key identifies the
+#  attribute/parameter related to the error.
+    # @param category [String] Specifies the type of error. The category provides error groupings and can be
+#  used to build custom error handling in your integration. If category is
+#  `nested_errors`, the object will contain a nested `errors` property with entity
+#  errors.
+    # @param message [String] Provides details about the error - generally this message can be surfaced to an
+#  end user.
+    # @param metadata [Hash{String => Object}] Contains relevant data to identify the resource in question when applicable. For
+#  example, to identify an entity `entity_type` and `entity_uuid` will be provided.
+    # @param errors [Array<Gusto::EntityErrorObjectErrorsItem>] Will only exist if category is `nested_errors`. It is possible to have multiple
+#  levels of nested errors.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::EntityErrorObject]
+    def initialize(error_key: OMIT, category: OMIT, message: OMIT, metadata: OMIT, errors: OMIT, additional_properties: nil)
+      @error_key = error_key if error_key != OMIT
+      @category = category if category != OMIT
+      @message = message if message != OMIT
+      @metadata = metadata if metadata != OMIT
+      @errors = errors if errors != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "error_key": error_key, "category": category, "message": message, "metadata": metadata, "errors": errors }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of EntityErrorObject
+    #
+    # @param json_object [String] 
+    # @return [Gusto::EntityErrorObject]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      error_key = parsed_json["error_key"]
+      category = parsed_json["category"]
+      message = parsed_json["message"]
+      metadata = parsed_json["metadata"]
+      errors = parsed_json["errors"]&.map do | item |
+  item = item.to_json
+  Gusto::EntityErrorObjectErrorsItem.from_json(json_object: item)
+end
+      new(
+        error_key: error_key,
+        category: category,
+        message: message,
+        metadata: metadata,
+        errors: errors,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of EntityErrorObject 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.error_key&.is_a?(String) != false || raise("Passed value for field obj.error_key is not the expected type, validation failed.")
+      obj.category&.is_a?(String) != false || raise("Passed value for field obj.category is not the expected type, validation failed.")
+      obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+      obj.errors&.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/entity_error_object_errors_item.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  class EntityErrorObjectErrorsItem
+  # @return [String] Specifies where the error occurs. Typically this key identifies the
+#  attribute/parameter related to the error.
+    attr_reader :error_key
+  # @return [String] Specifies the type of error. The category provides error groupings and can be
+#  used to build custom error handling in your integration. If category is
+#  `nested_errors`, the object will contain a nested `errors` property with entity
+#  errors.
+    attr_reader :category
+  # @return [String] Provides details about the error - generally this message can be surfaced to an
+#  end user.
+    attr_reader :message
+  # @return [Hash{String => Object}] Contains relevant data to identify the resource in question when applicable. For
+#  example, to identify an entity `entity_type` and `entity_uuid` will be provided.
+    attr_reader :metadata
+  # @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 error_key [String] Specifies where the error occurs. Typically this key identifies the
+#  attribute/parameter related to the error.
+    # @param category [String] Specifies the type of error. The category provides error groupings and can be
+#  used to build custom error handling in your integration. If category is
+#  `nested_errors`, the object will contain a nested `errors` property with entity
+#  errors.
+    # @param message [String] Provides details about the error - generally this message can be surfaced to an
+#  end user.
+    # @param metadata [Hash{String => Object}] Contains relevant data to identify the resource in question when applicable. For
+#  example, to identify an entity `entity_type` and `entity_uuid` will be provided.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::EntityErrorObjectErrorsItem]
+    def initialize(error_key: OMIT, category: OMIT, message: OMIT, metadata: OMIT, additional_properties: nil)
+      @error_key = error_key if error_key != OMIT
+      @category = category if category != OMIT
+      @message = message if message != OMIT
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "error_key": error_key, "category": category, "message": message, "metadata": metadata }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of EntityErrorObjectErrorsItem
+    #
+    # @param json_object [String] 
+    # @return [Gusto::EntityErrorObjectErrorsItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      error_key = parsed_json["error_key"]
+      category = parsed_json["category"]
+      message = parsed_json["message"]
+      metadata = parsed_json["metadata"]
+      new(
+        error_key: error_key,
+        category: category,
+        message: message,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of EntityErrorObjectErrorsItem 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.error_key&.is_a?(String) != false || raise("Passed value for field obj.error_key is not the expected type, validation failed.")
+      obj.category&.is_a?(String) != false || raise("Passed value for field obj.category is not the expected type, validation failed.")
+      obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/event.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+# Representation of an Event
+  class Event
+  # @return [String] Unique identifier for the event.
+    attr_reader :uuid
+  # @return [String] Description of the event (e.g., payroll.submitted, or company.form.signed).
+    attr_reader :event_type
+  # @return [String] Name of the parent resource of the described entity.
+    attr_reader :resource_type
+  # @return [String] Unique identifier for the parent resource.
+    attr_reader :resource_uuid
+  # @return [String] Name of the entity that the event corresponds to.
+    attr_reader :entity_type
+  # @return [String] Unique identifier for the entity.
+    attr_reader :entity_uuid
+  # @return [Integer] Time at which this event was created. Measured in seconds since the Unix epoch.
+    attr_reader :timestamp
+  # @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] Unique identifier for the event.
+    # @param event_type [String] Description of the event (e.g., payroll.submitted, or company.form.signed).
+    # @param resource_type [String] Name of the parent resource of the described entity.
+    # @param resource_uuid [String] Unique identifier for the parent resource.
+    # @param entity_type [String] Name of the entity that the event corresponds to.
+    # @param entity_uuid [String] Unique identifier for the entity.
+    # @param timestamp [Integer] Time at which this event was created. Measured in seconds since the Unix epoch.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::Event]
+    def initialize(uuid:, event_type: OMIT, resource_type: OMIT, resource_uuid: OMIT, entity_type: OMIT, entity_uuid: OMIT, timestamp: OMIT, additional_properties: nil)
+      @uuid = uuid
+      @event_type = event_type if event_type != OMIT
+      @resource_type = resource_type if resource_type != OMIT
+      @resource_uuid = resource_uuid if resource_uuid != OMIT
+      @entity_type = entity_type if entity_type != OMIT
+      @entity_uuid = entity_uuid if entity_uuid != OMIT
+      @timestamp = timestamp if timestamp != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "uuid": uuid, "event_type": event_type, "resource_type": resource_type, "resource_uuid": resource_uuid, "entity_type": entity_type, "entity_uuid": entity_uuid, "timestamp": timestamp }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of Event
+    #
+    # @param json_object [String] 
+    # @return [Gusto::Event]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      uuid = parsed_json["uuid"]
+      event_type = parsed_json["event_type"]
+      resource_type = parsed_json["resource_type"]
+      resource_uuid = parsed_json["resource_uuid"]
+      entity_type = parsed_json["entity_type"]
+      entity_uuid = parsed_json["entity_uuid"]
+      timestamp = parsed_json["timestamp"]
+      new(
+        uuid: uuid,
+        event_type: event_type,
+        resource_type: resource_type,
+        resource_uuid: resource_uuid,
+        entity_type: entity_type,
+        entity_uuid: entity_uuid,
+        timestamp: timestamp,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of Event 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.event_type&.is_a?(String) != false || raise("Passed value for field obj.event_type is not the expected type, validation failed.")
+      obj.resource_type&.is_a?(String) != false || raise("Passed value for field obj.resource_type is not the expected type, validation failed.")
+      obj.resource_uuid&.is_a?(String) != false || raise("Passed value for field obj.resource_uuid is not the expected type, validation failed.")
+      obj.entity_type&.is_a?(String) != false || raise("Passed value for field obj.entity_type is not the expected type, validation failed.")
+      obj.entity_uuid&.is_a?(String) != false || raise("Passed value for field obj.entity_uuid is not the expected type, validation failed.")
+      obj.timestamp&.is_a?(Integer) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/flsa_status_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gusto
+# The FLSA status for this compensation. Salaried ('Exempt') employees are paid a
+#  fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt')
+#  employees are paid a fixed salary every pay period, and receive overtime pay
+#  when applicable. Hourly ('Nonexempt') employees are paid for the hours they
+#  work, and receive overtime pay when applicable. Commissioned employees
+#  ('Commission Only Exempt') earn wages based only on commission. Commissioned
+#  with overtime ('Commission Only Nonexempt') earn wages based on commission, and
+#  receive overtime pay when applicable. Owners ('Owner') are employees that own at
+#  least twenty percent of the company.
+  class FlsaStatusType
+
+    EXEMPT = "Exempt"
+    SALARIED_NONEXEMPT = "Salaried Nonexempt"
+    NONEXEMPT = "Nonexempt"
+    OWNER = "Owner"
+    COMMISSION_ONLY_EXEMPT = "Commission Only Exempt"
+    COMMISSION_ONLY_NONEXEMPT = "Commission Only Nonexempt"
+
+  end
+end

data/lib/fern_gusto/types/form_pdf.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  class FormPdf
+  # @return [String] the UUID of the form
+    attr_reader :uuid
+  # @return [String] the URL of the form
+    attr_reader :document_url
+  # @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 form
+    # @param document_url [String] the URL of the form
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::FormPdf]
+    def initialize(uuid:, document_url: OMIT, additional_properties: nil)
+      @uuid = uuid
+      @document_url = document_url if document_url != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "uuid": uuid, "document_url": document_url }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of FormPdf
+    #
+    # @param json_object [String] 
+    # @return [Gusto::FormPdf]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      uuid = parsed_json["uuid"]
+      document_url = parsed_json["document_url"]
+      new(
+        uuid: uuid,
+        document_url: document_url,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FormPdf 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.document_url&.is_a?(String) != false || raise("Passed value for field obj.document_url is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/garnishment.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+require_relative "garnishment_garnishment_type"
+require_relative "garnishment_child_support"
+require "ostruct"
+require "json"
+
+module Gusto
+# Garnishments, or employee deductions, are fixed amounts or percentages deducted
+#  from an employee’s pay. They can be deducted a specific number of times or on a
+#  recurring basis. Garnishments can also have maximum deductions on a yearly or
+#  per-pay-period bases. Common uses for garnishments are court-ordered payments
+#  for child support or back taxes. Some companies provide loans to their employees
+#  that are repaid via garnishments.
+  class Garnishment
+  # @return [String] The UUID of the garnishment in Gusto.
+    attr_reader :uuid
+  # @return [String] 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.
+    attr_reader :version
+  # @return [String] The UUID of the employee to which this garnishment belongs.
+    attr_reader :employee_uuid
+  # @return [Boolean] Whether or not this garnishment is currently active.
+    attr_reader :active
+  # @return [String] The amount of the garnishment. Either a percentage or a fixed dollar amount.
+#  Represented as a float, e.g. "8.00".
+    attr_reader :amount
+  # @return [String] The description of the garnishment.
+    attr_reader :description
+  # @return [Boolean] Whether the garnishment is court ordered.
+    attr_reader :court_ordered
+  # @return [Integer] The number of times to apply the garnishment. Ignored if recurring is true.
+    attr_reader :times
+  # @return [Boolean] Whether the garnishment should recur indefinitely.
+    attr_reader :recurring
+  # @return [String] The maximum deduction per annum. A null value indicates no maximum. Represented
+#  as a float, e.g. "200.00".
+    attr_reader :annual_maximum
+  # @return [String] The maximum deduction per pay period. A null value indicates no maximum.
+#  Represented as a float, e.g. "16.00".
+    attr_reader :pay_period_maximum
+  # @return [Boolean] Whether the amount should be treated as a percentage to be deducted per pay
+#  period.
+    attr_reader :deduct_as_percentage
+  # @return [Gusto::GarnishmentGarnishmentType] The specific type of garnishment for court ordered garnishments.
+    attr_reader :garnishment_type
+  # @return [Gusto::GarnishmentChildSupport] 
+    attr_reader :child_support
+  # @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 garnishment in Gusto.
+    # @param version [String] 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.
+    # @param employee_uuid [String] The UUID of the employee to which this garnishment belongs.
+    # @param active [Boolean] Whether or not this garnishment is currently active.
+    # @param amount [String] The amount of the garnishment. Either a percentage or a fixed dollar amount.
+#  Represented as a float, e.g. "8.00".
+    # @param description [String] The description of the garnishment.
+    # @param court_ordered [Boolean] Whether the garnishment is court ordered.
+    # @param times [Integer] The number of times to apply the garnishment. Ignored if recurring is true.
+    # @param recurring [Boolean] Whether the garnishment should recur indefinitely.
+    # @param annual_maximum [String] The maximum deduction per annum. A null value indicates no maximum. Represented
+#  as a float, e.g. "200.00".
+    # @param pay_period_maximum [String] The maximum deduction per pay period. A null value indicates no maximum.
+#  Represented as a float, e.g. "16.00".
+    # @param deduct_as_percentage [Boolean] Whether the amount should be treated as a percentage to be deducted per pay
+#  period.
+    # @param garnishment_type [Gusto::GarnishmentGarnishmentType] The specific type of garnishment for court ordered garnishments.
+    # @param child_support [Gusto::GarnishmentChildSupport] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::Garnishment]
+    def initialize(uuid:, version: OMIT, employee_uuid: OMIT, active: OMIT, amount: OMIT, description: OMIT, court_ordered: OMIT, times: OMIT, recurring: OMIT, annual_maximum: OMIT, pay_period_maximum: OMIT, deduct_as_percentage: OMIT, garnishment_type: OMIT, child_support: OMIT, additional_properties: nil)
+      @uuid = uuid
+      @version = version if version != OMIT
+      @employee_uuid = employee_uuid if employee_uuid != OMIT
+      @active = active if active != OMIT
+      @amount = amount if amount != OMIT
+      @description = description if description != OMIT
+      @court_ordered = court_ordered if court_ordered != OMIT
+      @times = times if times != OMIT
+      @recurring = recurring if recurring != OMIT
+      @annual_maximum = annual_maximum if annual_maximum != OMIT
+      @pay_period_maximum = pay_period_maximum if pay_period_maximum != OMIT
+      @deduct_as_percentage = deduct_as_percentage if deduct_as_percentage != OMIT
+      @garnishment_type = garnishment_type if garnishment_type != OMIT
+      @child_support = child_support if child_support != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "uuid": uuid, "version": version, "employee_uuid": employee_uuid, "active": active, "amount": amount, "description": description, "court_ordered": court_ordered, "times": times, "recurring": recurring, "annual_maximum": annual_maximum, "pay_period_maximum": pay_period_maximum, "deduct_as_percentage": deduct_as_percentage, "garnishment_type": garnishment_type, "child_support": child_support }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of Garnishment
+    #
+    # @param json_object [String] 
+    # @return [Gusto::Garnishment]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      uuid = parsed_json["uuid"]
+      version = parsed_json["version"]
+      employee_uuid = parsed_json["employee_uuid"]
+      active = parsed_json["active"]
+      amount = parsed_json["amount"]
+      description = parsed_json["description"]
+      court_ordered = parsed_json["court_ordered"]
+      times = parsed_json["times"]
+      recurring = parsed_json["recurring"]
+      annual_maximum = parsed_json["annual_maximum"]
+      pay_period_maximum = parsed_json["pay_period_maximum"]
+      deduct_as_percentage = parsed_json["deduct_as_percentage"]
+      garnishment_type = parsed_json["garnishment_type"]
+      unless parsed_json["child_support"].nil?
+        child_support = parsed_json["child_support"].to_json
+        child_support = Gusto::GarnishmentChildSupport.from_json(json_object: child_support)
+      else
+        child_support = nil
+      end
+      new(
+        uuid: uuid,
+        version: version,
+        employee_uuid: employee_uuid,
+        active: active,
+        amount: amount,
+        description: description,
+        court_ordered: court_ordered,
+        times: times,
+        recurring: recurring,
+        annual_maximum: annual_maximum,
+        pay_period_maximum: pay_period_maximum,
+        deduct_as_percentage: deduct_as_percentage,
+        garnishment_type: garnishment_type,
+        child_support: child_support,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of Garnishment 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.version&.is_a?(String) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
+      obj.employee_uuid&.is_a?(String) != false || raise("Passed value for field obj.employee_uuid is not the expected type, validation failed.")
+      obj.active&.is_a?(Boolean) != false || raise("Passed value for field obj.active is not the expected type, validation failed.")
+      obj.amount&.is_a?(String) != false || raise("Passed value for field obj.amount is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.court_ordered&.is_a?(Boolean) != false || raise("Passed value for field obj.court_ordered is not the expected type, validation failed.")
+      obj.times&.is_a?(Integer) != false || raise("Passed value for field obj.times is not the expected type, validation failed.")
+      obj.recurring&.is_a?(Boolean) != false || raise("Passed value for field obj.recurring is not the expected type, validation failed.")
+      obj.annual_maximum&.is_a?(String) != false || raise("Passed value for field obj.annual_maximum is not the expected type, validation failed.")
+      obj.pay_period_maximum&.is_a?(String) != false || raise("Passed value for field obj.pay_period_maximum is not the expected type, validation failed.")
+      obj.deduct_as_percentage&.is_a?(Boolean) != false || raise("Passed value for field obj.deduct_as_percentage is not the expected type, validation failed.")
+      obj.garnishment_type&.is_a?(Gusto::GarnishmentGarnishmentType) != false || raise("Passed value for field obj.garnishment_type is not the expected type, validation failed.")
+      obj.child_support.nil? || Gusto::GarnishmentChildSupport.validate_raw(obj: obj.child_support)
+    end
+  end
+end

data/lib/fern_gusto/types/garnishment_child_support.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+require_relative "garnishment_child_support_payment_period"
+require "ostruct"
+require "json"
+
+module Gusto
+# Additional child support order details
+  class GarnishmentChildSupport
+  # @return [String] The two letter state abbreviation for the state issuing the child support order.
+#  Agency data is available in the `GET /v1/garnishments/child_support` API.
+    attr_reader :state
+  # @return [Gusto::GarnishmentChildSupportPaymentPeriod] How often the agency collects the withholding amount. e.g. $500 monthly ->
+#  `Monthly`.
+    attr_reader :payment_period
+  # @return [String] The FIPS code associated with the state or county agency issuing the child
+#  support order. Agency data is available in the `GET
+#  /v1/garnishments/child_support` API.
+    attr_reader :fips_code
+  # @return [String] Child Support Enforcement Case Number associated with this child support
+#  obligation - required for most states. Agency specific requirements are
+#  available in the `GET /v1/garnishments/child_support` API.
+    attr_reader :case_number
+  # @return [String] Order Identifier or Order ID associated with this child support obligation -
+#  required for some states. Agency specific requirements are available in the `GET
+#  /v1/garnishments/child_support` API.
+    attr_reader :order_number
+  # @return [String] Child Support Enforcement Remittance ID associated with this child support
+#  obligation - required for some states. Agency specific requirements are
+#  available in the `GET /v1/garnishments/child_support` API.
+    attr_reader :remittance_number
+  # @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 state [String] The two letter state abbreviation for the state issuing the child support order.
+#  Agency data is available in the `GET /v1/garnishments/child_support` API.
+    # @param payment_period [Gusto::GarnishmentChildSupportPaymentPeriod] How often the agency collects the withholding amount. e.g. $500 monthly ->
+#  `Monthly`.
+    # @param fips_code [String] The FIPS code associated with the state or county agency issuing the child
+#  support order. Agency data is available in the `GET
+#  /v1/garnishments/child_support` API.
+    # @param case_number [String] Child Support Enforcement Case Number associated with this child support
+#  obligation - required for most states. Agency specific requirements are
+#  available in the `GET /v1/garnishments/child_support` API.
+    # @param order_number [String] Order Identifier or Order ID associated with this child support obligation -
+#  required for some states. Agency specific requirements are available in the `GET
+#  /v1/garnishments/child_support` API.
+    # @param remittance_number [String] Child Support Enforcement Remittance ID associated with this child support
+#  obligation - required for some states. Agency specific requirements are
+#  available in the `GET /v1/garnishments/child_support` API.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::GarnishmentChildSupport]
+    def initialize(state: OMIT, payment_period: OMIT, fips_code: OMIT, case_number: OMIT, order_number: OMIT, remittance_number: OMIT, additional_properties: nil)
+      @state = state if state != OMIT
+      @payment_period = payment_period if payment_period != OMIT
+      @fips_code = fips_code if fips_code != OMIT
+      @case_number = case_number if case_number != OMIT
+      @order_number = order_number if order_number != OMIT
+      @remittance_number = remittance_number if remittance_number != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "state": state, "payment_period": payment_period, "fips_code": fips_code, "case_number": case_number, "order_number": order_number, "remittance_number": remittance_number }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of GarnishmentChildSupport
+    #
+    # @param json_object [String] 
+    # @return [Gusto::GarnishmentChildSupport]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      state = parsed_json["state"]
+      payment_period = parsed_json["payment_period"]
+      fips_code = parsed_json["fips_code"]
+      case_number = parsed_json["case_number"]
+      order_number = parsed_json["order_number"]
+      remittance_number = parsed_json["remittance_number"]
+      new(
+        state: state,
+        payment_period: payment_period,
+        fips_code: fips_code,
+        case_number: case_number,
+        order_number: order_number,
+        remittance_number: remittance_number,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of GarnishmentChildSupport 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.state&.is_a?(String) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.payment_period&.is_a?(Gusto::GarnishmentChildSupportPaymentPeriod) != false || raise("Passed value for field obj.payment_period is not the expected type, validation failed.")
+      obj.fips_code&.is_a?(String) != false || raise("Passed value for field obj.fips_code is not the expected type, validation failed.")
+      obj.case_number&.is_a?(String) != false || raise("Passed value for field obj.case_number is not the expected type, validation failed.")
+      obj.order_number&.is_a?(String) != false || raise("Passed value for field obj.order_number is not the expected type, validation failed.")
+      obj.remittance_number&.is_a?(String) != false || raise("Passed value for field obj.remittance_number is not the expected type, validation failed.")
+    end
+  end
+end