fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/external_payrolls/types/tax_liabilities_selections.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require_relative "tax_liabilities_selections_possible_liabilities"
+require "ostruct"
+require "json"
+
+module Gusto
+  module ExternalPayrolls
+# The representation of tax liabilities selections.
+    class TaxLiabilitiesSelections
+    # @return [Integer] The ID of the tax.
+      attr_reader :tax_id
+    # @return [String] The name of the tax.
+      attr_reader :tax_name
+    # @return [String] The UUID of last unpaid external payroll.
+      attr_reader :last_unpaid_external_payroll_uuid
+    # @return [Gusto::ExternalPayrolls::TaxLiabilitiesSelectionsPossibleLiabilities] Possible tax liabilities selections.
+      attr_reader :possible_liabilities
+    # @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 tax_id [Integer] The ID of the tax.
+      # @param tax_name [String] The name of the tax.
+      # @param last_unpaid_external_payroll_uuid [String] The UUID of last unpaid external payroll.
+      # @param possible_liabilities [Gusto::ExternalPayrolls::TaxLiabilitiesSelectionsPossibleLiabilities] Possible tax liabilities selections.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::ExternalPayrolls::TaxLiabilitiesSelections]
+      def initialize(tax_id: OMIT, tax_name: OMIT, last_unpaid_external_payroll_uuid: OMIT, possible_liabilities: OMIT, additional_properties: nil)
+        @tax_id = tax_id if tax_id != OMIT
+        @tax_name = tax_name if tax_name != OMIT
+        @last_unpaid_external_payroll_uuid = last_unpaid_external_payroll_uuid if last_unpaid_external_payroll_uuid != OMIT
+        @possible_liabilities = possible_liabilities if possible_liabilities != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "tax_id": tax_id, "tax_name": tax_name, "last_unpaid_external_payroll_uuid": last_unpaid_external_payroll_uuid, "possible_liabilities": possible_liabilities }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of TaxLiabilitiesSelections
+      #
+      # @param json_object [String] 
+      # @return [Gusto::ExternalPayrolls::TaxLiabilitiesSelections]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        tax_id = parsed_json["tax_id"]
+        tax_name = parsed_json["tax_name"]
+        last_unpaid_external_payroll_uuid = parsed_json["last_unpaid_external_payroll_uuid"]
+        unless parsed_json["possible_liabilities"].nil?
+          possible_liabilities = parsed_json["possible_liabilities"].to_json
+          possible_liabilities = Gusto::ExternalPayrolls::TaxLiabilitiesSelectionsPossibleLiabilities.from_json(json_object: possible_liabilities)
+        else
+          possible_liabilities = nil
+        end
+        new(
+          tax_id: tax_id,
+          tax_name: tax_name,
+          last_unpaid_external_payroll_uuid: last_unpaid_external_payroll_uuid,
+          possible_liabilities: possible_liabilities,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of TaxLiabilitiesSelections 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.tax_id&.is_a?(Integer) != false || raise("Passed value for field obj.tax_id is not the expected type, validation failed.")
+        obj.tax_name&.is_a?(String) != false || raise("Passed value for field obj.tax_name is not the expected type, validation failed.")
+        obj.last_unpaid_external_payroll_uuid&.is_a?(String) != false || raise("Passed value for field obj.last_unpaid_external_payroll_uuid is not the expected type, validation failed.")
+        obj.possible_liabilities.nil? || Gusto::ExternalPayrolls::TaxLiabilitiesSelectionsPossibleLiabilities.validate_raw(obj: obj.possible_liabilities)
+      end
+    end
+  end
+end

data/lib/fern_gusto/external_payrolls/types/tax_liabilities_selections_possible_liabilities.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module ExternalPayrolls
+# Possible tax liabilities selections.
+    class TaxLiabilitiesSelectionsPossibleLiabilities
+    # @return [String] Liability amount.
+      attr_reader :liability_amount
+    # @return [String] The external payroll check date.
+      attr_reader :payroll_check_date
+    # @return [String] The UUID of the external payroll.
+      attr_reader :external_payroll_uuid
+    # @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 liability_amount [String] Liability amount.
+      # @param payroll_check_date [String] The external payroll check date.
+      # @param external_payroll_uuid [String] The UUID of the external payroll.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::ExternalPayrolls::TaxLiabilitiesSelectionsPossibleLiabilities]
+      def initialize(liability_amount: OMIT, payroll_check_date: OMIT, external_payroll_uuid: OMIT, additional_properties: nil)
+        @liability_amount = liability_amount if liability_amount != OMIT
+        @payroll_check_date = payroll_check_date if payroll_check_date != OMIT
+        @external_payroll_uuid = external_payroll_uuid if external_payroll_uuid != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "liability_amount": liability_amount, "payroll_check_date": payroll_check_date, "external_payroll_uuid": external_payroll_uuid }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of
+#  TaxLiabilitiesSelectionsPossibleLiabilities
+      #
+      # @param json_object [String] 
+      # @return [Gusto::ExternalPayrolls::TaxLiabilitiesSelectionsPossibleLiabilities]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        liability_amount = parsed_json["liability_amount"]
+        payroll_check_date = parsed_json["payroll_check_date"]
+        external_payroll_uuid = parsed_json["external_payroll_uuid"]
+        new(
+          liability_amount: liability_amount,
+          payroll_check_date: payroll_check_date,
+          external_payroll_uuid: external_payroll_uuid,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of TaxLiabilitiesSelectionsPossibleLiabilities 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.liability_amount&.is_a?(String) != false || raise("Passed value for field obj.liability_amount is not the expected type, validation failed.")
+        obj.payroll_check_date&.is_a?(String) != false || raise("Passed value for field obj.payroll_check_date is not the expected type, validation failed.")
+        obj.external_payroll_uuid&.is_a?(String) != false || raise("Passed value for field obj.external_payroll_uuid is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/federal_tax_details/types/federal_tax_details.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module FederalTaxDetails
+    class FederalTaxDetails
+    # @return [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.
+      attr_reader :version
+    # @return [String] What type of tax entity the company is. One of:
+#  - C-Corporation
+#  - S-Corporation
+#  - Sole proprietor
+#  - LLC
+#  - LLP
+#  - Limited partnership
+#  - Co-ownership
+#  - Association
+#  - Trusteeship
+#  - General partnership
+#  - Joint venture
+#  - Non-Profit
+      attr_reader :tax_payer_type
+    # @return [Boolean] Whether the company is taxed as an S-Corporation. Tax payer types that may be
+#  taxed as an S-Corporation include:
+#  - S-Corporation
+#  - C-Corporation
+#  - LLC
+      attr_reader :taxable_as_scorp
+    # @return [String] The form used by the company for federal tax filing. One of:
+#  - 941 (Quarterly federal tax return form)
+#  - 944 (Annual federal tax return form)
+      attr_reader :filing_form
+    # @return [Boolean] Whether company's Employer Identification Number (EIN) is present
+      attr_reader :has_ein
+    # @return [Boolean] Whether the EIN was able to be verified as a valid EIN with the IRS.
+      attr_reader :ein_verified
+    # @return [String] The legal name of the company
+      attr_reader :legal_name
+    # @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 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 tax_payer_type [String] What type of tax entity the company is. One of:
+#  - C-Corporation
+#  - S-Corporation
+#  - Sole proprietor
+#  - LLC
+#  - LLP
+#  - Limited partnership
+#  - Co-ownership
+#  - Association
+#  - Trusteeship
+#  - General partnership
+#  - Joint venture
+#  - Non-Profit
+      # @param taxable_as_scorp [Boolean] Whether the company is taxed as an S-Corporation. Tax payer types that may be
+#  taxed as an S-Corporation include:
+#  - S-Corporation
+#  - C-Corporation
+#  - LLC
+      # @param filing_form [String] The form used by the company for federal tax filing. One of:
+#  - 941 (Quarterly federal tax return form)
+#  - 944 (Annual federal tax return form)
+      # @param has_ein [Boolean] Whether company's Employer Identification Number (EIN) is present
+      # @param ein_verified [Boolean] Whether the EIN was able to be verified as a valid EIN with the IRS.
+      # @param legal_name [String] The legal name of the company
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::FederalTaxDetails::FederalTaxDetails]
+      def initialize(version: OMIT, tax_payer_type: OMIT, taxable_as_scorp: OMIT, filing_form: OMIT, has_ein: OMIT, ein_verified: OMIT, legal_name: OMIT, additional_properties: nil)
+        @version = version if version != OMIT
+        @tax_payer_type = tax_payer_type if tax_payer_type != OMIT
+        @taxable_as_scorp = taxable_as_scorp if taxable_as_scorp != OMIT
+        @filing_form = filing_form if filing_form != OMIT
+        @has_ein = has_ein if has_ein != OMIT
+        @ein_verified = ein_verified if ein_verified != OMIT
+        @legal_name = legal_name if legal_name != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "version": version, "tax_payer_type": tax_payer_type, "taxable_as_scorp": taxable_as_scorp, "filing_form": filing_form, "has_ein": has_ein, "ein_verified": ein_verified, "legal_name": legal_name }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of FederalTaxDetails
+      #
+      # @param json_object [String] 
+      # @return [Gusto::FederalTaxDetails::FederalTaxDetails]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        version = parsed_json["version"]
+        tax_payer_type = parsed_json["tax_payer_type"]
+        taxable_as_scorp = parsed_json["taxable_as_scorp"]
+        filing_form = parsed_json["filing_form"]
+        has_ein = parsed_json["has_ein"]
+        ein_verified = parsed_json["ein_verified"]
+        legal_name = parsed_json["legal_name"]
+        new(
+          version: version,
+          tax_payer_type: tax_payer_type,
+          taxable_as_scorp: taxable_as_scorp,
+          filing_form: filing_form,
+          has_ein: has_ein,
+          ein_verified: ein_verified,
+          legal_name: legal_name,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of FederalTaxDetails 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.version&.is_a?(String) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
+        obj.tax_payer_type&.is_a?(String) != false || raise("Passed value for field obj.tax_payer_type is not the expected type, validation failed.")
+        obj.taxable_as_scorp&.is_a?(Boolean) != false || raise("Passed value for field obj.taxable_as_scorp is not the expected type, validation failed.")
+        obj.filing_form&.is_a?(String) != false || raise("Passed value for field obj.filing_form is not the expected type, validation failed.")
+        obj.has_ein&.is_a?(Boolean) != false || raise("Passed value for field obj.has_ein is not the expected type, validation failed.")
+        obj.ein_verified&.is_a?(Boolean) != false || raise("Passed value for field obj.ein_verified is not the expected type, validation failed.")
+        obj.legal_name&.is_a?(String) != false || raise("Passed value for field obj.legal_name is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/fern_gusto/flows/client.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "types/flows_create_request_entity_type"
+require_relative "types/flow"
+require "async"
+require_relative "../../requests"
+
+module Gusto
+  class FlowsClient
+  # @return [Gusto::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::FlowsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Generate a link to access a pre-built workflow in Gusto white-label UI. For
+#  security, all generated flows will expire within 1 hour of inactivity or 24
+#  hours from creation time, whichever comes first.
+#  scope: `flows:write`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param flow_type [String] flow type
+    # @param entity_uuid [String] UUID of the target entity applicable to the flow. This field is optional for
+#  company flows, please refer to the flow_types table above for more details.
+    # @param entity_type [Gusto::Flows::FlowsCreateRequestEntityType] the type of target entity applicable to the flow. This field is optional for
+#  company flows, please refer to the flow_types table above for more details.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Flows::Flow]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.flows.create(company_uuid: "company_uuid", flow_type: "company_onboarding")
+    def create(company_uuid:, flow_type:, entity_uuid: nil, entity_type: 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 || {}), flow_type: flow_type, entity_uuid: entity_uuid, entity_type: entity_type }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/flows"
+end
+      Gusto::Flows::Flow.from_json(json_object: response.body)
+    end
+  end
+  class AsyncFlowsClient
+  # @return [Gusto::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AsyncFlowsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Generate a link to access a pre-built workflow in Gusto white-label UI. For
+#  security, all generated flows will expire within 1 hour of inactivity or 24
+#  hours from creation time, whichever comes first.
+#  scope: `flows:write`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param flow_type [String] flow type
+    # @param entity_uuid [String] UUID of the target entity applicable to the flow. This field is optional for
+#  company flows, please refer to the flow_types table above for more details.
+    # @param entity_type [Gusto::Flows::FlowsCreateRequestEntityType] the type of target entity applicable to the flow. This field is optional for
+#  company flows, please refer to the flow_types table above for more details.
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Gusto::Flows::Flow]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.flows.create(company_uuid: "company_uuid", flow_type: "company_onboarding")
+    def create(company_uuid:, flow_type:, entity_uuid: nil, entity_type: 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 || {}), flow_type: flow_type, entity_uuid: entity_uuid, entity_type: entity_type }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/flows"
+end
+        Gusto::Flows::Flow.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/fern_gusto/flows/types/flow.rb

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

