gusto_embedded_client 0.2.5

data/lib/gusto_embedded/models/shared/federal_holidays.rb

@@ -0,0 +1,51 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class FederalHolidays < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :columbus_day, T.nilable(::GustoEmbedded::Shared::ColumbusDay), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('columbus_day') } }
+
+      field :independence_day, T.nilable(::GustoEmbedded::Shared::IndependenceDay), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('independence_day') } }
+
+      field :juneteenth, T.nilable(::GustoEmbedded::Shared::Juneteenth), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('juneteenth') } }
+
+      field :labor_day, T.nilable(::GustoEmbedded::Shared::LaborDay), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('labor_day') } }
+
+      field :memorial_day, T.nilable(::GustoEmbedded::Shared::MemorialDay), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('memorial_day') } }
+
+      field :mlk_day, T.nilable(::GustoEmbedded::Shared::MlkDay), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('mlk_day') } }
+
+      field :new_years_day, T.nilable(::GustoEmbedded::Shared::NewYearsDay), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('new_years_day') } }
+
+      field :presidents_day, T.nilable(::GustoEmbedded::Shared::PresidentsDay), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('presidents_day') } }
+
+      field :thanksgiving, T.nilable(::GustoEmbedded::Shared::Thanksgiving), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('thanksgiving') } }
+
+      field :veterans_day, T.nilable(::GustoEmbedded::Shared::VeteransDay), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('veterans_day') } }
+
+
+      sig { params(columbus_day: T.nilable(::GustoEmbedded::Shared::ColumbusDay), independence_day: T.nilable(::GustoEmbedded::Shared::IndependenceDay), juneteenth: T.nilable(::GustoEmbedded::Shared::Juneteenth), labor_day: T.nilable(::GustoEmbedded::Shared::LaborDay), memorial_day: T.nilable(::GustoEmbedded::Shared::MemorialDay), mlk_day: T.nilable(::GustoEmbedded::Shared::MlkDay), new_years_day: T.nilable(::GustoEmbedded::Shared::NewYearsDay), presidents_day: T.nilable(::GustoEmbedded::Shared::PresidentsDay), thanksgiving: T.nilable(::GustoEmbedded::Shared::Thanksgiving), veterans_day: T.nilable(::GustoEmbedded::Shared::VeteransDay)).void }
+      def initialize(columbus_day: nil, independence_day: nil, juneteenth: nil, labor_day: nil, memorial_day: nil, mlk_day: nil, new_years_day: nil, presidents_day: nil, thanksgiving: nil, veterans_day: nil)
+        @columbus_day = columbus_day
+        @independence_day = independence_day
+        @juneteenth = juneteenth
+        @labor_day = labor_day
+        @memorial_day = memorial_day
+        @mlk_day = mlk_day
+        @new_years_day = new_years_day
+        @presidents_day = presidents_day
+        @thanksgiving = thanksgiving
+        @veterans_day = veterans_day
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/federal_tax_details.rb

@@ -0,0 +1,67 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Example response
+    class FederalTaxDetails < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # How often the company sends money to the IRS. One of:
+      #   - Semiweekly
+      #   - Monthly
+      field :deposit_schedule, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deposit_schedule') } }
+      # The date that these details took effect.
+      field :effective_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('effective_date') } }
+      # Whether the EIN was able to be verified as a valid EIN with the IRS. 
+      field :ein_verified, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('ein_verified') } }
+      # The form used by the company for federal tax filing. One of:
+      # - 941 (Quarterly federal tax return form)
+      # - 944 (Annual federal tax return form)
+      field :filing_form, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('filing_form') } }
+      # Whether company's Employer Identification Number (EIN) is present
+      field :has_ein, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('has_ein') } }
+      # The legal name of the company
+      field :legal_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('legal_name') } }
+      # 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
+      field :tax_payer_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('tax_payer_type') } }
+      # 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
+      field :taxable_as_scorp, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('taxable_as_scorp') } }
+      # 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.
+      field :version, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('version') } }
+
+
+      sig { params(deposit_schedule: T.nilable(::String), effective_date: T.nilable(::String), ein_verified: T.nilable(T::Boolean), filing_form: T.nilable(::String), has_ein: T.nilable(T::Boolean), legal_name: T.nilable(::String), tax_payer_type: T.nilable(::String), taxable_as_scorp: T.nilable(T::Boolean), version: T.nilable(::String)).void }
+      def initialize(deposit_schedule: nil, effective_date: nil, ein_verified: nil, filing_form: nil, has_ein: nil, legal_name: nil, tax_payer_type: nil, taxable_as_scorp: nil, version: nil)
+        @deposit_schedule = deposit_schedule
+        @effective_date = effective_date
+        @ein_verified = ein_verified
+        @filing_form = filing_form
+        @has_ein = has_ein
+        @legal_name = legal_name
+        @tax_payer_type = tax_payer_type
+        @taxable_as_scorp = taxable_as_scorp
+        @version = version
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/fields_.rb

