fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/companies/benefits/client.rb

@@ -0,0 +1,862 @@
+# frozen_string_literal: true
+require_relative "../../../requests"
+require_relative "../../types/supported_benefit"
+require "json"
+require_relative "../../types/company_benefit"
+require_relative "../../company_benefits/types/benefit_summary"
+require_relative "../../types/employee_benefit"
+require_relative "../../types/employee_benefit_for_company_benefit"
+require_relative "../../company_benefits/types/benefit_type_requirements"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../../requests"
+
+module Gusto
+  module Companies
+    class BenefitsClient
+    # @return [Gusto::RequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::BenefitsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Returns all benefits supported by Gusto.
+#  The benefit object in Gusto contains high level information about a particular
+#  benefit type and its tax considerations. When companies choose to offer a
+#  benefit, they are creating a Company Benefit object associated with a particular
+#  benefit.
+#  scope: `benefits:read`
+      #
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::SupportedBenefit>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.list
+      def list(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/benefits"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::SupportedBenefit.from_json(json_object: item)
+        end
+      end
+# Company benefits represent the benefits that a company is offering to employees.
+#  This ties together a particular supported benefit with the company-specific
+#  information for the offering of that benefit.
+#  Note that company benefits can be deactivated only when no employees are
+#  enrolled.
+#  scope: `company_benefits:write`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param benefit_type [Float] The ID of the benefit to which the company benefit belongs.
+      # @param active [Boolean] Whether this benefit is active for employee participation.
+      # @param description [String] The description of the company benefit.For example, a company may offer multiple
+#  benefits with an ID of 1 (for Medical Insurance). The description would show
+#  something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”.
+      # @param responsible_for_employer_taxes [Boolean] Whether the employer is subject to pay employer taxes when an employee is on
+#  leave. Only applicable to third party sick pay benefits.
+      # @param responsible_for_employee_w2 [Boolean] Whether the employer is subject to file W-2 forms for an employee on leave. Only
+#  applicable to third party sick pay benefits.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBenefit]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.create(company_id: "company_id", description: "description")
+      def create(company_id:, benefit_type: nil, active: nil, description:, responsible_for_employer_taxes: nil, responsible_for_employee_w2: 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 || {}), benefit_type: benefit_type, active: active, description: description, responsible_for_employer_taxes: responsible_for_employer_taxes, responsible_for_employee_w2: responsible_for_employee_w2 }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/company_benefits"
+end
+        Gusto::CompanyBenefit.from_json(json_object: response.body)
+      end
+# Returns a benefit supported by Gusto.
+#  The benefit object in Gusto contains high level information about a particular
+#  benefit type and its tax considerations. When companies choose to offer a
+#  benefit, they are creating a Company Benefit object associated with a particular
+#  benefit.
+#  scope: `benefits:read`
+      #
+      # @param benefit_id [String] The benefit type in Gusto.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::SupportedBenefit]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.get(benefit_id: "benefit_id")
+      def get(benefit_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/benefits/#{benefit_id}"
+end
+        Gusto::SupportedBenefit.from_json(json_object: response.body)
+      end
+# Company benefits represent the benefits that a company is offering to employees.
+#  This ties together a particular supported benefit with the company-specific
+#  information for the offering of that benefit.
+#  Note that company benefits can be deactivated only when no employees are
+#  enrolled.
+#  scope: `company_benefits:write`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @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 active [Boolean] Whether this benefit is active for employee participation. Company benefits may
+#  only be deactivated if no employees are actively participating.
+      # @param description [String] The description of the company benefit.For example, a company may offer multiple
+#  benefits with an ID of 1 (for Medical Insurance). The description would show
+#  something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBenefit]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.update(
+#    company_benefit_id: "company_benefit_id",
+#    version: "98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872",
+#    active: false
+#  )
+      def update(company_benefit_id:, version:, active: nil, description: 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, active: active, description: description }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/company_benefits/#{company_benefit_id}"
+end
+        Gusto::CompanyBenefit.from_json(json_object: response.body)
+      end
+# The following must be true in order to delete a company benefit
+#  - There are no employee benefits associated with the company benefit
+#  - There are no payroll items associated with the company benefit
+#  - The benefit is not managed by a Partner or by Gusto (type must be 'External')
+#  scope: `company_benefits:write`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @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.companies.benefits.delete(company_benefit_id: "company_benefit_id")
+      def delete(company_benefit_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/company_benefits/#{company_benefit_id}"
+end
+      end
+# Returns summary benefit data for the requested company benefit id.
+#  Benefits containing PHI are only visible to applications with the
+#  `company_benefits:read:phi` scope.
+#  scope: `company_benefits:read`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @param start_date [String] The start date for which to retrieve company benefit summary
+      # @param end_date [String] The end date for which to retrieve company benefit summary. If left empty,
+#  defaults to today's date.
+      # @param detailed [Boolean] Display employee payroll item summary
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBenefits::BenefitSummary]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.get_summary(
+#    company_benefit_id: "company_benefit_id",
+#    start_date: "2022-01-01",
+#    end_date: "2022-12-31"
+#  )
+      def get_summary(company_benefit_id:, start_date: nil, end_date: nil, detailed: 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 || {}), "start_date": start_date, "end_date": end_date, "detailed": detailed }.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/company_benefits/#{company_benefit_id}/summary"
+end
+        Gusto::CompanyBenefits::BenefitSummary.from_json(json_object: response.body)
+      end
+# Employee benefits represent an employee enrolled in a particular company
+#  benefit. It includes information specific to that employee’s enrollment.
+#  Returns an array of all employee benefits enrolled for this company benefit.
+#  Benefits containing PHI are only visible to applications with the
+#  `employee_benefits:read:phi` scope.
+#  scope: `employee_benefits:read`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @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::EmployeeBenefit>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.list_employee_benefits(company_benefit_id: "company_benefit_id")
+      def list_employee_benefits(company_benefit_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/company_benefits/#{company_benefit_id}/employee_benefits"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::EmployeeBenefit.from_json(json_object: item)
+        end
+      end
+# Employee benefits represent an employee enrolled in a particular company
+#  benefit. It includes information specific to that employee’s enrollment.
+#  Create or update(if the employee is already enrolled in the company benefit
+#  previously) an employee benefit for the company benefit.
+#  Benefits containing PHI are only visible to applications with the
+#  `employee_benefits:read:phi` scope.
+#  scope: `employee_benefits:write`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @param employee_benefits [Array<Hash>] The list of employee benefits to create or updateRequest of type Array<Gusto::EmployeeBenefitForCompanyBenefit>, as a Hash
+      #   * :employee_uuid (String) 
+      #   * :company_benefit_uuid (String) 
+      #   * :uuid (String) 
+      #   * :version (String) 
+      #   * :active (Boolean) 
+      #   * :employee_deduction (String) 
+      #   * :deduct_as_percentage (Boolean) 
+      #   * :employee_deduction_annual_maximum (String) 
+      #   * :contribution (Hash)
+      #     * :type (String) 
+      #     * :value (Hash)
+      #   * :elective (Boolean) 
+      #   * :company_contribution_annual_maximum (String) 
+      #   * :limit_option (String) 
+      #   * :catch_up (Boolean) 
+      #   * :retirement_loan_identifier (String) 
+      #   * :coverage_amount (String) 
+      #   * :deduction_reduces_taxable_income (Gusto::EmployeeBenefitBaseObjectDeductionReducesTaxableIncome) 
+      #   * :coverage_salary_multiplier (String) 
+      #   * :company_contribution (String) 
+      #   * :contribute_as_percentage (Boolean) 
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::EmployeeBenefit>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.update_employee_benefits(company_benefit_id: "company_benefit_id", employee_benefits: [{ version: "09j3d29jqdpj92109j9j2d90dq", active: true, employee_deduction: "250.00", employee_uuid: "8f9f3f68-8fd3-499d-ade7-4a052e56494e" }])
+      def update_employee_benefits(company_benefit_id:, employee_benefits: 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 || {}), employee_benefits: employee_benefits }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/company_benefits/#{company_benefit_id}/employee_benefits"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::EmployeeBenefit.from_json(json_object: item)
+        end
+      end
+# Returns field requirements for the requested benefit type.
+#  scope: `benefits:read`
+      #
+      # @param benefit_id [String] The benefit type in Gusto.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBenefits::BenefitTypeRequirements]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.get_requirements(benefit_id: "benefit_id")
+      def get_requirements(benefit_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/benefits/#{benefit_id}/requirements"
+end
+        Gusto::CompanyBenefits::BenefitTypeRequirements.from_json(json_object: response.body)
+      end
+    end
+    class AsyncBenefitsClient
+    # @return [Gusto::AsyncRequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::AsyncBenefitsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Returns all benefits supported by Gusto.
+#  The benefit object in Gusto contains high level information about a particular
+#  benefit type and its tax considerations. When companies choose to offer a
+#  benefit, they are creating a Company Benefit object associated with a particular
+#  benefit.
+#  scope: `benefits:read`
+      #
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::SupportedBenefit>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.list
+      def list(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/benefits"
+end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do | item |
+            item = item.to_json
+            Gusto::SupportedBenefit.from_json(json_object: item)
+          end
+        end
+      end
+# Company benefits represent the benefits that a company is offering to employees.
+#  This ties together a particular supported benefit with the company-specific
+#  information for the offering of that benefit.
+#  Note that company benefits can be deactivated only when no employees are
+#  enrolled.
+#  scope: `company_benefits:write`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param benefit_type [Float] The ID of the benefit to which the company benefit belongs.
+      # @param active [Boolean] Whether this benefit is active for employee participation.
+      # @param description [String] The description of the company benefit.For example, a company may offer multiple
+#  benefits with an ID of 1 (for Medical Insurance). The description would show
+#  something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”.
+      # @param responsible_for_employer_taxes [Boolean] Whether the employer is subject to pay employer taxes when an employee is on
+#  leave. Only applicable to third party sick pay benefits.
+      # @param responsible_for_employee_w2 [Boolean] Whether the employer is subject to file W-2 forms for an employee on leave. Only
+#  applicable to third party sick pay benefits.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBenefit]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.create(company_id: "company_id", description: "description")
+      def create(company_id:, benefit_type: nil, active: nil, description:, responsible_for_employer_taxes: nil, responsible_for_employee_w2: 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 || {}), benefit_type: benefit_type, active: active, description: description, responsible_for_employer_taxes: responsible_for_employer_taxes, responsible_for_employee_w2: responsible_for_employee_w2 }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/company_benefits"
+end
+          Gusto::CompanyBenefit.from_json(json_object: response.body)
+        end
+      end
+# Returns a benefit supported by Gusto.
+#  The benefit object in Gusto contains high level information about a particular
+#  benefit type and its tax considerations. When companies choose to offer a
+#  benefit, they are creating a Company Benefit object associated with a particular
+#  benefit.
+#  scope: `benefits:read`
+      #
+      # @param benefit_id [String] The benefit type in Gusto.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::SupportedBenefit]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.get(benefit_id: "benefit_id")
+      def get(benefit_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/benefits/#{benefit_id}"
+end
+          Gusto::SupportedBenefit.from_json(json_object: response.body)
+        end
+      end
+# Company benefits represent the benefits that a company is offering to employees.
+#  This ties together a particular supported benefit with the company-specific
+#  information for the offering of that benefit.
+#  Note that company benefits can be deactivated only when no employees are
+#  enrolled.
+#  scope: `company_benefits:write`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @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 active [Boolean] Whether this benefit is active for employee participation. Company benefits may
+#  only be deactivated if no employees are actively participating.
+      # @param description [String] The description of the company benefit.For example, a company may offer multiple
+#  benefits with an ID of 1 (for Medical Insurance). The description would show
+#  something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBenefit]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.update(
+#    company_benefit_id: "company_benefit_id",
+#    version: "98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872",
+#    active: false
+#  )
+      def update(company_benefit_id:, version:, active: nil, description: 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, active: active, description: description }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/company_benefits/#{company_benefit_id}"
+end
+          Gusto::CompanyBenefit.from_json(json_object: response.body)
+        end
+      end
+# The following must be true in order to delete a company benefit
+#  - There are no employee benefits associated with the company benefit
+#  - There are no payroll items associated with the company benefit
+#  - The benefit is not managed by a Partner or by Gusto (type must be 'External')
+#  scope: `company_benefits:write`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @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.companies.benefits.delete(company_benefit_id: "company_benefit_id")
+      def delete(company_benefit_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/company_benefits/#{company_benefit_id}"
+end
+        end
+      end
+# Returns summary benefit data for the requested company benefit id.
+#  Benefits containing PHI are only visible to applications with the
+#  `company_benefits:read:phi` scope.
+#  scope: `company_benefits:read`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @param start_date [String] The start date for which to retrieve company benefit summary
+      # @param end_date [String] The end date for which to retrieve company benefit summary. If left empty,
+#  defaults to today's date.
+      # @param detailed [Boolean] Display employee payroll item summary
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBenefits::BenefitSummary]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.get_summary(
+#    company_benefit_id: "company_benefit_id",
+#    start_date: "2022-01-01",
+#    end_date: "2022-12-31"
+#  )
+      def get_summary(company_benefit_id:, start_date: nil, end_date: nil, detailed: 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 || {}), "start_date": start_date, "end_date": end_date, "detailed": detailed }.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/company_benefits/#{company_benefit_id}/summary"
+end
+          Gusto::CompanyBenefits::BenefitSummary.from_json(json_object: response.body)
+        end
+      end
+# Employee benefits represent an employee enrolled in a particular company
+#  benefit. It includes information specific to that employee’s enrollment.
+#  Returns an array of all employee benefits enrolled for this company benefit.
+#  Benefits containing PHI are only visible to applications with the
+#  `employee_benefits:read:phi` scope.
+#  scope: `employee_benefits:read`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @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::EmployeeBenefit>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.list_employee_benefits(company_benefit_id: "company_benefit_id")
+      def list_employee_benefits(company_benefit_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/company_benefits/#{company_benefit_id}/employee_benefits"
+end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do | item |
+            item = item.to_json
+            Gusto::EmployeeBenefit.from_json(json_object: item)
+          end
+        end
+      end
+# Employee benefits represent an employee enrolled in a particular company
+#  benefit. It includes information specific to that employee’s enrollment.
+#  Create or update(if the employee is already enrolled in the company benefit
+#  previously) an employee benefit for the company benefit.
+#  Benefits containing PHI are only visible to applications with the
+#  `employee_benefits:read:phi` scope.
+#  scope: `employee_benefits:write`
+      #
+      # @param company_benefit_id [String] The UUID of the company benefit
+      # @param employee_benefits [Array<Hash>] The list of employee benefits to create or updateRequest of type Array<Gusto::EmployeeBenefitForCompanyBenefit>, as a Hash
+      #   * :employee_uuid (String) 
+      #   * :company_benefit_uuid (String) 
+      #   * :uuid (String) 
+      #   * :version (String) 
+      #   * :active (Boolean) 
+      #   * :employee_deduction (String) 
+      #   * :deduct_as_percentage (Boolean) 
+      #   * :employee_deduction_annual_maximum (String) 
+      #   * :contribution (Hash)
+      #     * :type (String) 
+      #     * :value (Hash)
+      #   * :elective (Boolean) 
+      #   * :company_contribution_annual_maximum (String) 
+      #   * :limit_option (String) 
+      #   * :catch_up (Boolean) 
+      #   * :retirement_loan_identifier (String) 
+      #   * :coverage_amount (String) 
+      #   * :deduction_reduces_taxable_income (Gusto::EmployeeBenefitBaseObjectDeductionReducesTaxableIncome) 
+      #   * :coverage_salary_multiplier (String) 
+      #   * :company_contribution (String) 
+      #   * :contribute_as_percentage (Boolean) 
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::EmployeeBenefit>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.update_employee_benefits(company_benefit_id: "company_benefit_id", employee_benefits: [{ version: "09j3d29jqdpj92109j9j2d90dq", active: true, employee_deduction: "250.00", employee_uuid: "8f9f3f68-8fd3-499d-ade7-4a052e56494e" }])
+      def update_employee_benefits(company_benefit_id:, employee_benefits: 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 || {}), employee_benefits: employee_benefits }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/company_benefits/#{company_benefit_id}/employee_benefits"
+end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do | item |
+            item = item.to_json
+            Gusto::EmployeeBenefit.from_json(json_object: item)
+          end
+        end
+      end
+# Returns field requirements for the requested benefit type.
+#  scope: `benefits:read`
+      #
+      # @param benefit_id [String] The benefit type in Gusto.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBenefits::BenefitTypeRequirements]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.benefits.get_requirements(benefit_id: "benefit_id")
+      def get_requirements(benefit_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/benefits/#{benefit_id}/requirements"
+end
+          Gusto::CompanyBenefits::BenefitTypeRequirements.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end