fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/contractors/payments/client.rb

@@ -0,0 +1,558 @@
+# frozen_string_literal: true
+require_relative "../../../requests"
+require_relative "../../types/contractor_payment_receipt"
+require_relative "../../contractor_payments/types/contractor_payment"
+require_relative "types/payments_list_response"
+require_relative "types/payments_create_request_payment_method"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../../requests"
+
+module Gusto
+  module Contractors
+    class PaymentsClient
+    # @return [Gusto::RequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Contractors::PaymentsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Returns a contractor payment receipt.
+#  Notes:
+#  - Receipts are only available for direct deposit payments and are only available
+#  once those payments have been funded.
+#  - Payroll Receipt requests for payrolls which do not have receipts available
+#  (e.g. payment by check) will return a 404 status.
+#  - Hour and dollar amounts are returned as string representations of numeric
+#  decimals.
+#  - Dollar amounts are represented to the cent.
+#  - If no data has yet be inserted for a given field, it defaults to “0.00” (for
+#  fixed amounts).
+#  scope: `payrolls:read`
+      #
+      # @param contractor_payment_uuid [String] The UUID of the contractor payment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPaymentReceipt]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.get_receipt(contractor_payment_uuid: "contractor_payment_uuid")
+      def get_receipt(contractor_payment_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/contractor_payments/#{contractor_payment_uuid}/receipt"
+end
+        Gusto::ContractorPaymentReceipt.from_json(json_object: response.body)
+      end
+# > 🚧 Demo action
+#  >
+#  > This action is only available in the Demo environment
+#  Simulate funding a contractor payment. Funding only occurs automatically in the
+#  production environment when bank transactions are generated. Use this action in
+#  the demo environment to transition a contractor payment's `status` from
+#  `Unfunded` to `Funded`. A `Funded` status is required for generating a
+#  contractor payment receipt.
+#  scope: `payrolls:run`
+      #
+      # @param contractor_payment_uuid [String] The UUID of the contractor payment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPayments::ContractorPayment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.fund(contractor_payment_uuid: "contractor_payment_uuid")
+      def fund(contractor_payment_uuid:, request_options: nil)
+        response = @request_client.conn.put do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/contractor_payments/#{contractor_payment_uuid}/fund"
+end
+        Gusto::ContractorPayments::ContractorPayment.from_json(json_object: response.body)
+      end
+# Returns an object containing individual contractor payments, within a given time
+#  period, including totals.
+#  scope: `payrolls:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param start_date [String] The time period for which to retrieve contractor payments
+      # @param end_date [String] The time period for which to retrieve contractor payments. If left empty,
+#  defaults to today's date.
+      # @param contractor_uuid [String] The UUID of the contractor. When specified, will load all payments for that
+#  contractor.
+      # @param group_by_date [Boolean] Display contractor payments results group by check date if set to true.
+      # @param page [Float] The page that is requested. When unspecified, will load all objects unless
+#  endpoint forces pagination.
+      # @param per [Float] Number of objects per page. For majority of endpoints will default to 25
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPayments::ContractorPaymentSummary, Gusto::ContractorPayments::ContractorPaymentSummaryByDates]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.list(
+#    company_id: "company_id",
+#    start_date: "2020-01-01",
+#    end_date: "2020-12-31"
+#  )
+      def list(company_id:, start_date:, end_date:, contractor_uuid: nil, group_by_date: nil, 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 || {}), "start_date": start_date, "end_date": end_date, "contractor_uuid": contractor_uuid, "group_by_date": group_by_date, "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/companies/#{company_id}/contractor_payments"
+end
+        Gusto::Contractors::Payments::PaymentsListResponse.from_json(json_object: response.body)
+      end
+# Pay a contractor. Information needed depends on the contractor's wage type
+#  (hourly vs fixed)
+#  scope: `payrolls:run`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param contractor_uuid [String] The contractor receiving the payment
+      # @param date [String] Date of contractor payment
+      # @param payment_method [Gusto::Contractors::Payments::PaymentsCreateRequestPaymentMethod] 
+      # @param wage [Float] If the contractor is on a fixed wage, this is the fixed wage payment for the
+#  contractor, regardless of hours worked
+      # @param hours [Float] If the contractor is on an hourly wage, this is the number of hours that the
+#  contractor worked for the payment
+      # @param bonus [Float] If the contractor is on an hourly wage, this is the bonus the contractor earned
+      # @param reimbursement [Float] Reimbursed wages for the contractor
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPayments::ContractorPayment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.create(
+#    company_id: "company_id",
+#    contractor_uuid: "contractor_uuid",
+#    date: "2020-01-01"
+#  )
+      def create(company_id:, contractor_uuid:, date:, payment_method: nil, wage: nil, hours: nil, bonus: nil, reimbursement: 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 || {}), contractor_uuid: contractor_uuid, date: date, payment_method: payment_method, wage: wage, hours: hours, bonus: bonus, reimbursement: reimbursement }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/contractor_payments"
+end
+        Gusto::ContractorPayments::ContractorPayment.from_json(json_object: response.body)
+      end
+# Returns a single contractor payment.
+#  scope: `payrolls:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param contractor_payment_id [String] The UUID of the contractor payment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPayments::ContractorPayment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.get(company_id: "company_id", contractor_payment_id: "contractor_payment_id")
+      def get(company_id:, contractor_payment_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/companies/#{company_id}/contractor_payments/#{contractor_payment_id}"
+end
+        Gusto::ContractorPayments::ContractorPayment.from_json(json_object: response.body)
+      end
+# Cancels and deletes a contractor payment. If the contractor payment has already
+#  started processing, the payment cannot be cancelled.
+#  scope: `payrolls:run`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param contractor_payment_id [String] The UUID of the contractor payment
+      # @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.payments.delete(company_id: "company_id", contractor_payment_id: "contractor_payment_id")
+      def delete(company_id:, contractor_payment_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/companies/#{company_id}/contractor_payments/#{contractor_payment_id}"
+end
+      end
+    end
+    class AsyncPaymentsClient
+    # @return [Gusto::AsyncRequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Contractors::AsyncPaymentsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Returns a contractor payment receipt.
+#  Notes:
+#  - Receipts are only available for direct deposit payments and are only available
+#  once those payments have been funded.
+#  - Payroll Receipt requests for payrolls which do not have receipts available
+#  (e.g. payment by check) will return a 404 status.
+#  - Hour and dollar amounts are returned as string representations of numeric
+#  decimals.
+#  - Dollar amounts are represented to the cent.
+#  - If no data has yet be inserted for a given field, it defaults to “0.00” (for
+#  fixed amounts).
+#  scope: `payrolls:read`
+      #
+      # @param contractor_payment_uuid [String] The UUID of the contractor payment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPaymentReceipt]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.get_receipt(contractor_payment_uuid: "contractor_payment_uuid")
+      def get_receipt(contractor_payment_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/contractor_payments/#{contractor_payment_uuid}/receipt"
+end
+          Gusto::ContractorPaymentReceipt.from_json(json_object: response.body)
+        end
+      end
+# > 🚧 Demo action
+#  >
+#  > This action is only available in the Demo environment
+#  Simulate funding a contractor payment. Funding only occurs automatically in the
+#  production environment when bank transactions are generated. Use this action in
+#  the demo environment to transition a contractor payment's `status` from
+#  `Unfunded` to `Funded`. A `Funded` status is required for generating a
+#  contractor payment receipt.
+#  scope: `payrolls:run`
+      #
+      # @param contractor_payment_uuid [String] The UUID of the contractor payment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPayments::ContractorPayment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.fund(contractor_payment_uuid: "contractor_payment_uuid")
+      def fund(contractor_payment_uuid:, request_options: nil)
+        Async do
+          response = @request_client.conn.put do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/contractor_payments/#{contractor_payment_uuid}/fund"
+end
+          Gusto::ContractorPayments::ContractorPayment.from_json(json_object: response.body)
+        end
+      end
+# Returns an object containing individual contractor payments, within a given time
+#  period, including totals.
+#  scope: `payrolls:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param start_date [String] The time period for which to retrieve contractor payments
+      # @param end_date [String] The time period for which to retrieve contractor payments. If left empty,
+#  defaults to today's date.
+      # @param contractor_uuid [String] The UUID of the contractor. When specified, will load all payments for that
+#  contractor.
+      # @param group_by_date [Boolean] Display contractor payments results group by check date if set to true.
+      # @param page [Float] The page that is requested. When unspecified, will load all objects unless
+#  endpoint forces pagination.
+      # @param per [Float] Number of objects per page. For majority of endpoints will default to 25
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPayments::ContractorPaymentSummary, Gusto::ContractorPayments::ContractorPaymentSummaryByDates]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.list(
+#    company_id: "company_id",
+#    start_date: "2020-01-01",
+#    end_date: "2020-12-31"
+#  )
+      def list(company_id:, start_date:, end_date:, contractor_uuid: nil, group_by_date: nil, 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 || {}), "start_date": start_date, "end_date": end_date, "contractor_uuid": contractor_uuid, "group_by_date": group_by_date, "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/companies/#{company_id}/contractor_payments"
+end
+          Gusto::Contractors::Payments::PaymentsListResponse.from_json(json_object: response.body)
+        end
+      end
+# Pay a contractor. Information needed depends on the contractor's wage type
+#  (hourly vs fixed)
+#  scope: `payrolls:run`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param contractor_uuid [String] The contractor receiving the payment
+      # @param date [String] Date of contractor payment
+      # @param payment_method [Gusto::Contractors::Payments::PaymentsCreateRequestPaymentMethod] 
+      # @param wage [Float] If the contractor is on a fixed wage, this is the fixed wage payment for the
+#  contractor, regardless of hours worked
+      # @param hours [Float] If the contractor is on an hourly wage, this is the number of hours that the
+#  contractor worked for the payment
+      # @param bonus [Float] If the contractor is on an hourly wage, this is the bonus the contractor earned
+      # @param reimbursement [Float] Reimbursed wages for the contractor
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPayments::ContractorPayment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.create(
+#    company_id: "company_id",
+#    contractor_uuid: "contractor_uuid",
+#    date: "2020-01-01"
+#  )
+      def create(company_id:, contractor_uuid:, date:, payment_method: nil, wage: nil, hours: nil, bonus: nil, reimbursement: 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 || {}), contractor_uuid: contractor_uuid, date: date, payment_method: payment_method, wage: wage, hours: hours, bonus: bonus, reimbursement: reimbursement }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/contractor_payments"
+end
+          Gusto::ContractorPayments::ContractorPayment.from_json(json_object: response.body)
+        end
+      end
+# Returns a single contractor payment.
+#  scope: `payrolls:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param contractor_payment_id [String] The UUID of the contractor payment
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::ContractorPayments::ContractorPayment]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.contractors.payments.get(company_id: "company_id", contractor_payment_id: "contractor_payment_id")
+      def get(company_id:, contractor_payment_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/companies/#{company_id}/contractor_payments/#{contractor_payment_id}"
+end
+          Gusto::ContractorPayments::ContractorPayment.from_json(json_object: response.body)
+        end
+      end
+# Cancels and deletes a contractor payment. If the contractor payment has already
+#  started processing, the payment cannot be cancelled.
+#  scope: `payrolls:run`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param contractor_payment_id [String] The UUID of the contractor payment
+      # @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.payments.delete(company_id: "company_id", contractor_payment_id: "contractor_payment_id")
+      def delete(company_id:, contractor_payment_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/companies/#{company_id}/contractor_payments/#{contractor_payment_id}"
+end
+        end
+      end
+    end
+  end
+end

data/lib/fern_gusto/contractors/payments/types/payments_create_request_payment_method.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Contractors
+    module Payments
+      class PaymentsCreateRequestPaymentMethod
+
+        DIRECT_DEPOSIT = "Direct Deposit"
+        CHECK = "Check"
+        HISTORICAL_PAYMENT = "Historical Payment"
+
+      end
+    end
+  end
+end

data/lib/fern_gusto/contractors/payments/types/payments_list_response.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require "json"
+require_relative "../../../contractor_payments/types/contractor_payment_summary"
+require_relative "../../../contractor_payments/types/contractor_payment_summary_by_dates"
+
+module Gusto
+  module Contractors
+    module Payments
+      class PaymentsListResponse
+
+
+# Deserialize a JSON object to an instance of PaymentsListResponse
+        #
+        # @param json_object [String] 
+        # @return [Gusto::Contractors::Payments::PaymentsListResponse]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          begin
+            Gusto::ContractorPayments::ContractorPaymentSummary.validate_raw(obj: struct)
+            unless struct.nil?
+  return Gusto::ContractorPayments::ContractorPaymentSummary.from_json(json_object: struct)
+else
+  return nil
+end
+          rescue StandardError
+            # noop
+          end
+          begin
+            Gusto::ContractorPayments::ContractorPaymentSummaryByDates.validate_raw(obj: struct)
+            unless struct.nil?
+  return Gusto::ContractorPayments::ContractorPaymentSummaryByDates.from_json(json_object: struct)
+else
+  return nil
+end
+          rescue StandardError
+            # noop
+          end
+ return struct
+        end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+        #
+        # @param obj [Object] 
+        # @return [Void]
+        def self.validate_raw(obj:)
+          begin
+            return Gusto::ContractorPayments::ContractorPaymentSummary.validate_raw(obj: obj)
+          rescue StandardError
+            # noop
+          end
+          begin
+            return Gusto::ContractorPayments::ContractorPaymentSummaryByDates.validate_raw(obj: obj)
+          rescue StandardError
+            # noop
+          end
+          raise("Passed value matched no type within the union, validation failed.")
+        end
+      end
+    end
+  end
+end