@@ -0,0 +1,48 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class Fields < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The field's data type
+      field :data_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('data_type') } }
+      # Height of the field
+      field :height, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('height') } }
+      # Unique identifier of the field
+      field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('key') } }
+      # Page number of the field
+      field :page_number, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('page_number') } }
+      # Whether the field is required
+      field :required, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('required') } }
+      # Auto-filled value of the field
+      field :value, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+      # Width of the field
+      field :width, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('width') } }
+      # X-coordinate location of the field on the page
+      field :x, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('x') } }
+      # Y-coordinate location of the field on the page
+      field :y, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('y') } }
+
+
+      sig { params(data_type: T.nilable(::String), height: T.nilable(::Integer), key: T.nilable(::String), page_number: T.nilable(::Integer), required: T.nilable(T::Boolean), value: T.nilable(::String), width: T.nilable(::Integer), x: T.nilable(::Integer), y: T.nilable(::Integer)).void }
+      def initialize(data_type: nil, height: nil, key: nil, page_number: nil, required: nil, value: nil, width: nil, x: nil, y: nil)
+        @data_type = data_type
+        @height = height
+        @key = key
+        @page_number = page_number
+        @required = required
+        @value = value
+        @width = width
+        @x = x
+        @y = y
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/fips_codes.rb

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class FipsCodes < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # FIPS code for state or county
+      field :code, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('code') } }
+      # Name of county in the state for the corresponding FIPS code. When `null` the FIPS code applies state wide.
+      field :county, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('county') } }
+
+
+      sig { params(code: T.nilable(::String), county: T.nilable(::String)).void }
+      def initialize(code: nil, county: nil)
+        @code = code
+        @county = county
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/fixed.rb

@@ -0,0 +1,24 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class Fixed < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The name of the fixed compensation.
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+
+
+      sig { params(name: T.nilable(::String)).void }
+      def initialize(name: nil)
+        @name = name
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/fixed_compensations.rb

@@ -0,0 +1,30 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class FixedCompensations < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The amount of the compensation for the pay period.
+      field :amount, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('amount') } }
+      # The UUID of the job for the compensation.
+      field :job_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('job_uuid') } }
+      # The name of the compensation. This also serves as the unique, immutable identifier for this compensation.
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+
+
+      sig { params(amount: T.nilable(::String), job_uuid: T.nilable(::String), name: T.nilable(::String)).void }
+      def initialize(amount: nil, job_uuid: nil, name: nil)
+        @amount = amount
+        @job_uuid = job_uuid
+        @name = name
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/flow.rb

@@ -0,0 +1,24 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The representation of a flow in Gusto white-label UI.
+    class Flow < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('url') } }
+
+
+      sig { params(url: T.nilable(::String)).void }
+      def initialize(url: nil)
+        @url = url
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/flsa_status_type.rb

@@ -0,0 +1,22 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # FlsaStatusType - The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company. 
+    class FlsaStatusType < T::Enum
+      enums do
+        EXEMPT = new('Exempt')
+        SALARIED_NONEXEMPT = new('Salaried Nonexempt')
+        NONEXEMPT = new('Nonexempt')
+        OWNER = new('Owner')
+        COMMISSION_ONLY_EXEMPT = new('Commission Only Exempt')
+        COMMISSION_ONLY_NONEXEMPT = new('Commission Only Nonexempt')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/form.rb

@@ -0,0 +1,48 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Example response
+    class Form < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The UUID of the form
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The description of the form
+      field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('description') } }
+      # The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.
+      field :document_content_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('document_content_type') } }
+      # 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.
+      field :draft, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('draft') } }
+      # The type identifier of the form
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # 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.
+      field :quarter, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('quarter') } }
+      # A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.
+      field :requires_signing, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('requires_signing') } }
+      # The title of the form
+      field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('title') } }
+      # 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.
+      field :year, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('year') } }
+
+
+      sig { params(uuid: ::String, description: T.nilable(::String), document_content_type: T.nilable(::String), draft: T.nilable(T::Boolean), name: T.nilable(::String), quarter: T.nilable(::Integer), requires_signing: T.nilable(T::Boolean), title: T.nilable(::String), year: T.nilable(::Integer)).void }
+      def initialize(uuid: nil, description: nil, document_content_type: nil, draft: nil, name: nil, quarter: nil, requires_signing: nil, title: nil, year: nil)
+        @uuid = uuid
+        @description = description
+        @document_content_type = document_content_type
+        @draft = draft
+        @name = name
+        @quarter = quarter
+        @requires_signing = requires_signing
+        @title = title
+        @year = year
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/form_1099.rb

