fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/contractors/client.rb

@@ -0,0 +1,1025 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "payment_method/client"
+require_relative "forms/client"
+require_relative "documents/client"
+require_relative "payments/client"
+require_relative "payment_groups/client"
+require_relative "types/contractor"
+require "json"
+require_relative "../types/contractor_body"
+require_relative "../types/contractor_body_type"
+require_relative "../types/contractor_body_wage_type"
+require_relative "../contractor/types/contractor_onboarding_info"
+require_relative "../types/contractor_address_info"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../requests"
+
+module Gusto
+  class ContractorsClient
+  # @return [Gusto::RequestClient] 
+    attr_reader :request_client
+  # @return [Gusto::Contractors::PaymentMethodClient] 
+    attr_reader :payment_method
+  # @return [Gusto::Contractors::FormsClient] 
+    attr_reader :forms
+  # @return [Gusto::Contractors::DocumentsClient] 
+    attr_reader :documents
+  # @return [Gusto::Contractors::PaymentsClient] 
+    attr_reader :payments
+  # @return [Gusto::Contractors::PaymentGroupsClient] 
+    attr_reader :payment_groups
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::ContractorsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+      @payment_method = Gusto::Contractors::PaymentMethodClient.new(request_client: request_client)
+      @forms = Gusto::Contractors::FormsClient.new(request_client: request_client)
+      @documents = Gusto::Contractors::DocumentsClient.new(request_client: request_client)
+      @payments = Gusto::Contractors::PaymentsClient.new(request_client: request_client)
+      @payment_groups = Gusto::Contractors::PaymentGroupsClient.new(request_client: request_client)
+    end
+# Get all contractors, active and inactive, individual and business, for a
+#  company.
+#  scope: `contractors:read`
+    #
+    # @param company_id [String] The UUID of the company
+    # @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 search_term [String] A string to search for in the object's names
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::Contractors::Contractor>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.list(company_id: "company_id")
+    def list(company_id:, page: nil, per: nil, search_term: 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, "search_term": search_term }.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/companies/#{company_id}/contractors"
+end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do | item |
+        item = item.to_json
+        Gusto::Contractors::Contractor.from_json(json_object: item)
+      end
+    end
+# Create an individual or business contractor.
+#  scope: `contractors:manage`
+    #
+    # @param company_id [String] The UUID of the company
+    # @param request [Hash] Request of type Gusto::ContractorBody, as a Hash
+    #   * :type (Gusto::ContractorBodyType) 
+    #   * :wage_type (Gusto::ContractorBodyWageType) 
+    #   * :start_date (String) 
+    #   * :hourly_rate (String) 
+    #   * :self_onboarding (Boolean) 
+    #   * :email (String) 
+    #   * :first_name (String) 
+    #   * :last_name (String) 
+    #   * :middle_initial (String) 
+    #   * :file_new_hire_report (Boolean) 
+    #   * :work_state (String) 
+    #   * :ssn (String) 
+    #   * :business_name (String) 
+    #   * :ein (String) 
+    #   * :is_active (Boolean) 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractors::Contractor]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.create(company_id: "company_id", request: { type: INDIVIDUAL, wage_type: FIXED, start_date: "2020-04-01", self_onboarding: true, email: "johnson@johnson.com", first_name: "Johnson", last_name: "Johnson", file_new_hire_report: true, work_state: "CA" })
+    def create(company_id:, request:, 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/contractors"
+end
+      Gusto::Contractors::Contractor.from_json(json_object: response.body)
+    end
+# Get a contractor.
+#  scope: `contractors:read`
+    #
+    # @param contractor_id [String] The UUID of the contractor
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractors::Contractor]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.get(contractor_id: "contractor_id")
+    def get(contractor_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/contractors/#{contractor_id}"
+end
+      Gusto::Contractors::Contractor.from_json(json_object: response.body)
+    end
+# Update a contractor.
+#  scope: `contractors:write`
+#  > 🚧 Warning
+#  >
+#  > Watch out when changing a contractor's type (when the contractor is finished
+#  onboarding). Specifically, changing contractor type can be dangerous since Gusto
+#  won’t recognize and file two separate 1099s if they simply change from business
+#  to individual
+    #
+    # @param contractor_id [String] The UUID of the contractor
+    # @param version [String] The current version of the object. See the [versioning
+#  guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information
+#  on how to use this field.
+    # @param type [Gusto::ContractorBodyType] The contractor type.
+    # @param wage_type [Gusto::ContractorBodyWageType] The contractor’s wage type.
+    # @param start_date [String] The day when the contractor will start working for the company.
+    # @param hourly_rate [String] The contractor’s hourly rate. This attribute is required if the wage_type is
+#  `Hourly`.
+    # @param self_onboarding [Boolean] Whether the contractor or the payroll admin will complete onboarding in Gusto.
+#  Self-onboarding is recommended so that contractors receive Gusto accounts.
+#  If self_onboarding is true, then email is required.
+    # @param email [String] The contractor’s email address.
+    # @param first_name [String] The contractor’s first name.
+#  This attribute is required for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+    # @param last_name [String] The contractor’s last name.
+#  This attribute is required for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+    # @param middle_initial [String] The contractor’s middle initial.
+#  This attribute is optional for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+    # @param file_new_hire_report [Boolean] The boolean flag indicating whether Gusto will file a new hire report for the
+#  contractor.
+#  This attribute is optional for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+    # @param work_state [String] State where the contractor will be conducting the majority of their work for the
+#  company.
+#  This value is used when generating the new hire report.
+#  This attribute is required for `Individual` contractors if
+#  `file_new_hire_report` is true and will be ignored for `Business` contractors.
+    # @param ssn [String] This attribute is optional for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+#  Social security number is needed to file the annual 1099 tax form.
+    # @param business_name [String] The name of the contractor business. This attribute is required for `Business`
+#  contractors and will be ignored for `Individual` contractors.
+    # @param ein [String] The employer identification number of the contractor business.
+#  This attribute is optional for `Business` contractors and will be ignored for
+#  `Individual` contractors.
+    # @param is_active [Boolean] The status of the contractor. If the contractor's start date is in the future,
+#  updating this field to true means we are setting the start date to today.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractors::Contractor]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.update(contractor_id: "contractor_id")
+    def update(contractor_id:, version:, type: nil, wage_type: nil, start_date: nil, hourly_rate: nil, self_onboarding: nil, email: nil, first_name: nil, last_name: nil, middle_initial: nil, file_new_hire_report: nil, work_state: nil, ssn: nil, business_name: nil, ein: nil, is_active: 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, type: type, wage_type: wage_type, start_date: start_date, hourly_rate: hourly_rate, self_onboarding: self_onboarding, email: email, first_name: first_name, last_name: last_name, middle_initial: middle_initial, file_new_hire_report: file_new_hire_report, work_state: work_state, ssn: ssn, business_name: business_name, ein: ein, is_active: is_active }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/contractors/#{contractor_id}"
+end
+      Gusto::Contractors::Contractor.from_json(json_object: response.body)
+    end
+# A contractor can only be deleted when there are no contractor payments.
+#  scope: `contractors:manage`
+    #
+    # @param contractor_id [String] The UUID of the contractor
+    # @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.contractors.delete(contractor_id: "contractor_id")
+    def delete(contractor_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/contractors/#{contractor_id}"
+end
+    end
+# Retrieves a contractor's onboarding status. The data returned helps inform the
+#  required onboarding steps and respective completion status.
+#  scope: `contractors:read`
+#  ## onboarding_status
+#  ### Admin-facilitated onboarding
+#  | onboarding_status             |
+#  Description |
+#  | :---------------------------- |
+#  ------------------------------------------------------------------------: |
+#  | `admin_onboarding_incomplete` |              Admin needs to enter basic
+#  information about the contractor. |
+#  | `admin_onboarding_review`     | All information has been completed and admin
+#  needs to confirm onboarding. |
+#  | `onboarding_completed`        |                         Contractor has been
+#  fully onboarded and verified. |
+#  ### Contractor self-onboarding
+#  | onboarding_status             | Description
+#  |
+#  | ----------------------------- |
+#  --------------------------------------------------------------------------------
+#  |
+#  | `admin_onboarding_incomplete` | Admin needs to enter basic information about
+#  the contractor.
+#  |
+#  | `self_onboarding_not_invited` | Admin has the intention to invite the
+#  contractor to self-onboard (e.g., marking a checkbox), but the system has not
+#  yet sent the invitation. |
+#  | `self_onboarding_invited`     | Contractor has been sent an invitation to
+#  self-onboard.
+#  |
+#  | `self_onboarding_started`     | Contractor has started the self-onboarding
+#  process.
+#  |
+#  | `self_onboarding_review`      | Admin needs to review contractors's entered
+#  information and confirm onboarding.
+#  |
+#  | `onboarding_completed`        | Contractor has been fully onboarded and
+#  verified.
+#  |
+#  ## onboarding_steps
+#  | onboarding_steps       |
+#  Requirement(s) to be completed |
+#  | :--------------------- |
+#  -------------------------------------------------------------------------------:
+#  |
+#  | `basic_details`        | Add individual contractor's first name, last name,
+#  social security number or Business name and EIN depending on the contractor type
+#  |
+#  | `add_address`          |
+#  Add contractor address. |
+#  | `compensation_details` |
+#  Add contractor compensation. |
+#  | `payment_details`      |
+#  Set up contractor's direct deposit or set to check. |
+#  | `sign_documents`       |
+#  Contractor forms (e.g., W9) are generated & signed. |
+#  | `file_new_hire_report` |
+#  Contractor new hire report is generated. |
+    #
+    # @param contractor_uuid [String] The UUID of the contractor
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractor::ContractorOnboardingInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.get_onboarding_status(contractor_uuid: "contractor_uuid")
+    def get_onboarding_status(contractor_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/contractors/#{contractor_uuid}/onboarding_status"
+end
+      Gusto::Contractor::ContractorOnboardingInfo.from_json(json_object: response.body)
+    end
+# Updates a contractor's onboarding status.
+#  scope: `contractors:write`
+#  Below is a list of valid onboarding status changes depending on the intended
+#  action to be performed on behalf of the contractor.
+#  | Action                                    |                   current
+#  onboarding_status                    |         new onboarding_status |
+#  | :---------------------------------------- |
+#  :------------------------------------------------------------: |
+#  ----------------------------: |
+#  | Mark a contractor as self-onboarding      |
+#  `admin_onboarding_incomplete`                  | `self_onboarding_not_invited` |
+#  | Invite a contractor to self-onboard       | `admin_onboarding_incomplete` or
+#  `self_onboarding_not_invited` |     `self_onboarding_invited` |
+#  | Cancel a contractor's self-onboarding     |   `self_onboarding_invited` or
+#  `self_onboarding_not_invited`   | `admin_onboarding_incomplete` |
+#  | Review a contractor's self-onboarded info |
+#  `self_onboarding_started`                    |      `self_onboarding_review` |
+#  | Finish a contractor's onboarding          |   `admin_onboarding_incomplete` or
+#  `self_onboarding_review`    |        `onboarding_completed` |
+    #
+    # @param contractor_uuid [String] The UUID of the contractor
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractor::ContractorOnboardingInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.update_onboarding_status(contractor_uuid: "contractor_uuid")
+    def update_onboarding_status(contractor_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
+  req.body = { **(request_options&.additional_body_parameters || {}), "onboarding_status": "onboarding_completed" }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/contractors/#{contractor_uuid}/onboarding_status"
+end
+      Gusto::Contractor::ContractorOnboardingInfo.from_json(json_object: response.body)
+    end
+# The address of a contractor is used to determine certain tax information about
+#  them. Addresses are geocoded on create and update to ensure validity.
+#  scope: `contractors:read`
+    #
+    # @param contractor_uuid [String] The UUID of the contractor
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::ContractorAddressInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.get_address(contractor_uuid: "contractor_uuid")
+    def get_address(contractor_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/contractors/#{contractor_uuid}/address"
+end
+      Gusto::ContractorAddressInfo.from_json(json_object: response.body)
+    end
+# The address of a contractor is used to determine certain tax information about
+#  them. Addresses are geocoded on create and update to ensure validity.
+#  scope: `contractors:write`
+    #
+    # @param contractor_uuid [String] The UUID of the contractor
+    # @param version [String] The current version of the object. See the [versioning
+#  guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information
+#  on how to use this field.
+    # @param street1 [String] 
+    # @param street2 [String] 
+    # @param city [String] 
+    # @param state [String] 
+    # @param zip [String] 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::ContractorAddressInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.update_address(
+#    contractor_uuid: "contractor_uuid",
+#    street1: "300 3rd Street",
+#    city: "San Francisco",
+#    state: "CA",
+#    zip: "94107"
+#  )
+    def update_address(contractor_uuid:, version:, street1: nil, street2: nil, city: nil, state: nil, zip: 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, street_1: street1, street_2: street2, city: city, state: state, zip: zip }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/contractors/#{contractor_uuid}/address"
+end
+      Gusto::ContractorAddressInfo.from_json(json_object: response.body)
+    end
+  end
+  class AsyncContractorsClient
+  # @return [Gusto::AsyncRequestClient] 
+    attr_reader :request_client
+  # @return [Gusto::Contractors::PaymentMethodClient] 
+    attr_reader :payment_method
+  # @return [Gusto::Contractors::FormsClient] 
+    attr_reader :forms
+  # @return [Gusto::Contractors::DocumentsClient] 
+    attr_reader :documents
+  # @return [Gusto::Contractors::PaymentsClient] 
+    attr_reader :payments
+  # @return [Gusto::Contractors::PaymentGroupsClient] 
+    attr_reader :payment_groups
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AsyncContractorsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+      @payment_method = Gusto::Contractors::AsyncPaymentMethodClient.new(request_client: request_client)
+      @forms = Gusto::Contractors::AsyncFormsClient.new(request_client: request_client)
+      @documents = Gusto::Contractors::AsyncDocumentsClient.new(request_client: request_client)
+      @payments = Gusto::Contractors::AsyncPaymentsClient.new(request_client: request_client)
+      @payment_groups = Gusto::Contractors::AsyncPaymentGroupsClient.new(request_client: request_client)
+    end
+# Get all contractors, active and inactive, individual and business, for a
+#  company.
+#  scope: `contractors:read`
+    #
+    # @param company_id [String] The UUID of the company
+    # @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 search_term [String] A string to search for in the object's names
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::Contractors::Contractor>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.list(company_id: "company_id")
+    def list(company_id:, page: nil, per: nil, search_term: 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, "search_term": search_term }.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/companies/#{company_id}/contractors"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::Contractors::Contractor.from_json(json_object: item)
+        end
+      end
+    end
+# Create an individual or business contractor.
+#  scope: `contractors:manage`
+    #
+    # @param company_id [String] The UUID of the company
+    # @param request [Hash] Request of type Gusto::ContractorBody, as a Hash
+    #   * :type (Gusto::ContractorBodyType) 
+    #   * :wage_type (Gusto::ContractorBodyWageType) 
+    #   * :start_date (String) 
+    #   * :hourly_rate (String) 
+    #   * :self_onboarding (Boolean) 
+    #   * :email (String) 
+    #   * :first_name (String) 
+    #   * :last_name (String) 
+    #   * :middle_initial (String) 
+    #   * :file_new_hire_report (Boolean) 
+    #   * :work_state (String) 
+    #   * :ssn (String) 
+    #   * :business_name (String) 
+    #   * :ein (String) 
+    #   * :is_active (Boolean) 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractors::Contractor]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.create(company_id: "company_id", request: { type: INDIVIDUAL, wage_type: FIXED, start_date: "2020-04-01", self_onboarding: true, email: "johnson@johnson.com", first_name: "Johnson", last_name: "Johnson", file_new_hire_report: true, work_state: "CA" })
+    def create(company_id:, request:, 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/contractors"
+end
+        Gusto::Contractors::Contractor.from_json(json_object: response.body)
+      end
+    end
+# Get a contractor.
+#  scope: `contractors:read`
+    #
+    # @param contractor_id [String] The UUID of the contractor
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractors::Contractor]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.get(contractor_id: "contractor_id")
+    def get(contractor_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/contractors/#{contractor_id}"
+end
+        Gusto::Contractors::Contractor.from_json(json_object: response.body)
+      end
+    end
+# Update a contractor.
+#  scope: `contractors:write`
+#  > 🚧 Warning
+#  >
+#  > Watch out when changing a contractor's type (when the contractor is finished
+#  onboarding). Specifically, changing contractor type can be dangerous since Gusto
+#  won’t recognize and file two separate 1099s if they simply change from business
+#  to individual
+    #
+    # @param contractor_id [String] The UUID of the contractor
+    # @param version [String] The current version of the object. See the [versioning
+#  guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information
+#  on how to use this field.
+    # @param type [Gusto::ContractorBodyType] The contractor type.
+    # @param wage_type [Gusto::ContractorBodyWageType] The contractor’s wage type.
+    # @param start_date [String] The day when the contractor will start working for the company.
+    # @param hourly_rate [String] The contractor’s hourly rate. This attribute is required if the wage_type is
+#  `Hourly`.
+    # @param self_onboarding [Boolean] Whether the contractor or the payroll admin will complete onboarding in Gusto.
+#  Self-onboarding is recommended so that contractors receive Gusto accounts.
+#  If self_onboarding is true, then email is required.
+    # @param email [String] The contractor’s email address.
+    # @param first_name [String] The contractor’s first name.
+#  This attribute is required for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+    # @param last_name [String] The contractor’s last name.
+#  This attribute is required for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+    # @param middle_initial [String] The contractor’s middle initial.
+#  This attribute is optional for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+    # @param file_new_hire_report [Boolean] The boolean flag indicating whether Gusto will file a new hire report for the
+#  contractor.
+#  This attribute is optional for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+    # @param work_state [String] State where the contractor will be conducting the majority of their work for the
+#  company.
+#  This value is used when generating the new hire report.
+#  This attribute is required for `Individual` contractors if
+#  `file_new_hire_report` is true and will be ignored for `Business` contractors.
+    # @param ssn [String] This attribute is optional for `Individual` contractors and will be ignored for
+#  `Business` contractors.
+#  Social security number is needed to file the annual 1099 tax form.
+    # @param business_name [String] The name of the contractor business. This attribute is required for `Business`
+#  contractors and will be ignored for `Individual` contractors.
+    # @param ein [String] The employer identification number of the contractor business.
+#  This attribute is optional for `Business` contractors and will be ignored for
+#  `Individual` contractors.
+    # @param is_active [Boolean] The status of the contractor. If the contractor's start date is in the future,
+#  updating this field to true means we are setting the start date to today.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractors::Contractor]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.update(contractor_id: "contractor_id")
+    def update(contractor_id:, version:, type: nil, wage_type: nil, start_date: nil, hourly_rate: nil, self_onboarding: nil, email: nil, first_name: nil, last_name: nil, middle_initial: nil, file_new_hire_report: nil, work_state: nil, ssn: nil, business_name: nil, ein: nil, is_active: 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, type: type, wage_type: wage_type, start_date: start_date, hourly_rate: hourly_rate, self_onboarding: self_onboarding, email: email, first_name: first_name, last_name: last_name, middle_initial: middle_initial, file_new_hire_report: file_new_hire_report, work_state: work_state, ssn: ssn, business_name: business_name, ein: ein, is_active: is_active }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/contractors/#{contractor_id}"
+end
+        Gusto::Contractors::Contractor.from_json(json_object: response.body)
+      end
+    end
+# A contractor can only be deleted when there are no contractor payments.
+#  scope: `contractors:manage`
+    #
+    # @param contractor_id [String] The UUID of the contractor
+    # @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.contractors.delete(contractor_id: "contractor_id")
+    def delete(contractor_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/contractors/#{contractor_id}"
+end
+      end
+    end
+# Retrieves a contractor's onboarding status. The data returned helps inform the
+#  required onboarding steps and respective completion status.
+#  scope: `contractors:read`
+#  ## onboarding_status
+#  ### Admin-facilitated onboarding
+#  | onboarding_status             |
+#  Description |
+#  | :---------------------------- |
+#  ------------------------------------------------------------------------: |
+#  | `admin_onboarding_incomplete` |              Admin needs to enter basic
+#  information about the contractor. |
+#  | `admin_onboarding_review`     | All information has been completed and admin
+#  needs to confirm onboarding. |
+#  | `onboarding_completed`        |                         Contractor has been
+#  fully onboarded and verified. |
+#  ### Contractor self-onboarding
+#  | onboarding_status             | Description
+#  |
+#  | ----------------------------- |
+#  --------------------------------------------------------------------------------
+#  |
+#  | `admin_onboarding_incomplete` | Admin needs to enter basic information about
+#  the contractor.
+#  |
+#  | `self_onboarding_not_invited` | Admin has the intention to invite the
+#  contractor to self-onboard (e.g., marking a checkbox), but the system has not
+#  yet sent the invitation. |
+#  | `self_onboarding_invited`     | Contractor has been sent an invitation to
+#  self-onboard.
+#  |
+#  | `self_onboarding_started`     | Contractor has started the self-onboarding
+#  process.
+#  |
+#  | `self_onboarding_review`      | Admin needs to review contractors's entered
+#  information and confirm onboarding.
+#  |
+#  | `onboarding_completed`        | Contractor has been fully onboarded and
+#  verified.
+#  |
+#  ## onboarding_steps
+#  | onboarding_steps       |
+#  Requirement(s) to be completed |
+#  | :--------------------- |
+#  -------------------------------------------------------------------------------:
+#  |
+#  | `basic_details`        | Add individual contractor's first name, last name,
+#  social security number or Business name and EIN depending on the contractor type
+#  |
+#  | `add_address`          |
+#  Add contractor address. |
+#  | `compensation_details` |
+#  Add contractor compensation. |
+#  | `payment_details`      |
+#  Set up contractor's direct deposit or set to check. |
+#  | `sign_documents`       |
+#  Contractor forms (e.g., W9) are generated & signed. |
+#  | `file_new_hire_report` |
+#  Contractor new hire report is generated. |
+    #
+    # @param contractor_uuid [String] The UUID of the contractor
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractor::ContractorOnboardingInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.get_onboarding_status(contractor_uuid: "contractor_uuid")
+    def get_onboarding_status(contractor_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/contractors/#{contractor_uuid}/onboarding_status"
+end
+        Gusto::Contractor::ContractorOnboardingInfo.from_json(json_object: response.body)
+      end
+    end
+# Updates a contractor's onboarding status.
+#  scope: `contractors:write`
+#  Below is a list of valid onboarding status changes depending on the intended
+#  action to be performed on behalf of the contractor.
+#  | Action                                    |                   current
+#  onboarding_status                    |         new onboarding_status |
+#  | :---------------------------------------- |
+#  :------------------------------------------------------------: |
+#  ----------------------------: |
+#  | Mark a contractor as self-onboarding      |
+#  `admin_onboarding_incomplete`                  | `self_onboarding_not_invited` |
+#  | Invite a contractor to self-onboard       | `admin_onboarding_incomplete` or
+#  `self_onboarding_not_invited` |     `self_onboarding_invited` |
+#  | Cancel a contractor's self-onboarding     |   `self_onboarding_invited` or
+#  `self_onboarding_not_invited`   | `admin_onboarding_incomplete` |
+#  | Review a contractor's self-onboarded info |
+#  `self_onboarding_started`                    |      `self_onboarding_review` |
+#  | Finish a contractor's onboarding          |   `admin_onboarding_incomplete` or
+#  `self_onboarding_review`    |        `onboarding_completed` |
+    #
+    # @param contractor_uuid [String] The UUID of the contractor
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Contractor::ContractorOnboardingInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.update_onboarding_status(contractor_uuid: "contractor_uuid")
+    def update_onboarding_status(contractor_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
+  req.body = { **(request_options&.additional_body_parameters || {}), "onboarding_status": "onboarding_completed" }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/contractors/#{contractor_uuid}/onboarding_status"
+end
+        Gusto::Contractor::ContractorOnboardingInfo.from_json(json_object: response.body)
+      end
+    end
+# The address of a contractor is used to determine certain tax information about
+#  them. Addresses are geocoded on create and update to ensure validity.
+#  scope: `contractors:read`
+    #
+    # @param contractor_uuid [String] The UUID of the contractor
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::ContractorAddressInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.get_address(contractor_uuid: "contractor_uuid")
+    def get_address(contractor_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/contractors/#{contractor_uuid}/address"
+end
+        Gusto::ContractorAddressInfo.from_json(json_object: response.body)
+      end
+    end
+# The address of a contractor is used to determine certain tax information about
+#  them. Addresses are geocoded on create and update to ensure validity.
+#  scope: `contractors:write`
+    #
+    # @param contractor_uuid [String] The UUID of the contractor
+    # @param version [String] The current version of the object. See the [versioning
+#  guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information
+#  on how to use this field.
+    # @param street1 [String] 
+    # @param street2 [String] 
+    # @param city [String] 
+    # @param state [String] 
+    # @param zip [String] 
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::ContractorAddressInfo]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.update_address(
+#    contractor_uuid: "contractor_uuid",
+#    street1: "300 3rd Street",
+#    city: "San Francisco",
+#    state: "CA",
+#    zip: "94107"
+#  )
+    def update_address(contractor_uuid:, version:, street1: nil, street2: nil, city: nil, state: nil, zip: 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, street_1: street1, street_2: street2, city: city, state: state, zip: zip }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/contractors/#{contractor_uuid}/address"
+end
+        Gusto::ContractorAddressInfo.from_json(json_object: response.body)
+      end
+    end
+  end
+end