data/lib/fern_gusto/flows/types/flows_create_request_entity_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Flows
+# the type of target entity applicable to the flow. This field is optional for
+#  company flows, please refer to the flow_types table above for more details.
+    class FlowsCreateRequestEntityType
+
+      COMPANY = "Company"
+      EMPLOYEE = "Employee"
+
+    end
+  end
+end

data/lib/fern_gusto/forms/types/form.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  module Forms
+    class Form
+    # @return [String] The UUID of the form
+      attr_reader :uuid
+    # @return [String] The type identifier of the form
+      attr_reader :name
+    # @return [String] The title of the form
+      attr_reader :title
+    # @return [String] The description of the form
+      attr_reader :description
+    # @return [Boolean] If the form is in a draft state. E.g. End of year tax forms may be provided in a
+#  draft state prior to being finalized.
+      attr_reader :draft
+    # @return [Integer] The year of this form. For some forms, e.g. tax forms, this is the year which
+#  the form represents. A W2 for January - December 2022 would be delivered in
+#  January 2023 and have a year value of 2022. This value is nullable and will not
+#  be present on all forms.
+      attr_reader :year
+    # @return [Integer] The quarter of this form. For some forms, e.g. tax forms, this is the calendar
+#  quarter which this form represents. An Employer's Quarterly Federal Tax Return
+#  (Form 941) for April, May, June 2022 would have a quarter value of 2 (and a year
+#  value of 2022). This value is nullable and will not be present on all forms.
+      attr_reader :quarter
+    # @return [Boolean] A boolean flag that indicates whether the form needs signing or not. Note that
+#  this value will change after the form is signed.
+      attr_reader :requires_signing
+    # @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 uuid [String] The UUID of the form
+      # @param name [String] The type identifier of the form
+      # @param title [String] The title of the form
+      # @param description [String] The description of the form
+      # @param draft [Boolean] If the form is in a draft state. E.g. End of year tax forms may be provided in a
+#  draft state prior to being finalized.
+      # @param year [Integer] The year of this form. For some forms, e.g. tax forms, this is the year which
+#  the form represents. A W2 for January - December 2022 would be delivered in
+#  January 2023 and have a year value of 2022. This value is nullable and will not
+#  be present on all forms.
+      # @param quarter [Integer] The quarter of this form. For some forms, e.g. tax forms, this is the calendar
+#  quarter which this form represents. An Employer's Quarterly Federal Tax Return
+#  (Form 941) for April, May, June 2022 would have a quarter value of 2 (and a year
+#  value of 2022). This value is nullable and will not be present on all forms.
+      # @param requires_signing [Boolean] A boolean flag that indicates whether the form needs signing or not. Note that
+#  this value will change after the form is signed.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Forms::Form]
+      def initialize(uuid:, name: OMIT, title: OMIT, description: OMIT, draft: OMIT, year: OMIT, quarter: OMIT, requires_signing: OMIT, additional_properties: nil)
+        @uuid = uuid
+        @name = name if name != OMIT
+        @title = title if title != OMIT
+        @description = description if description != OMIT
+        @draft = draft if draft != OMIT
+        @year = year if year != OMIT
+        @quarter = quarter if quarter != OMIT
+        @requires_signing = requires_signing if requires_signing != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "uuid": uuid, "name": name, "title": title, "description": description, "draft": draft, "year": year, "quarter": quarter, "requires_signing": requires_signing }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of Form
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Forms::Form]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        uuid = parsed_json["uuid"]
+        name = parsed_json["name"]
+        title = parsed_json["title"]
+        description = parsed_json["description"]
+        draft = parsed_json["draft"]
+        year = parsed_json["year"]
+        quarter = parsed_json["quarter"]
+        requires_signing = parsed_json["requires_signing"]
+        new(
+          uuid: uuid,
+          name: name,
+          title: title,
+          description: description,
+          draft: draft,
+          year: year,
+          quarter: quarter,
+          requires_signing: requires_signing,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of Form 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.uuid.is_a?(String) != false || raise("Passed value for field obj.uuid is not the expected type, validation failed.")
+        obj.name&.is_a?(String) != false || raise("Passed value for field obj.name 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.")
+        obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+        obj.draft&.is_a?(Boolean) != false || raise("Passed value for field obj.draft is not the expected type, validation failed.")
+        obj.year&.is_a?(Integer) != false || raise("Passed value for field obj.year is not the expected type, validation failed.")
+        obj.quarter&.is_a?(Integer) != false || raise("Passed value for field obj.quarter is not the expected type, validation failed.")
+        obj.requires_signing&.is_a?(Boolean) != false || raise("Passed value for field obj.requires_signing is not the expected type, validation failed.")
+      end
+    end
+  end
+end