fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/time_off_policies/client.rb

@@ -0,0 +1,863 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "../types/accruing_time_off_hour"
+require "json"
+require_relative "../types/time_off_policy"
+require_relative "types/time_off_policies_update_request_accrual_method"
+require_relative "types/time_off_policies_create_request_accrual_method"
+require_relative "types/time_off_policies_add_employees_request_employees_item"
+require_relative "types/time_off_policies_remove_employees_request_employees_item"
+require_relative "types/time_off_policies_update_balance_request_employees_item"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../requests"
+
+module Gusto
+  class TimeOffPoliciesClient
+  # @return [Gusto::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::TimeOffPoliciesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Returns a list of accruing time off for each time off policy associated with the
+#  employee.
+#  Factors affecting the accrued hours:
+#  - the time off policy accrual method (whether they get pay per hour worked, per
+#  hour paid, with / without overtime, accumulate time off based on pay period /
+#  calendar year / anniversary)
+#  - how many hours of work during this pay period
+#  - how many hours of PTO / sick hours taken during this pay period (for per hour
+#  paid policies only)
+#  - company pay schedule frequency (for per pay period)
+#  If none of the parameters is passed in, the accrued time off hour will be 0.
+#  scope: `payrolls:read`
+    #
+    # @param payroll_id [String] The UUID of the payroll
+    # @param employee_id [String] The UUID of the employee
+    # @param regular_hours_worked [Float] regular hours worked in this pay period
+    # @param overtime_hours_worked [Float] overtime hours worked in this pay period
+    # @param double_overtime_hours_worked [Float] double overtime hours worked in this pay period
+    # @param pto_hours_used [Float] paid time off hours used in this pay period
+    # @param sick_hours_used [Float] sick hours used in this pay period
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::AccruingTimeOffHour>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.calculate_accruing_time_off_hours(
+#    payroll_id: "payroll_id",
+#    employee_id: "employee_id",
+#    regular_hours_worked: 30.25,
+#    overtime_hours_worked: 10,
+#    double_overtime_hours_worked: 0,
+#    pto_hours_used: 5.5,
+#    sick_hours_used: 0
+#  )
+    def calculate_accruing_time_off_hours(payroll_id:, employee_id:, regular_hours_worked: nil, overtime_hours_worked: nil, double_overtime_hours_worked: nil, pto_hours_used: nil, sick_hours_used: 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 || {}), regular_hours_worked: regular_hours_worked, overtime_hours_worked: overtime_hours_worked, double_overtime_hours_worked: double_overtime_hours_worked, pto_hours_used: pto_hours_used, sick_hours_used: sick_hours_used }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/payrolls/#{payroll_id}/employees/#{employee_id}/calculate_accruing_time_off_hours"
+end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do | item |
+        item = item.to_json
+        Gusto::AccruingTimeOffHour.from_json(json_object: item)
+      end
+    end
+# Get a time off policy
+#  scope: `time_off_policies:read`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.get(time_off_policy_uuid: "time_off_policy_uuid")
+    def get(time_off_policy_uuid:, 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/time_off_policies/#{time_off_policy_uuid}"
+end
+      Gusto::TimeOffPolicy.from_json(json_object: response.body)
+    end
+# Update a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param name [String] Name of the time off policy
+    # @param accrual_method [Gusto::TimeOffPolicies::TimeOffPoliciesUpdateRequestAccrualMethod] Accrual method of the time off policy
+    # @param accrual_rate [String] The rate at which the time off hours will accrue for an employee on the policy.
+#  Represented as a float, e.g. "40.0".
+    # @param accrual_rate_unit [String] The number of hours an employee has to work or be paid for to accrue the number
+#  of hours set in the accrual rate. Only used for hourly policies (per_hour_paid,
+#  per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime).
+#  Represented as a float, e.g. "40.0".
+    # @param paid_out_on_termination [Boolean] Boolean representing if an employees accrued time off hours will be paid out on
+#  termination
+    # @param accrual_waiting_period_days [Integer] Number of days before an employee on the policy will begin accruing time off
+#  hours. If accrual_method is per_anniversary_year, per_calendar_year, or
+#  unlimited, then accrual_waiting_period_days should be 0.
+    # @param carryover_limit_hours [String] The max number of hours and employee can carryover from one year to the next. If
+#  accrual_method is unlimited, then carryover_limit_hours must be blank.
+    # @param max_accrual_hours_per_year [String] The max number of hours and employee can accrue in a year. If accrual_method is
+#  unlimited, then max_accrual_hours_per_year must be blank.
+    # @param max_hours [String] The max number of hours an employee can accrue. If accrual_method is unlimited,
+#  then max_hours must be blank.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.update(
+#    time_off_policy_uuid: "time_off_policy_uuid",
+#    name: "Hourly Vacation Policy",
+#    accrual_method: PER_HOUR_PAID,
+#    accrual_rate: "4.0",
+#    accrual_rate_unit: "80.0",
+#    paid_out_on_termination: true,
+#    accrual_waiting_period_days: 30,
+#    carryover_limit_hours: "200.0",
+#    max_accrual_hours_per_year: "120.0",
+#    max_hours: "240.0"
+#  )
+    def update(time_off_policy_uuid:, name: nil, accrual_method: nil, accrual_rate: nil, accrual_rate_unit: nil, paid_out_on_termination: nil, accrual_waiting_period_days: nil, carryover_limit_hours: nil, max_accrual_hours_per_year: nil, max_hours: 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 || {}), name: name, accrual_method: accrual_method, accrual_rate: accrual_rate, accrual_rate_unit: accrual_rate_unit, paid_out_on_termination: paid_out_on_termination, accrual_waiting_period_days: accrual_waiting_period_days, carryover_limit_hours: carryover_limit_hours, max_accrual_hours_per_year: max_accrual_hours_per_year, max_hours: max_hours }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/time_off_policies/#{time_off_policy_uuid}"
+end
+      Gusto::TimeOffPolicy.from_json(json_object: response.body)
+    end
+# Get all time off policies for a company
+#  scope: `time_off_policies:read`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::TimeOffPolicy>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.list(company_uuid: "company_uuid")
+    def list(company_uuid:, 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/companies/#{company_uuid}/time_off_policies"
+end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do | item |
+        item = item.to_json
+        Gusto::TimeOffPolicy.from_json(json_object: item)
+      end
+    end
+# Create a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param name [String] Name of the time off policy
+    # @param policy_type [String] Type of the time off policy. Currently only "vacation" and "sick" are supported
+    # @param accrual_method [Gusto::TimeOffPolicies::TimeOffPoliciesCreateRequestAccrualMethod] Accrual method of the time off policy
+    # @param accrual_rate [String] The rate at which the time off hours will accrue for an employee on the policy.
+#  Represented as a float, e.g. "40.0".
+    # @param accrual_rate_unit [String] The number of hours an employee has to work or be paid for to accrue the number
+#  of hours set in the accrual rate. Only used for hourly policies (per_hour_paid,
+#  per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime).
+#  Represented as a float, e.g. "40.0".
+    # @param paid_out_on_termination [Boolean] Boolean representing if an employees accrued time off hours will be paid out on
+#  termination
+    # @param accrual_waiting_period_days [Integer] Number of days before an employee on the policy will begin accruing time off
+#  hours. If accrual_method is per_anniversary_year, per_calendar_year, or
+#  unlimited, then accrual_waiting_period_days should be 0.
+    # @param carryover_limit_hours [String] The max number of hours and employee can carryover from one year to the next. If
+#  accrual_method is unlimited, then carryover_limit_hours must be blank.
+    # @param max_accrual_hours_per_year [String] The max number of hours and employee can accrue in a year. If accrual_method is
+#  unlimited, then max_accrual_hours_per_year must be blank.
+    # @param max_hours [String] The max number of hours an employee can accrue. If accrual_method is unlimited,
+#  then max_hours must be blank.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.create(
+#    company_uuid: "company_uuid",
+#    name: "Unlimited Vacation Policy",
+#    policy_type: "vacation",
+#    accrual_method: UNLIMITED
+#  )
+    def create(company_uuid:, name:, policy_type:, accrual_method:, accrual_rate: nil, accrual_rate_unit: nil, paid_out_on_termination: nil, accrual_waiting_period_days: nil, carryover_limit_hours: nil, max_accrual_hours_per_year: nil, max_hours: 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 || {}), name: name, policy_type: policy_type, accrual_method: accrual_method, accrual_rate: accrual_rate, accrual_rate_unit: accrual_rate_unit, paid_out_on_termination: paid_out_on_termination, accrual_waiting_period_days: accrual_waiting_period_days, carryover_limit_hours: carryover_limit_hours, max_accrual_hours_per_year: max_accrual_hours_per_year, max_hours: max_hours }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/time_off_policies"
+end
+      Gusto::TimeOffPolicy.from_json(json_object: response.body)
+    end
+# Add employees to a time off policy. Employees are required to have at least one
+#  job to be added to a time off policy. Accepts starting balances for
+#  non-unlimited policies
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param employees [Array<Hash>] Request of type Array<Gusto::TimeOffPolicies::TimeOffPoliciesAddEmployeesRequestEmployeesItem>, as a Hash
+    #   * :uuid (String) 
+    #   * :balance (String) 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.add_employees(time_off_policy_uuid: "time_off_policy_uuid")
+    def add_employees(time_off_policy_uuid:, employees: 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 || {}), employees: employees }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/time_off_policies/#{time_off_policy_uuid}/add_employees"
+end
+      Gusto::TimeOffPolicy.from_json(json_object: response.body)
+    end
+# Remove employees from a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param employees [Array<Hash>] Request of type Array<Gusto::TimeOffPolicies::TimeOffPoliciesRemoveEmployeesRequestEmployeesItem>, as a Hash
+    #   * :uuid (String) 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.remove_employees(time_off_policy_uuid: "time_off_policy_uuid")
+    def remove_employees(time_off_policy_uuid:, employees: 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 || {}), employees: employees }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/time_off_policies/#{time_off_policy_uuid}/remove_employees"
+end
+      Gusto::TimeOffPolicy.from_json(json_object: response.body)
+    end
+# Updates time off hours balances for employees for a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param employees [Array<Hash>] Request of type Array<Gusto::TimeOffPolicies::TimeOffPoliciesUpdateBalanceRequestEmployeesItem>, as a Hash
+    #   * :uuid (String) 
+    #   * :balance (String) 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.update_balance(time_off_policy_uuid: "time_off_policy_uuid")
+    def update_balance(time_off_policy_uuid:, employees: 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 || {}), employees: employees }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/time_off_policies/#{time_off_policy_uuid}/balance"
+end
+      Gusto::TimeOffPolicy.from_json(json_object: response.body)
+    end
+# Deactivate a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.deactivate(time_off_policy_uuid: "time_off_policy_uuid")
+    def deactivate(time_off_policy_uuid:, 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
+  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/time_off_policies/#{time_off_policy_uuid}/deactivate"
+end
+      Gusto::TimeOffPolicy.from_json(json_object: response.body)
+    end
+  end
+  class AsyncTimeOffPoliciesClient
+  # @return [Gusto::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AsyncTimeOffPoliciesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Returns a list of accruing time off for each time off policy associated with the
+#  employee.
+#  Factors affecting the accrued hours:
+#  - the time off policy accrual method (whether they get pay per hour worked, per
+#  hour paid, with / without overtime, accumulate time off based on pay period /
+#  calendar year / anniversary)
+#  - how many hours of work during this pay period
+#  - how many hours of PTO / sick hours taken during this pay period (for per hour
+#  paid policies only)
+#  - company pay schedule frequency (for per pay period)
+#  If none of the parameters is passed in, the accrued time off hour will be 0.
+#  scope: `payrolls:read`
+    #
+    # @param payroll_id [String] The UUID of the payroll
+    # @param employee_id [String] The UUID of the employee
+    # @param regular_hours_worked [Float] regular hours worked in this pay period
+    # @param overtime_hours_worked [Float] overtime hours worked in this pay period
+    # @param double_overtime_hours_worked [Float] double overtime hours worked in this pay period
+    # @param pto_hours_used [Float] paid time off hours used in this pay period
+    # @param sick_hours_used [Float] sick hours used in this pay period
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::AccruingTimeOffHour>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.calculate_accruing_time_off_hours(
+#    payroll_id: "payroll_id",
+#    employee_id: "employee_id",
+#    regular_hours_worked: 30.25,
+#    overtime_hours_worked: 10,
+#    double_overtime_hours_worked: 0,
+#    pto_hours_used: 5.5,
+#    sick_hours_used: 0
+#  )
+    def calculate_accruing_time_off_hours(payroll_id:, employee_id:, regular_hours_worked: nil, overtime_hours_worked: nil, double_overtime_hours_worked: nil, pto_hours_used: nil, sick_hours_used: 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 || {}), regular_hours_worked: regular_hours_worked, overtime_hours_worked: overtime_hours_worked, double_overtime_hours_worked: double_overtime_hours_worked, pto_hours_used: pto_hours_used, sick_hours_used: sick_hours_used }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/payrolls/#{payroll_id}/employees/#{employee_id}/calculate_accruing_time_off_hours"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::AccruingTimeOffHour.from_json(json_object: item)
+        end
+      end
+    end
+# Get a time off policy
+#  scope: `time_off_policies:read`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.get(time_off_policy_uuid: "time_off_policy_uuid")
+    def get(time_off_policy_uuid:, 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/time_off_policies/#{time_off_policy_uuid}"
+end
+        Gusto::TimeOffPolicy.from_json(json_object: response.body)
+      end
+    end
+# Update a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param name [String] Name of the time off policy
+    # @param accrual_method [Gusto::TimeOffPolicies::TimeOffPoliciesUpdateRequestAccrualMethod] Accrual method of the time off policy
+    # @param accrual_rate [String] The rate at which the time off hours will accrue for an employee on the policy.
+#  Represented as a float, e.g. "40.0".
+    # @param accrual_rate_unit [String] The number of hours an employee has to work or be paid for to accrue the number
+#  of hours set in the accrual rate. Only used for hourly policies (per_hour_paid,
+#  per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime).
+#  Represented as a float, e.g. "40.0".
+    # @param paid_out_on_termination [Boolean] Boolean representing if an employees accrued time off hours will be paid out on
+#  termination
+    # @param accrual_waiting_period_days [Integer] Number of days before an employee on the policy will begin accruing time off
+#  hours. If accrual_method is per_anniversary_year, per_calendar_year, or
+#  unlimited, then accrual_waiting_period_days should be 0.
+    # @param carryover_limit_hours [String] The max number of hours and employee can carryover from one year to the next. If
+#  accrual_method is unlimited, then carryover_limit_hours must be blank.
+    # @param max_accrual_hours_per_year [String] The max number of hours and employee can accrue in a year. If accrual_method is
+#  unlimited, then max_accrual_hours_per_year must be blank.
+    # @param max_hours [String] The max number of hours an employee can accrue. If accrual_method is unlimited,
+#  then max_hours must be blank.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.update(
+#    time_off_policy_uuid: "time_off_policy_uuid",
+#    name: "Hourly Vacation Policy",
+#    accrual_method: PER_HOUR_PAID,
+#    accrual_rate: "4.0",
+#    accrual_rate_unit: "80.0",
+#    paid_out_on_termination: true,
+#    accrual_waiting_period_days: 30,
+#    carryover_limit_hours: "200.0",
+#    max_accrual_hours_per_year: "120.0",
+#    max_hours: "240.0"
+#  )
+    def update(time_off_policy_uuid:, name: nil, accrual_method: nil, accrual_rate: nil, accrual_rate_unit: nil, paid_out_on_termination: nil, accrual_waiting_period_days: nil, carryover_limit_hours: nil, max_accrual_hours_per_year: nil, max_hours: 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 || {}), name: name, accrual_method: accrual_method, accrual_rate: accrual_rate, accrual_rate_unit: accrual_rate_unit, paid_out_on_termination: paid_out_on_termination, accrual_waiting_period_days: accrual_waiting_period_days, carryover_limit_hours: carryover_limit_hours, max_accrual_hours_per_year: max_accrual_hours_per_year, max_hours: max_hours }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/time_off_policies/#{time_off_policy_uuid}"
+end
+        Gusto::TimeOffPolicy.from_json(json_object: response.body)
+      end
+    end
+# Get all time off policies for a company
+#  scope: `time_off_policies:read`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::TimeOffPolicy>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.list(company_uuid: "company_uuid")
+    def list(company_uuid:, 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/companies/#{company_uuid}/time_off_policies"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::TimeOffPolicy.from_json(json_object: item)
+        end
+      end
+    end
+# Create a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param name [String] Name of the time off policy
+    # @param policy_type [String] Type of the time off policy. Currently only "vacation" and "sick" are supported
+    # @param accrual_method [Gusto::TimeOffPolicies::TimeOffPoliciesCreateRequestAccrualMethod] Accrual method of the time off policy
+    # @param accrual_rate [String] The rate at which the time off hours will accrue for an employee on the policy.
+#  Represented as a float, e.g. "40.0".
+    # @param accrual_rate_unit [String] The number of hours an employee has to work or be paid for to accrue the number
+#  of hours set in the accrual rate. Only used for hourly policies (per_hour_paid,
+#  per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime).
+#  Represented as a float, e.g. "40.0".
+    # @param paid_out_on_termination [Boolean] Boolean representing if an employees accrued time off hours will be paid out on
+#  termination
+    # @param accrual_waiting_period_days [Integer] Number of days before an employee on the policy will begin accruing time off
+#  hours. If accrual_method is per_anniversary_year, per_calendar_year, or
+#  unlimited, then accrual_waiting_period_days should be 0.
+    # @param carryover_limit_hours [String] The max number of hours and employee can carryover from one year to the next. If
+#  accrual_method is unlimited, then carryover_limit_hours must be blank.
+    # @param max_accrual_hours_per_year [String] The max number of hours and employee can accrue in a year. If accrual_method is
+#  unlimited, then max_accrual_hours_per_year must be blank.
+    # @param max_hours [String] The max number of hours an employee can accrue. If accrual_method is unlimited,
+#  then max_hours must be blank.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.create(
+#    company_uuid: "company_uuid",
+#    name: "Unlimited Vacation Policy",
+#    policy_type: "vacation",
+#    accrual_method: UNLIMITED
+#  )
+    def create(company_uuid:, name:, policy_type:, accrual_method:, accrual_rate: nil, accrual_rate_unit: nil, paid_out_on_termination: nil, accrual_waiting_period_days: nil, carryover_limit_hours: nil, max_accrual_hours_per_year: nil, max_hours: 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 || {}), name: name, policy_type: policy_type, accrual_method: accrual_method, accrual_rate: accrual_rate, accrual_rate_unit: accrual_rate_unit, paid_out_on_termination: paid_out_on_termination, accrual_waiting_period_days: accrual_waiting_period_days, carryover_limit_hours: carryover_limit_hours, max_accrual_hours_per_year: max_accrual_hours_per_year, max_hours: max_hours }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/time_off_policies"
+end
+        Gusto::TimeOffPolicy.from_json(json_object: response.body)
+      end
+    end
+# Add employees to a time off policy. Employees are required to have at least one
+#  job to be added to a time off policy. Accepts starting balances for
+#  non-unlimited policies
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param employees [Array<Hash>] Request of type Array<Gusto::TimeOffPolicies::TimeOffPoliciesAddEmployeesRequestEmployeesItem>, as a Hash
+    #   * :uuid (String) 
+    #   * :balance (String) 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.add_employees(time_off_policy_uuid: "time_off_policy_uuid")
+    def add_employees(time_off_policy_uuid:, employees: 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 || {}), employees: employees }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/time_off_policies/#{time_off_policy_uuid}/add_employees"
+end
+        Gusto::TimeOffPolicy.from_json(json_object: response.body)
+      end
+    end
+# Remove employees from a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param employees [Array<Hash>] Request of type Array<Gusto::TimeOffPolicies::TimeOffPoliciesRemoveEmployeesRequestEmployeesItem>, as a Hash
+    #   * :uuid (String) 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.remove_employees(time_off_policy_uuid: "time_off_policy_uuid")
+    def remove_employees(time_off_policy_uuid:, employees: 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 || {}), employees: employees }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/time_off_policies/#{time_off_policy_uuid}/remove_employees"
+end
+        Gusto::TimeOffPolicy.from_json(json_object: response.body)
+      end
+    end
+# Updates time off hours balances for employees for a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param employees [Array<Hash>] Request of type Array<Gusto::TimeOffPolicies::TimeOffPoliciesUpdateBalanceRequestEmployeesItem>, as a Hash
+    #   * :uuid (String) 
+    #   * :balance (String) 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.update_balance(time_off_policy_uuid: "time_off_policy_uuid")
+    def update_balance(time_off_policy_uuid:, employees: 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 || {}), employees: employees }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/time_off_policies/#{time_off_policy_uuid}/balance"
+end
+        Gusto::TimeOffPolicy.from_json(json_object: response.body)
+      end
+    end
+# Deactivate a time off policy
+#  scope: `time_off_policies:write`
+    #
+    # @param time_off_policy_uuid [String] The UUID of the company time off policy
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::TimeOffPolicy]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.time_off_policies.deactivate(time_off_policy_uuid: "time_off_policy_uuid")
+    def deactivate(time_off_policy_uuid:, 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
+  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/time_off_policies/#{time_off_policy_uuid}/deactivate"
+end
+        Gusto::TimeOffPolicy.from_json(json_object: response.body)
+      end
+    end
+  end
+end