fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/employees/client.rb

@@ -0,0 +1,822 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "employments/client"
+require_relative "adresses/client"
+require_relative "tax_setup/client"
+require_relative "payment_method/client"
+require_relative "jobs_and_compensations/client"
+require_relative "forms/client"
+require_relative "benefits/client"
+require_relative "garnishments/client"
+require_relative "types/employees_get_request_include"
+require_relative "types/employee"
+require_relative "types/employees_get_custom_fields_response"
+require_relative "types/employee_onboarding_info"
+require_relative "../types/time_off_activity"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../requests"
+
+module Gusto
+  class EmployeesClient
+  # @return [Gusto::RequestClient] 
+    attr_reader :request_client
+  # @return [Gusto::Employees::EmploymentsClient] 
+    attr_reader :employments
+  # @return [Gusto::Employees::AdressesClient] 
+    attr_reader :adresses
+  # @return [Gusto::Employees::TaxSetupClient] 
+    attr_reader :tax_setup
+  # @return [Gusto::Employees::PaymentMethodClient] 
+    attr_reader :payment_method
+  # @return [Gusto::Employees::JobsAndCompensationsClient] 
+    attr_reader :jobs_and_compensations
+  # @return [Gusto::Employees::FormsClient] 
+    attr_reader :forms
+  # @return [Gusto::Employees::BenefitsClient] 
+    attr_reader :benefits
+  # @return [Gusto::Employees::GarnishmentsClient] 
+    attr_reader :garnishments
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::EmployeesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+      @employments = Gusto::Employees::EmploymentsClient.new(request_client: request_client)
+      @adresses = Gusto::Employees::AdressesClient.new(request_client: request_client)
+      @tax_setup = Gusto::Employees::TaxSetupClient.new(request_client: request_client)
+      @payment_method = Gusto::Employees::PaymentMethodClient.new(request_client: request_client)
+      @jobs_and_compensations = Gusto::Employees::JobsAndCompensationsClient.new(request_client: request_client)
+      @forms = Gusto::Employees::FormsClient.new(request_client: request_client)
+      @benefits = Gusto::Employees::BenefitsClient.new(request_client: request_client)
+      @garnishments = Gusto::Employees::GarnishmentsClient.new(request_client: request_client)
+    end
+# Get an employee.
+#  scope: `employees:read`
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @param include [Gusto::Employees::EmployeesGetRequestInclude] Include the requested attribute(s) in each employee response, multiple options
+#  are comma separated. Available options:
+#  - all_compensations: Include all effective dated compensations for each job
+#  instead of only the current compensation
+#  - custom_fields: Include employees' custom fields
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Employees::Employee]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.get(employee_id: "employee_id")
+    def get(employee_id:, include: 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 || {}), "include": include }.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}"
+end
+      Gusto::Employees::Employee.from_json(json_object: response.body)
+    end
+# Update an employee.
+#  scope: `employees:write`
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @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 first_name [String] 
+    # @param middle_initial [String] 
+    # @param last_name [String] 
+    # @param preferred_first_name [String] 
+    # @param date_of_birth [String] 
+    # @param email [String] The employee's personal email address.
+    # @param ssn [String] 
+    # @param two_percent_shareholder [Boolean] Whether the employee is a two percent shareholder of the company. This field
+#  only applies to companies with an S-Corp entity type.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Employees::Employee]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.update(
+#    employee_id: "employee_id",
+#    version: "db0edd04aaac4506f7edab03ac855d56",
+#    first_name: "Soren",
+#    middle_initial: "A",
+#    last_name: "Kierkegaard",
+#    preferred_first_name: "Angel",
+#    date_of_birth: "1995-05-05",
+#    email: "knight0faith@example.com",
+#    ssn: "123456294",
+#    two_percent_shareholder: false
+#  )
+    def update(employee_id:, version:, first_name: nil, middle_initial: nil, last_name: nil, preferred_first_name: nil, date_of_birth: nil, email: nil, ssn: nil, two_percent_shareholder: nil, 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 || {}), version: version, first_name: first_name, middle_initial: middle_initial, last_name: last_name, preferred_first_name: preferred_first_name, date_of_birth: date_of_birth, email: email, ssn: ssn, two_percent_shareholder: two_percent_shareholder }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}"
+end
+      Gusto::Employees::Employee.from_json(json_object: response.body)
+    end
+# Use this endpoint to delete an employee who is in onboarding. Deleting
+#  an onboarded employee is not allowed and will return a 422 response. Please
+#  check out the Terminations api
+#  if you need to terminate an onboarded employee.
+#  scope: `employees:manage`
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Void]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.delete(employee_id: "employee_id")
+    def delete(employee_id:, request_options: nil)
+      response = @request_client.conn.delete 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/employees/#{employee_id}"
+end
+    end
+# Returns a list of the employee's custom fields.
+#  scope: `employees: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 [Gusto::Employees::EmployeesGetCustomFieldsResponse]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.get_custom_fields(employee_id: "employee_id")
+    def get_custom_fields(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}/custom_fields"
+end
+      Gusto::Employees::EmployeesGetCustomFieldsResponse.from_json(json_object: response.body)
+    end
+# # Description
+#  Retrieves an employee's onboarding status. The data returned helps inform the
+#  required onboarding steps and respective completion status.
+#  scope: `employees:read`
+#  ## onboarding_status
+#  ### Admin-facilitated onboarding
+#  | onboarding_status             |
+#  Description |
+#  | :---------------------------- |
+#  ----------------------------------------------------: |
+#  | `admin_onboarding_incomplete` | Admin needs to complete the full
+#  employee-onboarding. |
+#  | `onboarding_completed`        |       Employee has been fully onboarded and
+#  verified. |
+#  ### Employee self-onboarding
+#  | onboarding_status                       |
+#  Description |
+#  | :-------------------------------------- |
+#  -------------------------------------------------------------------------------:
+#  |
+#  | `admin_onboarding_incomplete`           |
+#  Admin needs to enter basic information about the employee. |
+#  | `self_onboarding_pending_invite`        |
+#  Admin has the intention to invite the employee to self-onboard (e.g.,
+#  marking a checkbox), but the system has not yet sent the invitation. |
+#  | `self_onboarding_invited`               |
+#  Employee has been sent an invitation to self-onboard. |
+#  | `self_onboarding_invited_started`       |
+#  Employee has started the self-onboarding process. |
+#  | `self_onboarding_invited_overdue`       |
+#  Employee's start date
+#  has passed, and employee has still not completed self-onboarding. |
+#  | `self_onboarding_completed_by_employee` | Employee has completed entering in
+#  their information. The status should be updated via API to
+#  "self_onboarding_awaiting_admin_review" from here, once the Admin has started
+#  reviewing. |
+#  | `self_onboarding_awaiting_admin_review` |
+#  Admin has started to verify the employee's information. |
+#  | `onboarding_completed`                  |
+#  Employee has been fully onboarded and verified. |
+#  ## onboarding_steps
+#  | onboarding_steps        |
+#  Requirement(s) to be completed |
+#  | :---------------------- |
+#  -------------------------------------------------------------------------------:
+#  |
+#  | `personal_details`      |     Add employee's first name, last name, email,
+#  date of birth, social security number |
+#  | `compensation_details`  |                                            Associate
+#  employee to a job & compensation. |
+#  | `add_work_address`      |
+#  Add employee work address. |
+#  | `add_home_address`      |
+#  Add employee home address. |
+#  | `federal_tax_setup`     |
+#  Set up federal tax withholdings. |
+#  | `state_tax_setup`       |
+#  Set up state tax withholdings. |
+#  | `direct_deposit_setup`  |                                           (optional)
+#  Set up employee's direct deposit. |
+#  | `employee_form_signing` |        Employee forms (e.g., W4, direct deposit
+#  authorization) are generated & signed. |
+#  | `file_new_hire_report`  |                                              File a
+#  new hire report for this employee. |
+#  | `admin_review`          | Admin reviews & confirms employee details (only
+#  required for Employee self-onboarding) |
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Employees::EmployeeOnboardingInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.get_onboarding_status(employee_id: "employee_id")
+    def get_onboarding_status(employee_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/employees/#{employee_id}/onboarding_status"
+end
+      Gusto::Employees::EmployeeOnboardingInfo.from_json(json_object: response.body)
+    end
+# scope: `employees:manage`
+#  Updates an employee's onboarding status.
+#  Below is a list of valid onboarding status changes depending on the intended
+#  action to be performed on behalf of the employee.
+#  | Action                                   |                        current
+#  onboarding_status                         |                   new
+#  onboarding_status |
+#  | :--------------------------------------- |
+#  :----------------------------------------------------------------------: |
+#  --------------------------------------: |
+#  | Mark an employee as self-onboarding      |
+#  `admin_onboarding_incomplete`                       |
+#  `self_onboarding_pending_invite` |
+#  | Invite an employee to self-onboard       |    `admin_onboarding_incomplete` or
+#  `self_onboarding_pending_invite`     |               `self_onboarding_invited` |
+#  | Cancel an employee's self-onboarding     |      `self_onboarding_invited` or
+#  `self_onboarding_pending_invite`       |           `admin_onboarding_incomplete`
+#  |
+#  | Review an employee's self-onboarded info |
+#  `self_onboarding_completed_by_employee`                  |
+#  `self_onboarding_awaiting_admin_review` |
+#  | Finish an employee's onboarding          | `admin_onboarding_incomplete` or
+#  `self_onboarding_awaiting_admin_review` |
+#  `onboarding_completed` |
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @param onboarding_status [String] The updated onboarding status for the employee
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Employees::EmployeeOnboardingInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.update_onboarding_status(employee_id: "employee_id", onboarding_status: "onboarding_status")
+    def update_onboarding_status(employee_id:, onboarding_status:, 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 || {}), onboarding_status: onboarding_status }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/onboarding_status"
+end
+      Gusto::Employees::EmployeeOnboardingInfo.from_json(json_object: response.body)
+    end
+# Get employee time off activities.
+#  scope: `employee_time_off_activities:read`
+    #
+    # @param employee_uuid [String] The UUID of the employee
+    # @param time_off_type [String] The time off type name you want to query data for. ex: 'sick' or 'vacation'
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffActivity]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.get_time_off_activities(employee_uuid: "employee_uuid", time_off_type: "time_off_type")
+    def get_time_off_activities(employee_uuid:, time_off_type:, 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 || {}), "time_off_type": time_off_type }.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_uuid}/time_off_activities"
+end
+      Gusto::TimeOffActivity.from_json(json_object: response.body)
+    end
+  end
+  class AsyncEmployeesClient
+  # @return [Gusto::AsyncRequestClient] 
+    attr_reader :request_client
+  # @return [Gusto::Employees::EmploymentsClient] 
+    attr_reader :employments
+  # @return [Gusto::Employees::AdressesClient] 
+    attr_reader :adresses
+  # @return [Gusto::Employees::TaxSetupClient] 
+    attr_reader :tax_setup
+  # @return [Gusto::Employees::PaymentMethodClient] 
+    attr_reader :payment_method
+  # @return [Gusto::Employees::JobsAndCompensationsClient] 
+    attr_reader :jobs_and_compensations
+  # @return [Gusto::Employees::FormsClient] 
+    attr_reader :forms
+  # @return [Gusto::Employees::BenefitsClient] 
+    attr_reader :benefits
+  # @return [Gusto::Employees::GarnishmentsClient] 
+    attr_reader :garnishments
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AsyncEmployeesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+      @employments = Gusto::Employees::AsyncEmploymentsClient.new(request_client: request_client)
+      @adresses = Gusto::Employees::AsyncAdressesClient.new(request_client: request_client)
+      @tax_setup = Gusto::Employees::AsyncTaxSetupClient.new(request_client: request_client)
+      @payment_method = Gusto::Employees::AsyncPaymentMethodClient.new(request_client: request_client)
+      @jobs_and_compensations = Gusto::Employees::AsyncJobsAndCompensationsClient.new(request_client: request_client)
+      @forms = Gusto::Employees::AsyncFormsClient.new(request_client: request_client)
+      @benefits = Gusto::Employees::AsyncBenefitsClient.new(request_client: request_client)
+      @garnishments = Gusto::Employees::AsyncGarnishmentsClient.new(request_client: request_client)
+    end
+# Get an employee.
+#  scope: `employees:read`
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @param include [Gusto::Employees::EmployeesGetRequestInclude] Include the requested attribute(s) in each employee response, multiple options
+#  are comma separated. Available options:
+#  - all_compensations: Include all effective dated compensations for each job
+#  instead of only the current compensation
+#  - custom_fields: Include employees' custom fields
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Employees::Employee]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.get(employee_id: "employee_id")
+    def get(employee_id:, include: 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 || {}), "include": include }.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}"
+end
+        Gusto::Employees::Employee.from_json(json_object: response.body)
+      end
+    end
+# Update an employee.
+#  scope: `employees:write`
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @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 first_name [String] 
+    # @param middle_initial [String] 
+    # @param last_name [String] 
+    # @param preferred_first_name [String] 
+    # @param date_of_birth [String] 
+    # @param email [String] The employee's personal email address.
+    # @param ssn [String] 
+    # @param two_percent_shareholder [Boolean] Whether the employee is a two percent shareholder of the company. This field
+#  only applies to companies with an S-Corp entity type.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Employees::Employee]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.update(
+#    employee_id: "employee_id",
+#    version: "db0edd04aaac4506f7edab03ac855d56",
+#    first_name: "Soren",
+#    middle_initial: "A",
+#    last_name: "Kierkegaard",
+#    preferred_first_name: "Angel",
+#    date_of_birth: "1995-05-05",
+#    email: "knight0faith@example.com",
+#    ssn: "123456294",
+#    two_percent_shareholder: false
+#  )
+    def update(employee_id:, version:, first_name: nil, middle_initial: nil, last_name: nil, preferred_first_name: nil, date_of_birth: nil, email: nil, ssn: nil, two_percent_shareholder: nil, 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 || {}), version: version, first_name: first_name, middle_initial: middle_initial, last_name: last_name, preferred_first_name: preferred_first_name, date_of_birth: date_of_birth, email: email, ssn: ssn, two_percent_shareholder: two_percent_shareholder }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}"
+end
+        Gusto::Employees::Employee.from_json(json_object: response.body)
+      end
+    end
+# Use this endpoint to delete an employee who is in onboarding. Deleting
+#  an onboarded employee is not allowed and will return a 422 response. Please
+#  check out the Terminations api
+#  if you need to terminate an onboarded employee.
+#  scope: `employees:manage`
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Void]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.delete(employee_id: "employee_id")
+    def delete(employee_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.delete 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/employees/#{employee_id}"
+end
+      end
+    end
+# Returns a list of the employee's custom fields.
+#  scope: `employees: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 [Gusto::Employees::EmployeesGetCustomFieldsResponse]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.get_custom_fields(employee_id: "employee_id")
+    def get_custom_fields(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}/custom_fields"
+end
+        Gusto::Employees::EmployeesGetCustomFieldsResponse.from_json(json_object: response.body)
+      end
+    end
+# # Description
+#  Retrieves an employee's onboarding status. The data returned helps inform the
+#  required onboarding steps and respective completion status.
+#  scope: `employees:read`
+#  ## onboarding_status
+#  ### Admin-facilitated onboarding
+#  | onboarding_status             |
+#  Description |
+#  | :---------------------------- |
+#  ----------------------------------------------------: |
+#  | `admin_onboarding_incomplete` | Admin needs to complete the full
+#  employee-onboarding. |
+#  | `onboarding_completed`        |       Employee has been fully onboarded and
+#  verified. |
+#  ### Employee self-onboarding
+#  | onboarding_status                       |
+#  Description |
+#  | :-------------------------------------- |
+#  -------------------------------------------------------------------------------:
+#  |
+#  | `admin_onboarding_incomplete`           |
+#  Admin needs to enter basic information about the employee. |
+#  | `self_onboarding_pending_invite`        |
+#  Admin has the intention to invite the employee to self-onboard (e.g.,
+#  marking a checkbox), but the system has not yet sent the invitation. |
+#  | `self_onboarding_invited`               |
+#  Employee has been sent an invitation to self-onboard. |
+#  | `self_onboarding_invited_started`       |
+#  Employee has started the self-onboarding process. |
+#  | `self_onboarding_invited_overdue`       |
+#  Employee's start date
+#  has passed, and employee has still not completed self-onboarding. |
+#  | `self_onboarding_completed_by_employee` | Employee has completed entering in
+#  their information. The status should be updated via API to
+#  "self_onboarding_awaiting_admin_review" from here, once the Admin has started
+#  reviewing. |
+#  | `self_onboarding_awaiting_admin_review` |
+#  Admin has started to verify the employee's information. |
+#  | `onboarding_completed`                  |
+#  Employee has been fully onboarded and verified. |
+#  ## onboarding_steps
+#  | onboarding_steps        |
+#  Requirement(s) to be completed |
+#  | :---------------------- |
+#  -------------------------------------------------------------------------------:
+#  |
+#  | `personal_details`      |     Add employee's first name, last name, email,
+#  date of birth, social security number |
+#  | `compensation_details`  |                                            Associate
+#  employee to a job & compensation. |
+#  | `add_work_address`      |
+#  Add employee work address. |
+#  | `add_home_address`      |
+#  Add employee home address. |
+#  | `federal_tax_setup`     |
+#  Set up federal tax withholdings. |
+#  | `state_tax_setup`       |
+#  Set up state tax withholdings. |
+#  | `direct_deposit_setup`  |                                           (optional)
+#  Set up employee's direct deposit. |
+#  | `employee_form_signing` |        Employee forms (e.g., W4, direct deposit
+#  authorization) are generated & signed. |
+#  | `file_new_hire_report`  |                                              File a
+#  new hire report for this employee. |
+#  | `admin_review`          | Admin reviews & confirms employee details (only
+#  required for Employee self-onboarding) |
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Employees::EmployeeOnboardingInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.get_onboarding_status(employee_id: "employee_id")
+    def get_onboarding_status(employee_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/employees/#{employee_id}/onboarding_status"
+end
+        Gusto::Employees::EmployeeOnboardingInfo.from_json(json_object: response.body)
+      end
+    end
+# scope: `employees:manage`
+#  Updates an employee's onboarding status.
+#  Below is a list of valid onboarding status changes depending on the intended
+#  action to be performed on behalf of the employee.
+#  | Action                                   |                        current
+#  onboarding_status                         |                   new
+#  onboarding_status |
+#  | :--------------------------------------- |
+#  :----------------------------------------------------------------------: |
+#  --------------------------------------: |
+#  | Mark an employee as self-onboarding      |
+#  `admin_onboarding_incomplete`                       |
+#  `self_onboarding_pending_invite` |
+#  | Invite an employee to self-onboard       |    `admin_onboarding_incomplete` or
+#  `self_onboarding_pending_invite`     |               `self_onboarding_invited` |
+#  | Cancel an employee's self-onboarding     |      `self_onboarding_invited` or
+#  `self_onboarding_pending_invite`       |           `admin_onboarding_incomplete`
+#  |
+#  | Review an employee's self-onboarded info |
+#  `self_onboarding_completed_by_employee`                  |
+#  `self_onboarding_awaiting_admin_review` |
+#  | Finish an employee's onboarding          | `admin_onboarding_incomplete` or
+#  `self_onboarding_awaiting_admin_review` |
+#  `onboarding_completed` |
+    #
+    # @param employee_id [String] The UUID of the employee
+    # @param onboarding_status [String] The updated onboarding status for the employee
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Employees::EmployeeOnboardingInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.update_onboarding_status(employee_id: "employee_id", onboarding_status: "onboarding_status")
+    def update_onboarding_status(employee_id:, onboarding_status:, 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 || {}), onboarding_status: onboarding_status }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/employees/#{employee_id}/onboarding_status"
+end
+        Gusto::Employees::EmployeeOnboardingInfo.from_json(json_object: response.body)
+      end
+    end
+# Get employee time off activities.
+#  scope: `employee_time_off_activities:read`
+    #
+    # @param employee_uuid [String] The UUID of the employee
+    # @param time_off_type [String] The time off type name you want to query data for. ex: 'sick' or 'vacation'
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffActivity]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.employees.get_time_off_activities(employee_uuid: "employee_uuid", time_off_type: "time_off_type")
+    def get_time_off_activities(employee_uuid:, time_off_type:, 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 || {}), "time_off_type": time_off_type }.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_uuid}/time_off_activities"
+end
+        Gusto::TimeOffActivity.from_json(json_object: response.body)
+      end
+    end
+  end
+end