@@ -0,0 +1,51 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class Form1099 < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The UUID of the form
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The contractor UUID
+      field :contractor_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contractor_uuid') } }
+      # The description of the form
+      field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('description') } }
+      # The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.
+      field :document_content_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('document_content_type') } }
+      # 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.
+      field :draft, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('draft') } }
+      # The type identifier of the form
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # The quarter of this form. This value is currently always null since it is not present on any contractor forms.
+      field :quarter, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('quarter') } }
+      # A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.
+      field :requires_signing, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('requires_signing') } }
+      # The title of the form
+      field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('title') } }
+      # The year of this form. For some forms, e.g. tax forms, this is the year which the form represents. A 1099 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.
+      field :year, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('year') } }
+
+
+      sig { params(uuid: ::String, contractor_uuid: T.nilable(::String), description: T.nilable(::String), document_content_type: T.nilable(::String), draft: T.nilable(T::Boolean), name: T.nilable(::String), quarter: T.nilable(::Integer), requires_signing: T.nilable(T::Boolean), title: T.nilable(::String), year: T.nilable(::Integer)).void }
+      def initialize(uuid: nil, contractor_uuid: nil, description: nil, document_content_type: nil, draft: nil, name: nil, quarter: nil, requires_signing: nil, title: nil, year: nil)
+        @uuid = uuid
+        @contractor_uuid = contractor_uuid
+        @description = description
+        @document_content_type = document_content_type
+        @draft = draft
+        @name = name
+        @quarter = quarter
+        @requires_signing = requires_signing
+        @title = title
+        @year = year
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/form_pdf.rb

@@ -0,0 +1,30 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Example response
+    class FormPdf < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # the UUID of the form
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.
+      field :document_content_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('document_content_type') } }
+      # the URL of the form
+      field :document_url, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('document_url') } }
+
+
+      sig { params(uuid: ::String, document_content_type: T.nilable(::String), document_url: T.nilable(::String)).void }
+      def initialize(uuid: nil, document_content_type: nil, document_url: nil)
+        @uuid = uuid
+        @document_content_type = document_content_type
+        @document_url = document_url
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/funding_type.rb

@@ -0,0 +1,20 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # FundingType - Company's default funding type
+    class FundingType < T::Enum
+      enums do
+        ACH = new('ach')
+        REVERSE_WIRE = new('reverse_wire')
+        WIRE_IN = new('wire_in')
+        BREX = new('brex')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/garnishment.rb

@@ -0,0 +1,66 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Garnishments, or employee deductions, are fixed amounts or percentages deducted from an employee’s pay. They can be deducted a specific number of times or on a recurring basis. Garnishments can also have maximum deductions on a yearly or per-pay-period bases. Common uses for garnishments are court-ordered payments for child support or back taxes. Some companies provide loans to their employees that are repaid via garnishments.
+    class Garnishment < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The UUID of the garnishment in Gusto.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # Whether or not this garnishment is currently active.
+      field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
+      # The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. "8.00".
+      field :amount, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('amount') } }
+      # The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. "200.00".
+      field :annual_maximum, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('annual_maximum') } }
+      # Additional child support order details
+      field :child_support, T.nilable(::GustoEmbedded::Shared::GarnishmentChildSupport), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('child_support') } }
+      # Whether the garnishment is court ordered.
+      field :court_ordered, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('court_ordered') } }
+      # Whether the amount should be treated as a percentage to be deducted per pay period.
+      field :deduct_as_percentage, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduct_as_percentage') } }
+      # The description of the garnishment.
+      field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('description') } }
+      # The UUID of the employee to which this garnishment belongs.
+      field :employee_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_uuid') } }
+      # The specific type of garnishment for court ordered garnishments.
+      field :garnishment_type, T.nilable(::GustoEmbedded::Shared::GarnishmentType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('garnishment_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::GarnishmentType, true) } }
+      # The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. "16.00".
+      field :pay_period_maximum, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('pay_period_maximum') } }
+      # Whether the garnishment should recur indefinitely.
+      field :recurring, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recurring') } }
+      # The number of times to apply the garnishment. Ignored if recurring is true.
+      field :times, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('times') } }
+      # A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
+      field :total_amount, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('total_amount') } }
+      # 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.
+      field :version, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('version') } }
+
+
+      sig { params(uuid: ::String, active: T.nilable(T::Boolean), amount: T.nilable(::String), annual_maximum: T.nilable(::String), child_support: T.nilable(::GustoEmbedded::Shared::GarnishmentChildSupport), court_ordered: T.nilable(T::Boolean), deduct_as_percentage: T.nilable(T::Boolean), description: T.nilable(::String), employee_uuid: T.nilable(::String), garnishment_type: T.nilable(::GustoEmbedded::Shared::GarnishmentType), pay_period_maximum: T.nilable(::String), recurring: T.nilable(T::Boolean), times: T.nilable(::Integer), total_amount: T.nilable(::String), version: T.nilable(::String)).void }
+      def initialize(uuid: nil, active: nil, amount: nil, annual_maximum: nil, child_support: nil, court_ordered: nil, deduct_as_percentage: nil, description: nil, employee_uuid: nil, garnishment_type: nil, pay_period_maximum: nil, recurring: nil, times: nil, total_amount: nil, version: nil)
+        @uuid = uuid
+        @active = active
+        @amount = amount
+        @annual_maximum = annual_maximum
+        @child_support = child_support
+        @court_ordered = court_ordered
+        @deduct_as_percentage = deduct_as_percentage
+        @description = description
+        @employee_uuid = employee_uuid
+        @garnishment_type = garnishment_type
+        @pay_period_maximum = pay_period_maximum
+        @recurring = recurring
+        @times = times
+        @total_amount = total_amount
+        @version = version
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/garnishment_child_support.rb

