fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/payroll/pay_schedules/client.rb

@@ -0,0 +1,584 @@
+# frozen_string_literal: true
+require_relative "../../../requests"
+require_relative "../../pay_schedules/types/pay_schedule"
+require_relative "types/pay_schedules_create_request_frequency"
+require_relative "types/pay_schedules_preview_request_frequency"
+require_relative "types/pay_schedules_preview_response"
+require_relative "types/pay_schedules_update_request_frequency"
+require_relative "../../payrolls/types/pay_period"
+require "json"
+require "async"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../../requests"
+
+module Gusto
+  module Payroll
+    class PaySchedulesClient
+    # @return [Gusto::RequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Payroll::PaySchedulesClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# The pay schedule object in Gusto captures the details of when employees work and
+#  when they should be paid. A company can have multiple pay schedules.
+#  scope: `pay_schedules:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param pay_schedule_id [String] The UUID of the pay schedule
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::PaySchedules::PaySchedule]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.get(company_id: "company_id", pay_schedule_id: "pay_schedule_id")
+      def get(company_id:, pay_schedule_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}/pay_schedules/#{pay_schedule_id}"
+end
+        Gusto::PaySchedules::PaySchedule.from_json(json_object: response.body)
+      end
+# If a company does not have any pay schedules, this endpoint will create a single
+#  pay schedule and assign it to all employees. This is a common use case during
+#  company onboarding.
+#  If a company has an existing active pay schedule and want to support multiple
+#  pay schedules, this endpoint will create a pay schedule that is not assigned to
+#  any employee.
+#  Be sure to **[check state laws](https://www.dol.gov/agencies/whd/state/payday)**
+#  to know what schedule is right for your customers.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param frequency [Gusto::Payroll::PaySchedules::PaySchedulesCreateRequestFrequency] The frequency that employees on this pay schedule are paid with Gusto.
+      # @param anchor_pay_date [String] The first date that employees on this pay schedule are paid with Gusto.
+      # @param anchor_end_of_pay_period [String] The last date of the first pay period. This can be the same date as the anchor
+#  pay date.
+      # @param day1 [Integer] An integer between 1 and 31 indicating the first day of the month that employees
+#  are paid. This field is only relevant for pay schedules with the “Twice per
+#  month” and “Monthly” frequencies. It will be null for pay schedules with other
+#  frequencies.
+      # @param day2 [Integer] An integer between 1 and 31 indicating the second day of the month that
+#  employees are paid. This field is the second pay date for pay schedules with the
+#  "Twice per month" frequency. For semi-monthly pay schedules, set this field to
+#  31. For months shorter than 31 days, we will set the second pay date to the last
+#  day of the month. It will be null for pay schedules with other frequencies.
+      # @param custom_name [String] A custom pay schedule name, defaults to the pay frequency description.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::PaySchedules::PaySchedule]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.create(
+#    company_id: "company_id",
+#    frequency: TWICE_PER_MONTH,
+#    anchor_pay_date: "2021-10-15",
+#    anchor_end_of_pay_period: "2021-10-15",
+#    day1: 15,
+#    day2: 31,
+#    custom_name: "demo pay schedule"
+#  )
+      def create(company_id:, frequency:, anchor_pay_date:, anchor_end_of_pay_period:, day1: nil, day2: nil, custom_name: 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 || {}), frequency: frequency, anchor_pay_date: anchor_pay_date, anchor_end_of_pay_period: anchor_end_of_pay_period, day_1: day1, day_2: day2, custom_name: custom_name }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/pay_schedules"
+end
+        Gusto::PaySchedules::PaySchedule.from_json(json_object: response.body)
+      end
+# Provides a preview of a pay schedule with the specified parameters
+#  scope: `pay_schedules:write`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param frequency [Gusto::Payroll::PaySchedules::PaySchedulesPreviewRequestFrequency] The frequency that employees on this pay schedule are paid with Gusto.
+      # @param anchor_pay_date [String] The first date that employees on this pay schedule are paid with Gusto.
+      # @param anchor_end_of_pay_period [String] The last date of the first pay period. This can be the same date as the anchor
+#  pay date.
+      # @param day1 [Integer] An integer between 1 and 31 indicating the first day of the month that employees
+#  are paid. This field is only relevant for pay schedules with the “Twice per
+#  month” and “Monthly” frequencies. It will be null for pay schedules with other
+#  frequencies.
+      # @param day2 [Integer] An integer between 1 and 31 indicating the second day of the month that
+#  employees are paid. This field is the second pay date for pay schedules with the
+#  "Twice per month" frequency. For semi-monthly pay schedules, set this field to
+#  31. For months shorter than 31 days, we will set the second pay date to the last
+#  day of the month. It will be null for pay schedules with other frequencies.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Payroll::PaySchedules::PaySchedulesPreviewResponse]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.preview(
+#    company_id: "company_id",
+#    anchor_pay_date: "2020-05-15",
+#    anchor_end_of_pay_period: "2020-05-08"
+#  )
+      def preview(company_id:, frequency: nil, anchor_pay_date: nil, anchor_end_of_pay_period: nil, day1: nil, day2: 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 || {}), "frequency": frequency, "anchor_pay_date": anchor_pay_date, "anchor_end_of_pay_period": anchor_end_of_pay_period, "day_1": day1, "day_2": day2 }.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}/pay_schedules/preview"
+end
+        Gusto::Payroll::PaySchedules::PaySchedulesPreviewResponse.from_json(json_object: response.body)
+      end
+# Updates a pay schedule.
+#  scope: `pay_schedules:write`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param pay_schedule_id [String] The UUID of the pay schedule
+      # @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 frequency [Gusto::Payroll::PaySchedules::PaySchedulesUpdateRequestFrequency] The frequency that employees on this pay schedule are paid with Gusto.
+      # @param anchor_pay_date [String] The first date that employees on this pay schedule are paid with Gusto.
+      # @param anchor_end_of_pay_period [String] The last date of the first pay period. This can be the same date as the anchor
+#  pay date.
+      # @param day1 [Integer] An integer between 1 and 31 indicating the first day of the month that employees
+#  are paid. This field is only relevant for pay schedules with the “Twice per
+#  month” and “Monthly” frequencies. It will be null for pay schedules with other
+#  frequencies.
+      # @param day2 [Integer] An integer between 1 and 31 indicating the second day of the month that
+#  employees are paid. This field is the second pay date for pay schedules with the
+#  "Twice per month" frequency. For semi-monthly pay schedules, set this field to
+#  31. For months shorter than 31 days, we will set the second pay date to the last
+#  day of the month. It will be null for pay schedules with other frequencies.
+      # @param custom_name [String] A custom pay schedule name.
+      # @param auto_pilot [Boolean] With Autopilot® enabled, payroll will run automatically one day before your
+#  payroll deadlines.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::PaySchedules::PaySchedule]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.update(
+#    company_id: "company_id",
+#    pay_schedule_id: "pay_schedule_id",
+#    version: "68934a3e9455fa72420237eb05902327",
+#    frequency: TWICE_PER_MONTH,
+#    anchor_pay_date: "2021-10-15",
+#    anchor_end_of_pay_period: "2021-10-15",
+#    day1: 15,
+#    day2: 31,
+#    custom_name: "demo pay schedule",
+#    auto_pilot: true
+#  )
+      def update(company_id:, pay_schedule_id:, version:, frequency: nil, anchor_pay_date: nil, anchor_end_of_pay_period: nil, day1: nil, day2: nil, custom_name: nil, auto_pilot: 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, frequency: frequency, anchor_pay_date: anchor_pay_date, anchor_end_of_pay_period: anchor_end_of_pay_period, day_1: day1, day_2: day2, custom_name: custom_name, auto_pilot: auto_pilot }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/pay_schedules/#{pay_schedule_id}"
+end
+        Gusto::PaySchedules::PaySchedule.from_json(json_object: response.body)
+      end
+# Pay periods are the foundation of payroll. Compensation, time & attendance,
+#  taxes, and expense reports all rely on when they happened. To begin submitting
+#  information for a given payroll, we need to agree on the time period.
+#  By default, this endpoint returns pay periods starting from 6 months ago to the
+#  date today. Use the `start_date` and `end_date` parameters to change the scope
+#  of the response. End dates can be up to 3 months in the future and there is no
+#  limit on start dates.
+#  Starting in version '2023-04-01', the eligible_employees attribute was removed
+#  from the response. The eligible employees for a payroll are determined by the
+#  employee_compensations returned from the payrolls#prepare endpoint.
+#  scope: `payrolls:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param start_date [String] 
+      # @param end_date [String] If left empty, defaults to today's date.
+      # @param payroll_types [String] regular and/or transition. Multiple options are comma separated. The default is
+#  regular pay periods if nothing is passed in.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::Payrolls::PayPeriod>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.get_pay_periods(
+#    company_id: "company_id",
+#    start_date: "2020-01-01",
+#    end_date: "2020-01-31"
+#  )
+      def get_pay_periods(company_id:, start_date: nil, end_date: nil, payroll_types: 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, "payroll_types": payroll_types }.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}/pay_periods"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::Payrolls::PayPeriod.from_json(json_object: item)
+        end
+      end
+    end
+    class AsyncPaySchedulesClient
+    # @return [Gusto::AsyncRequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Payroll::AsyncPaySchedulesClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# The pay schedule object in Gusto captures the details of when employees work and
+#  when they should be paid. A company can have multiple pay schedules.
+#  scope: `pay_schedules:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param pay_schedule_id [String] The UUID of the pay schedule
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::PaySchedules::PaySchedule]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.get(company_id: "company_id", pay_schedule_id: "pay_schedule_id")
+      def get(company_id:, pay_schedule_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}/pay_schedules/#{pay_schedule_id}"
+end
+          Gusto::PaySchedules::PaySchedule.from_json(json_object: response.body)
+        end
+      end
+# If a company does not have any pay schedules, this endpoint will create a single
+#  pay schedule and assign it to all employees. This is a common use case during
+#  company onboarding.
+#  If a company has an existing active pay schedule and want to support multiple
+#  pay schedules, this endpoint will create a pay schedule that is not assigned to
+#  any employee.
+#  Be sure to **[check state laws](https://www.dol.gov/agencies/whd/state/payday)**
+#  to know what schedule is right for your customers.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param frequency [Gusto::Payroll::PaySchedules::PaySchedulesCreateRequestFrequency] The frequency that employees on this pay schedule are paid with Gusto.
+      # @param anchor_pay_date [String] The first date that employees on this pay schedule are paid with Gusto.
+      # @param anchor_end_of_pay_period [String] The last date of the first pay period. This can be the same date as the anchor
+#  pay date.
+      # @param day1 [Integer] An integer between 1 and 31 indicating the first day of the month that employees
+#  are paid. This field is only relevant for pay schedules with the “Twice per
+#  month” and “Monthly” frequencies. It will be null for pay schedules with other
+#  frequencies.
+      # @param day2 [Integer] An integer between 1 and 31 indicating the second day of the month that
+#  employees are paid. This field is the second pay date for pay schedules with the
+#  "Twice per month" frequency. For semi-monthly pay schedules, set this field to
+#  31. For months shorter than 31 days, we will set the second pay date to the last
+#  day of the month. It will be null for pay schedules with other frequencies.
+      # @param custom_name [String] A custom pay schedule name, defaults to the pay frequency description.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::PaySchedules::PaySchedule]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.create(
+#    company_id: "company_id",
+#    frequency: TWICE_PER_MONTH,
+#    anchor_pay_date: "2021-10-15",
+#    anchor_end_of_pay_period: "2021-10-15",
+#    day1: 15,
+#    day2: 31,
+#    custom_name: "demo pay schedule"
+#  )
+      def create(company_id:, frequency:, anchor_pay_date:, anchor_end_of_pay_period:, day1: nil, day2: nil, custom_name: 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 || {}), frequency: frequency, anchor_pay_date: anchor_pay_date, anchor_end_of_pay_period: anchor_end_of_pay_period, day_1: day1, day_2: day2, custom_name: custom_name }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/pay_schedules"
+end
+          Gusto::PaySchedules::PaySchedule.from_json(json_object: response.body)
+        end
+      end
+# Provides a preview of a pay schedule with the specified parameters
+#  scope: `pay_schedules:write`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param frequency [Gusto::Payroll::PaySchedules::PaySchedulesPreviewRequestFrequency] The frequency that employees on this pay schedule are paid with Gusto.
+      # @param anchor_pay_date [String] The first date that employees on this pay schedule are paid with Gusto.
+      # @param anchor_end_of_pay_period [String] The last date of the first pay period. This can be the same date as the anchor
+#  pay date.
+      # @param day1 [Integer] An integer between 1 and 31 indicating the first day of the month that employees
+#  are paid. This field is only relevant for pay schedules with the “Twice per
+#  month” and “Monthly” frequencies. It will be null for pay schedules with other
+#  frequencies.
+      # @param day2 [Integer] An integer between 1 and 31 indicating the second day of the month that
+#  employees are paid. This field is the second pay date for pay schedules with the
+#  "Twice per month" frequency. For semi-monthly pay schedules, set this field to
+#  31. For months shorter than 31 days, we will set the second pay date to the last
+#  day of the month. It will be null for pay schedules with other frequencies.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::Payroll::PaySchedules::PaySchedulesPreviewResponse]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.preview(
+#    company_id: "company_id",
+#    anchor_pay_date: "2020-05-15",
+#    anchor_end_of_pay_period: "2020-05-08"
+#  )
+      def preview(company_id:, frequency: nil, anchor_pay_date: nil, anchor_end_of_pay_period: nil, day1: nil, day2: 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 || {}), "frequency": frequency, "anchor_pay_date": anchor_pay_date, "anchor_end_of_pay_period": anchor_end_of_pay_period, "day_1": day1, "day_2": day2 }.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}/pay_schedules/preview"
+end
+          Gusto::Payroll::PaySchedules::PaySchedulesPreviewResponse.from_json(json_object: response.body)
+        end
+      end
+# Updates a pay schedule.
+#  scope: `pay_schedules:write`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param pay_schedule_id [String] The UUID of the pay schedule
+      # @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 frequency [Gusto::Payroll::PaySchedules::PaySchedulesUpdateRequestFrequency] The frequency that employees on this pay schedule are paid with Gusto.
+      # @param anchor_pay_date [String] The first date that employees on this pay schedule are paid with Gusto.
+      # @param anchor_end_of_pay_period [String] The last date of the first pay period. This can be the same date as the anchor
+#  pay date.
+      # @param day1 [Integer] An integer between 1 and 31 indicating the first day of the month that employees
+#  are paid. This field is only relevant for pay schedules with the “Twice per
+#  month” and “Monthly” frequencies. It will be null for pay schedules with other
+#  frequencies.
+      # @param day2 [Integer] An integer between 1 and 31 indicating the second day of the month that
+#  employees are paid. This field is the second pay date for pay schedules with the
+#  "Twice per month" frequency. For semi-monthly pay schedules, set this field to
+#  31. For months shorter than 31 days, we will set the second pay date to the last
+#  day of the month. It will be null for pay schedules with other frequencies.
+      # @param custom_name [String] A custom pay schedule name.
+      # @param auto_pilot [Boolean] With Autopilot® enabled, payroll will run automatically one day before your
+#  payroll deadlines.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::PaySchedules::PaySchedule]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.update(
+#    company_id: "company_id",
+#    pay_schedule_id: "pay_schedule_id",
+#    version: "68934a3e9455fa72420237eb05902327",
+#    frequency: TWICE_PER_MONTH,
+#    anchor_pay_date: "2021-10-15",
+#    anchor_end_of_pay_period: "2021-10-15",
+#    day1: 15,
+#    day2: 31,
+#    custom_name: "demo pay schedule",
+#    auto_pilot: true
+#  )
+      def update(company_id:, pay_schedule_id:, version:, frequency: nil, anchor_pay_date: nil, anchor_end_of_pay_period: nil, day1: nil, day2: nil, custom_name: nil, auto_pilot: 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, frequency: frequency, anchor_pay_date: anchor_pay_date, anchor_end_of_pay_period: anchor_end_of_pay_period, day_1: day1, day_2: day2, custom_name: custom_name, auto_pilot: auto_pilot }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/pay_schedules/#{pay_schedule_id}"
+end
+          Gusto::PaySchedules::PaySchedule.from_json(json_object: response.body)
+        end
+      end
+# Pay periods are the foundation of payroll. Compensation, time & attendance,
+#  taxes, and expense reports all rely on when they happened. To begin submitting
+#  information for a given payroll, we need to agree on the time period.
+#  By default, this endpoint returns pay periods starting from 6 months ago to the
+#  date today. Use the `start_date` and `end_date` parameters to change the scope
+#  of the response. End dates can be up to 3 months in the future and there is no
+#  limit on start dates.
+#  Starting in version '2023-04-01', the eligible_employees attribute was removed
+#  from the response. The eligible employees for a payroll are determined by the
+#  employee_compensations returned from the payrolls#prepare endpoint.
+#  scope: `payrolls:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param start_date [String] 
+      # @param end_date [String] If left empty, defaults to today's date.
+      # @param payroll_types [String] regular and/or transition. Multiple options are comma separated. The default is
+#  regular pay periods if nothing is passed in.
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::Payrolls::PayPeriod>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.payroll.pay_schedules.get_pay_periods(
+#    company_id: "company_id",
+#    start_date: "2020-01-01",
+#    end_date: "2020-01-31"
+#  )
+      def get_pay_periods(company_id:, start_date: nil, end_date: nil, payroll_types: 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, "payroll_types": payroll_types }.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}/pay_periods"
+end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do | item |
+            item = item.to_json
+            Gusto::Payrolls::PayPeriod.from_json(json_object: item)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fern_gusto/payroll/pay_schedules/types/pay_schedules_create_request_frequency.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Payroll
+    module PaySchedules
+# The frequency that employees on this pay schedule are paid with Gusto.
+      class PaySchedulesCreateRequestFrequency
+
+        EVERY_WEEK = "Every week"
+        EVERY_OTHER_WEEK = "Every other week"
+        TWICE_PER_MONTH = "Twice per month"
+        MONTHLY = "Monthly"
+
+      end
+    end
+  end
+end

data/lib/fern_gusto/payroll/pay_schedules/types/pay_schedules_preview_request_frequency.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Payroll
+    module PaySchedules
+      class PaySchedulesPreviewRequestFrequency
+
+        EVERY_WEEK = "Every week"
+        EVERY_OTHER_WEEK = "Every other week"
+        TWICE_PER_MONTH = "Twice per month"
+        MONTHLY = "Monthly"
+
+      end
+    end
+  end
+end