fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/employees/garnishments/client.rb

@@ -0,0 +1,558 @@
+# frozen_string_literal: true
+require_relative "../../../requests"
+require_relative "../../types/garnishment"
+require "json"
+require_relative "types/garnishments_create_request_garnishment_type"
+require_relative "../../types/garnishment_child_support"
+require_relative "../../types/child_support_data"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../../requests"
+
+module Gusto
+  module Employees
+    class GarnishmentsClient
+    # @return [Gusto::RequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Employees::GarnishmentsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# 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.
+#  scope: `garnishments:read`
+      #
+      # @param employee_id [String] The UUID of the employee
+      # @param page [Float] The page that is requested. When unspecified, will load all objects unless
+#  endpoint forces pagination.
+      # @param per [Float] Number of objects per page. For majority of endpoints will default to 25
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::Garnishment>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.list(employee_id: "employee_id")
+      def list(employee_id:, page: nil, per: nil, request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "page": page, "per": per }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/garnishments"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::Garnishment.from_json(json_object: item)
+        end
+      end
+# 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.
+#  scope: `garnishments:write`
+      #
+      # @param employee_id [String] The UUID of the employee
+      # @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 garnishment_type [Gusto::Employees::Garnishments::GarnishmentsCreateRequestGarnishmentType] The specific type of garnishment for court ordered garnishments.
+      # @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 total_amount [String] A maximum total deduction for the lifetime of this garnishment. A null value
+#  indicates no maximum.
+      # @param child_support [Hash] Request of type Gusto::GarnishmentChildSupport, as a Hash
+      #   * :state (String) 
+      #   * :payment_period (Gusto::GarnishmentChildSupportPaymentPeriod) 
+      #   * :fips_code (String) 
+      #   * :case_number (String) 
+      #   * :order_number (String) 
+      #   * :remittance_number (String) 
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Garnishment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.create(
+#    employee_id: "employee_id",
+#    amount: "150.00",
+#    description: "Back taxes",
+#    court_ordered: true,
+#    recurring: true,
+#    deduct_as_percentage: false
+#  )
+      def create(employee_id:, active: nil, amount:, description: nil, court_ordered:, garnishment_type: nil, times: nil, recurring: nil, annual_maximum: nil, pay_period_maximum: nil, deduct_as_percentage: nil, total_amount: nil, child_support: nil, request_options: nil)
+        response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), active: active, amount: amount, description: description, court_ordered: court_ordered, garnishment_type: garnishment_type, times: times, recurring: recurring, annual_maximum: annual_maximum, pay_period_maximum: pay_period_maximum, deduct_as_percentage: deduct_as_percentage, total_amount: total_amount, child_support: child_support }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/garnishments"
+end
+        Gusto::Garnishment.from_json(json_object: response.body)
+      end
+# 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.
+#  scope: `garnishments:read`
+      #
+      # @param garnishment_id [String] The UUID of the garnishment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Garnishment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.get(garnishment_id: "garnishment_id")
+      def get(garnishment_id:, request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/garnishments/#{garnishment_id}"
+end
+        Gusto::Garnishment.from_json(json_object: response.body)
+      end
+# 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.
+#  scope: `garnishments:write`
+      #
+      # @param garnishment_id [String] The UUID of the garnishment
+      # @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 total_amount [String] A maximum total deduction for the lifetime of this garnishment. A null value
+#  indicates no maximum.
+      # @param child_support [Hash] Request of type Gusto::GarnishmentChildSupport, as a Hash
+      #   * :state (String) 
+      #   * :payment_period (Gusto::GarnishmentChildSupportPaymentPeriod) 
+      #   * :fips_code (String) 
+      #   * :case_number (String) 
+      #   * :order_number (String) 
+      #   * :remittance_number (String) 
+      # @param version [String] The current version of the object. See the [versioning
+#  guide](https://docs.gusto.com/embedded-payroll/docs/versioning#object-layer) for
+#  information on how to use this field.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Garnishment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.update(
+#    garnishment_id: "garnishment_id",
+#    active: false,
+#    version: "52b7c567242cb7452e89ba2bc02cb476"
+#  )
+      def update(garnishment_id:, active: nil, amount: nil, description: nil, court_ordered: nil, times: nil, recurring: nil, annual_maximum: nil, pay_period_maximum: nil, deduct_as_percentage: nil, total_amount: nil, child_support: nil, version:, request_options: nil)
+        response = @request_client.conn.put do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), 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, total_amount: total_amount, child_support: child_support, version: version }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/garnishments/#{garnishment_id}"
+end
+        Gusto::Garnishment.from_json(json_object: response.body)
+      end
+# Agency data and requirements to be used for creating child support garnishments
+#  scope: `garnishments:read`
+      #
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ChildSupportData]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.list_child_support
+      def list_child_support(request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/garnishments/child_support"
+end
+        Gusto::ChildSupportData.from_json(json_object: response.body)
+      end
+    end
+    class AsyncGarnishmentsClient
+    # @return [Gusto::AsyncRequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Employees::AsyncGarnishmentsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# 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.
+#  scope: `garnishments:read`
+      #
+      # @param employee_id [String] The UUID of the employee
+      # @param page [Float] The page that is requested. When unspecified, will load all objects unless
+#  endpoint forces pagination.
+      # @param per [Float] Number of objects per page. For majority of endpoints will default to 25
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::Garnishment>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.list(employee_id: "employee_id")
+      def list(employee_id:, page: nil, per: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  req.params = { **(request_options&.additional_query_parameters || {}), "page": page, "per": per }.compact
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/garnishments"
+end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do | item |
+            item = item.to_json
+            Gusto::Garnishment.from_json(json_object: item)
+          end
+        end
+      end
+# 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.
+#  scope: `garnishments:write`
+      #
+      # @param employee_id [String] The UUID of the employee
+      # @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 garnishment_type [Gusto::Employees::Garnishments::GarnishmentsCreateRequestGarnishmentType] The specific type of garnishment for court ordered garnishments.
+      # @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 total_amount [String] A maximum total deduction for the lifetime of this garnishment. A null value
+#  indicates no maximum.
+      # @param child_support [Hash] Request of type Gusto::GarnishmentChildSupport, as a Hash
+      #   * :state (String) 
+      #   * :payment_period (Gusto::GarnishmentChildSupportPaymentPeriod) 
+      #   * :fips_code (String) 
+      #   * :case_number (String) 
+      #   * :order_number (String) 
+      #   * :remittance_number (String) 
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Garnishment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.create(
+#    employee_id: "employee_id",
+#    amount: "150.00",
+#    description: "Back taxes",
+#    court_ordered: true,
+#    recurring: true,
+#    deduct_as_percentage: false
+#  )
+      def create(employee_id:, active: nil, amount:, description: nil, court_ordered:, garnishment_type: nil, times: nil, recurring: nil, annual_maximum: nil, pay_period_maximum: nil, deduct_as_percentage: nil, total_amount: nil, child_support: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), active: active, amount: amount, description: description, court_ordered: court_ordered, garnishment_type: garnishment_type, times: times, recurring: recurring, annual_maximum: annual_maximum, pay_period_maximum: pay_period_maximum, deduct_as_percentage: deduct_as_percentage, total_amount: total_amount, child_support: child_support }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/garnishments"
+end
+          Gusto::Garnishment.from_json(json_object: response.body)
+        end
+      end
+# 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.
+#  scope: `garnishments:read`
+      #
+      # @param garnishment_id [String] The UUID of the garnishment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Garnishment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.get(garnishment_id: "garnishment_id")
+      def get(garnishment_id:, request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/garnishments/#{garnishment_id}"
+end
+          Gusto::Garnishment.from_json(json_object: response.body)
+        end
+      end
+# 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.
+#  scope: `garnishments:write`
+      #
+      # @param garnishment_id [String] The UUID of the garnishment
+      # @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 total_amount [String] A maximum total deduction for the lifetime of this garnishment. A null value
+#  indicates no maximum.
+      # @param child_support [Hash] Request of type Gusto::GarnishmentChildSupport, as a Hash
+      #   * :state (String) 
+      #   * :payment_period (Gusto::GarnishmentChildSupportPaymentPeriod) 
+      #   * :fips_code (String) 
+      #   * :case_number (String) 
+      #   * :order_number (String) 
+      #   * :remittance_number (String) 
+      # @param version [String] The current version of the object. See the [versioning
+#  guide](https://docs.gusto.com/embedded-payroll/docs/versioning#object-layer) for
+#  information on how to use this field.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Garnishment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.update(
+#    garnishment_id: "garnishment_id",
+#    active: false,
+#    version: "52b7c567242cb7452e89ba2bc02cb476"
+#  )
+      def update(garnishment_id:, active: nil, amount: nil, description: nil, court_ordered: nil, times: nil, recurring: nil, annual_maximum: nil, pay_period_maximum: nil, deduct_as_percentage: nil, total_amount: nil, child_support: nil, version:, request_options: nil)
+        Async do
+          response = @request_client.conn.put do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  req.body = { **(request_options&.additional_body_parameters || {}), 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, total_amount: total_amount, child_support: child_support, version: version }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/garnishments/#{garnishment_id}"
+end
+          Gusto::Garnishment.from_json(json_object: response.body)
+        end
+      end
+# Agency data and requirements to be used for creating child support garnishments
+#  scope: `garnishments:read`
+      #
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ChildSupportData]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.garnishments.list_child_support
+      def list_child_support(request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/garnishments/child_support"
+end
+          Gusto::ChildSupportData.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/fern_gusto/employees/garnishments/types/garnishments_create_request_garnishment_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Employees
+    module Garnishments
+# The specific type of garnishment for court ordered garnishments.
+      class GarnishmentsCreateRequestGarnishmentType
+
+        CHILD_SUPPORT = "child_support"
+        FEDERAL_TAX_LIEN = "federal_tax_lien"
+        STATE_TAX_LIEN = "state_tax_lien"
+        STUDENT_LOAN = "student_loan"
+        CREDITOR_GARNISHMENT = "creditor_garnishment"
+        FEDERAL_LOAN = "federal_loan"
+        OTHER_GARNISHMENT = "other_garnishment"
+
+      end
+    end
+  end
+end