@@ -0,0 +1,39 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Additional child support order details
+    class GarnishmentChildSupport < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Child Support Enforcement Case Number associated with this child support obligation - required for most states. Agency specific requirements are available in the `GET /v1/garnishments/child_support` API.
+      field :case_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('case_number') } }
+      # The FIPS code associated with the state or county agency issuing the child support order. Agency data is available in the `GET /v1/garnishments/child_support` API.
+      field :fips_code, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('fips_code') } }
+      # Order Identifier or Order ID associated with this child support obligation - required for some states. Agency specific requirements are available in the `GET /v1/garnishments/child_support` API.
+      field :order_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('order_number') } }
+      # How often the agency collects the withholding amount. e.g. $500 monthly -> `Monthly`.
+      field :payment_period, T.nilable(::GustoEmbedded::Shared::PaymentPeriod), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_period'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PaymentPeriod, true) } }
+      # Child Support Enforcement Remittance ID associated with this child support obligation - required for some states. Agency specific requirements are available in the `GET /v1/garnishments/child_support` API.
+      field :remittance_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('remittance_number') } }
+      # The two letter state abbreviation for the state issuing the child support order. Agency data is available in the `GET /v1/garnishments/child_support` API.
+      field :state, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('state') } }
+
+
+      sig { params(case_number: T.nilable(::String), fips_code: T.nilable(::String), order_number: T.nilable(::String), payment_period: T.nilable(::GustoEmbedded::Shared::PaymentPeriod), remittance_number: T.nilable(::String), state: T.nilable(::String)).void }
+      def initialize(case_number: nil, fips_code: nil, order_number: nil, payment_period: nil, remittance_number: nil, state: nil)
+        @case_number = case_number
+        @fips_code = fips_code
+        @order_number = order_number
+        @payment_period = payment_period
+        @remittance_number = remittance_number
+        @state = state
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/garnishment_type.rb

@@ -0,0 +1,23 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # GarnishmentType - The specific type of garnishment for court ordered garnishments.
+    class GarnishmentType < T::Enum
+      enums do
+        CHILD_SUPPORT = new('child_support')
+        FEDERAL_TAX_LIEN = new('federal_tax_lien')
+        STATE_TAX_LIEN = new('state_tax_lien')
+        STUDENT_LOAN = new('student_loan')
+        CREDITOR_GARNISHMENT = new('creditor_garnishment')
+        FEDERAL_LOAN = new('federal_loan')
+        OTHER_GARNISHMENT = new('other_garnishment')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/generated_document.rb

@@ -0,0 +1,30 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Example response
+    class GeneratedDocument < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The array of urls to access the documents.
+      field :document_urls, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('document_urls') } }
+      # A unique identifier of the Generated Document request
+      field :request_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('request_uuid') } }
+      # Current status of the Generated Document
+      field :status, T.nilable(::GustoEmbedded::Shared::GeneratedDocumentStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::GeneratedDocumentStatus, true) } }
+
+
+      sig { params(document_urls: T.nilable(T::Array[::String]), request_uuid: T.nilable(::String), status: T.nilable(::GustoEmbedded::Shared::GeneratedDocumentStatus)).void }
+      def initialize(document_urls: nil, request_uuid: nil, status: nil)
+        @document_urls = document_urls
+        @request_uuid = request_uuid
+        @status = status
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/generated_document_status.rb

@@ -0,0 +1,20 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # GeneratedDocumentStatus - Current status of the Generated Document
+    class GeneratedDocumentStatus < T::Enum
+      enums do
+        PENDING = new('pending')
+        STARTED = new('started')
+        SUCCEEDED = new('succeeded')
+        FAILED = new('failed')
+      end
+    end
+  end
+end