fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/holiday_pay_policies/types/holiday_pay_policies_update_request_federal_holidays_labor_day.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module HolidayPayPolicies
+    class HolidayPayPoliciesUpdateRequestFederalHolidaysLaborDay
+    # @return [Boolean] 
+      attr_reader :selected
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param selected [Boolean] 
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysLaborDay]
+      def initialize(selected: OMIT, additional_properties: nil)
+        @selected = selected if selected != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "selected": selected }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysLaborDay
+      #
+      # @param json_object [String] 
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysLaborDay]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        selected = parsed_json["selected"]
+        new(selected: selected, additional_properties: struct)
+      end
+# Serialize an instance of HolidayPayPoliciesUpdateRequestFederalHolidaysLaborDay
+#  to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      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:)
+        obj.selected&.is_a?(Boolean) != false || raise("Passed value for field obj.selected is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/holiday_pay_policies/types/holiday_pay_policies_update_request_federal_holidays_memorial_day.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module HolidayPayPolicies
+    class HolidayPayPoliciesUpdateRequestFederalHolidaysMemorialDay
+    # @return [Boolean] 
+      attr_reader :selected
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param selected [Boolean] 
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysMemorialDay]
+      def initialize(selected: OMIT, additional_properties: nil)
+        @selected = selected if selected != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "selected": selected }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysMemorialDay
+      #
+      # @param json_object [String] 
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysMemorialDay]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        selected = parsed_json["selected"]
+        new(selected: selected, additional_properties: struct)
+      end
+# Serialize an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysMemorialDay to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      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:)
+        obj.selected&.is_a?(Boolean) != false || raise("Passed value for field obj.selected is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/holiday_pay_policies/types/holiday_pay_policies_update_request_federal_holidays_mlk_day.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module HolidayPayPolicies
+    class HolidayPayPoliciesUpdateRequestFederalHolidaysMlkDay
+    # @return [Boolean] 
+      attr_reader :selected
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param selected [Boolean] 
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysMlkDay]
+      def initialize(selected: OMIT, additional_properties: nil)
+        @selected = selected if selected != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "selected": selected }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysMlkDay
+      #
+      # @param json_object [String] 
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysMlkDay]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        selected = parsed_json["selected"]
+        new(selected: selected, additional_properties: struct)
+      end
+# Serialize an instance of HolidayPayPoliciesUpdateRequestFederalHolidaysMlkDay to
+#  a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      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:)
+        obj.selected&.is_a?(Boolean) != false || raise("Passed value for field obj.selected is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/holiday_pay_policies/types/holiday_pay_policies_update_request_federal_holidays_new_years_day.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module HolidayPayPolicies
+    class HolidayPayPoliciesUpdateRequestFederalHolidaysNewYearsDay
+    # @return [Boolean] 
+      attr_reader :selected
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param selected [Boolean] 
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysNewYearsDay]
+      def initialize(selected: OMIT, additional_properties: nil)
+        @selected = selected if selected != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "selected": selected }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysNewYearsDay
+      #
+      # @param json_object [String] 
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysNewYearsDay]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        selected = parsed_json["selected"]
+        new(selected: selected, additional_properties: struct)
+      end
+# Serialize an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysNewYearsDay to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      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:)
+        obj.selected&.is_a?(Boolean) != false || raise("Passed value for field obj.selected is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/holiday_pay_policies/types/holiday_pay_policies_update_request_federal_holidays_presidents_day.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module HolidayPayPolicies
+    class HolidayPayPoliciesUpdateRequestFederalHolidaysPresidentsDay
+    # @return [Boolean] 
+      attr_reader :selected
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param selected [Boolean] 
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysPresidentsDay]
+      def initialize(selected: OMIT, additional_properties: nil)
+        @selected = selected if selected != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "selected": selected }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysPresidentsDay
+      #
+      # @param json_object [String] 
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysPresidentsDay]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        selected = parsed_json["selected"]
+        new(selected: selected, additional_properties: struct)
+      end
+# Serialize an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysPresidentsDay to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      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:)
+        obj.selected&.is_a?(Boolean) != false || raise("Passed value for field obj.selected is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/holiday_pay_policies/types/holiday_pay_policies_update_request_federal_holidays_thanksgiving.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module HolidayPayPolicies
+    class HolidayPayPoliciesUpdateRequestFederalHolidaysThanksgiving
+    # @return [Boolean] 
+      attr_reader :selected
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param selected [Boolean] 
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysThanksgiving]
+      def initialize(selected: OMIT, additional_properties: nil)
+        @selected = selected if selected != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "selected": selected }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysThanksgiving
+      #
+      # @param json_object [String] 
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysThanksgiving]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        selected = parsed_json["selected"]
+        new(selected: selected, additional_properties: struct)
+      end
+# Serialize an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysThanksgiving to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      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:)
+        obj.selected&.is_a?(Boolean) != false || raise("Passed value for field obj.selected is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/holiday_pay_policies/types/holiday_pay_policies_update_request_federal_holidays_veterans_day.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module HolidayPayPolicies
+    class HolidayPayPoliciesUpdateRequestFederalHolidaysVeteransDay
+    # @return [Boolean] 
+      attr_reader :selected
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param selected [Boolean] 
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysVeteransDay]
+      def initialize(selected: OMIT, additional_properties: nil)
+        @selected = selected if selected != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "selected": selected }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysVeteransDay
+      #
+      # @param json_object [String] 
+      # @return [Gusto::HolidayPayPolicies::HolidayPayPoliciesUpdateRequestFederalHolidaysVeteransDay]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        selected = parsed_json["selected"]
+        new(selected: selected, additional_properties: struct)
+      end
+# Serialize an instance of
+#  HolidayPayPoliciesUpdateRequestFederalHolidaysVeteransDay to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      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:)
+        obj.selected&.is_a?(Boolean) != false || raise("Passed value for field obj.selected is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/industry/types/industry.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module Industry
+    class Industry
+    # @return [String] Company uuid
+      attr_reader :company_uuid
+    # @return [String] North American Industry Classification System (NAICS) is used to classify
+#  businesses with a six digit number based on the primary type of work the
+#  business performs.
+      attr_reader :naics_code
+    # @return [Array<String>] A list of Standard Industrial Classification (SIC) codes, which are four digit
+#  number that categorize the industries that companies belong to based on their
+#  business activities.
+      attr_reader :sic_codes
+    # @return [String] Industry title
+      attr_reader :title
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+    # @return [Object] 
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param company_uuid [String] Company uuid
+      # @param naics_code [String] North American Industry Classification System (NAICS) is used to classify
+#  businesses with a six digit number based on the primary type of work the
+#  business performs.
+      # @param sic_codes [Array<String>] A list of Standard Industrial Classification (SIC) codes, which are four digit
+#  number that categorize the industries that companies belong to based on their
+#  business activities.
+      # @param title [String] Industry title
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Industry::Industry]
+      def initialize(company_uuid: OMIT, naics_code: OMIT, sic_codes: OMIT, title: OMIT, additional_properties: nil)
+        @company_uuid = company_uuid if company_uuid != OMIT
+        @naics_code = naics_code if naics_code != OMIT
+        @sic_codes = sic_codes if sic_codes != OMIT
+        @title = title if title != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "company_uuid": company_uuid, "naics_code": naics_code, "sic_codes": sic_codes, "title": title }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of Industry
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Industry::Industry]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        company_uuid = parsed_json["company_uuid"]
+        naics_code = parsed_json["naics_code"]
+        sic_codes = parsed_json["sic_codes"]
+        title = parsed_json["title"]
+        new(
+          company_uuid: company_uuid,
+          naics_code: naics_code,
+          sic_codes: sic_codes,
+          title: title,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of Industry to a JSON object
+      #
+      # @return [String]
+      def to_json
+        @_field_set&.to_json
+      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:)
+        obj.company_uuid&.is_a?(String) != false || raise("Passed value for field obj.company_uuid is not the expected type, validation failed.")
+        obj.naics_code&.is_a?(String) != false || raise("Passed value for field obj.naics_code is not the expected type, validation failed.")
+        obj.sic_codes&.is_a?(Array) != false || raise("Passed value for field obj.sic_codes is not the expected type, validation failed.")
+        obj.title&.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/invoices/client.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "../types/invoice_data"
+require "async"
+require_relative "../../requests"
+
+module Gusto
+  class InvoicesClient
+  # @return [Gusto::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::InvoicesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Retrieve data for active companies used to calculate invoices for Gusto Embedded
+#  Payroll. A company is considered active for an invoice period if they are an
+#  active partner managed company, have run payroll or created contractor payments
+#  since becoming a partner managed company, and are not suspended at any point
+#  during the invoice period. This endpoint forces pagination, with 100 results
+#  returned at a time. You can learn more about our pagination here: [pagination
+#  guide](https://docs.gusto.com/embedded-payroll/docs/pagination)
+#  > 📘 System Access Authentication
+#  >
+#  > This endpoint uses the [Bearer Auth scheme with the system-level access token
+#  in the HTTP Authorization
+#  header](https://docs.gusto.com/embedded-payroll/docs/system-access)
+#  scope: `invoices:read`
+    #
+    # @param invoice_period [String] The month we are calculating the invoice for. Must be in YYYY-MM format
+    # @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 company_uuids [String] Filter companies returned in the active_companies response, will return an error
+#  if company not active during provided invoice period. i.e.
+#  uuids=781922d8-e780-4b6b-bf74-ee303166d022,bbbca930-7322-491c-ba7f-98707a52a9c5`
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::InvoiceData]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.invoices.retrieve(invoice_period: "2020-01")
+    def retrieve(invoice_period:, page: nil, per: nil, company_uuids: 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, "company_uuids": company_uuids }.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/invoices/#{invoice_period}"
+end
+      Gusto::InvoiceData.from_json(json_object: response.body)
+    end
+  end
+  class AsyncInvoicesClient
+  # @return [Gusto::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AsyncInvoicesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Retrieve data for active companies used to calculate invoices for Gusto Embedded
+#  Payroll. A company is considered active for an invoice period if they are an
+#  active partner managed company, have run payroll or created contractor payments
+#  since becoming a partner managed company, and are not suspended at any point
+#  during the invoice period. This endpoint forces pagination, with 100 results
+#  returned at a time. You can learn more about our pagination here: [pagination
+#  guide](https://docs.gusto.com/embedded-payroll/docs/pagination)
+#  > 📘 System Access Authentication
+#  >
+#  > This endpoint uses the [Bearer Auth scheme with the system-level access token
+#  in the HTTP Authorization
+#  header](https://docs.gusto.com/embedded-payroll/docs/system-access)
+#  scope: `invoices:read`
+    #
+    # @param invoice_period [String] The month we are calculating the invoice for. Must be in YYYY-MM format
+    # @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 company_uuids [String] Filter companies returned in the active_companies response, will return an error
+#  if company not active during provided invoice period. i.e.
+#  uuids=781922d8-e780-4b6b-bf74-ee303166d022,bbbca930-7322-491c-ba7f-98707a52a9c5`
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::InvoiceData]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.invoices.retrieve(invoice_period: "2020-01")
+    def retrieve(invoice_period:, page: nil, per: nil, company_uuids: 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, "company_uuids": company_uuids }.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/invoices/#{invoice_period}"
+end
+        Gusto::InvoiceData.from_json(json_object: response.body)
+      end
+    end
+  end
+end