gusto_embedded_client 0.2.5

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

@@ -0,0 +1,18 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # AccountType - Bank account type
+    class AccountType < T::Enum
+      enums do
+        CHECKING = new('Checking')
+        SAVINGS = new('Savings')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/accruing_time_off_hour.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
+  
+    # The representation of an unprocessed termination pay period.
+    class AccruingTimeOffHour < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Hours accrued during this pay period.
+      field :hours, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('hours') } }
+      # A unique identifier of the time off policy.
+      field :time_off_policy_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('time_off_policy_uuid') } }
+
+
+      sig { params(hours: T.nilable(::String), time_off_policy_uuid: T.nilable(::String)).void }
+      def initialize(hours: nil, time_off_policy_uuid: nil)
+        @hours = hours
+        @time_off_policy_uuid = time_off_policy_uuid
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Representation of an ACH transaction
+    class AchTransaction < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Unique identifier of an ACH transaction
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The amount of money moved by the ACH transaction. This amount is always non-negative.
+      field :amount, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('amount') } }
+      # Unique identifier of the company to which the ACH transaction belongs
+      field :company_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # The description of the ACH transaction. Can be used to identify the ACH transaction on the recipient's bank statement.
+      field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('description') } }
+      # The error code associated with the ACH transaction, if any. If there is no error on the ACH transaction, this field will be nil. See [this article](https://engineering.gusto.com/how-ach-works-a-developer-perspective-part-2/) for a complete list of ACH return codes.
+      field :error_code, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('error_code') } }
+      # The date of the payment associated with the ACH transaction
+      field :payment_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_date') } }
+      # The direction of the payment
+      field :payment_direction, T.nilable(::GustoEmbedded::Shared::PaymentDirection), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_direction'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PaymentDirection, true) } }
+      # The date of the payment event check associated with the ACH transaction
+      field :payment_event_check_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_event_check_date') } }
+      # The type of payment event associated with the ACH transaction
+      field :payment_event_type, T.nilable(::GustoEmbedded::Shared::PaymentEventType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_event_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PaymentEventType, true) } }
+      # Unique identifier for the payment event associated with the ACH transaction
+      field :payment_event_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_event_uuid') } }
+      # The status of the ACH transaction
+      field :payment_status, T.nilable(::GustoEmbedded::Shared::PaymentStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PaymentStatus, true) } }
+      # The type of recipient associated with the ACH transaction
+      field :recipient_type, T.nilable(::GustoEmbedded::Shared::AchTransactionRecipientType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::AchTransactionRecipientType, true) } }
+      # Unique identifier for the recipient associated with the ACH transaction
+      field :recipient_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_uuid') } }
+      # The type of transaction associated with the ACH transaction
+      field :transaction_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('transaction_type') } }
+
+
+      sig { params(uuid: ::String, amount: T.nilable(::String), company_uuid: T.nilable(::String), description: T.nilable(::String), error_code: T.nilable(::String), payment_date: T.nilable(::String), payment_direction: T.nilable(::GustoEmbedded::Shared::PaymentDirection), payment_event_check_date: T.nilable(::String), payment_event_type: T.nilable(::GustoEmbedded::Shared::PaymentEventType), payment_event_uuid: T.nilable(::String), payment_status: T.nilable(::GustoEmbedded::Shared::PaymentStatus), recipient_type: T.nilable(::GustoEmbedded::Shared::AchTransactionRecipientType), recipient_uuid: T.nilable(::String), transaction_type: T.nilable(::String)).void }
+      def initialize(uuid: nil, amount: nil, company_uuid: nil, description: nil, error_code: nil, payment_date: nil, payment_direction: nil, payment_event_check_date: nil, payment_event_type: nil, payment_event_uuid: nil, payment_status: nil, recipient_type: nil, recipient_uuid: nil, transaction_type: nil)
+        @uuid = uuid
+        @amount = amount
+        @company_uuid = company_uuid
+        @description = description
+        @error_code = error_code
+        @payment_date = payment_date
+        @payment_direction = payment_direction
+        @payment_event_check_date = payment_event_check_date
+        @payment_event_type = payment_event_type
+        @payment_event_uuid = payment_event_uuid
+        @payment_status = payment_status
+        @recipient_type = recipient_type
+        @recipient_uuid = recipient_uuid
+        @transaction_type = transaction_type
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # AchTransactionRecipientType - The type of recipient associated with the ACH transaction
+    class AchTransactionRecipientType < T::Enum
+      enums do
+        EMPLOYEE = new('Employee')
+        CONTRACTOR = new('Contractor')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class ActiveCompanies < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The number of active contractors the company was or will be invoiced for that invoice period. Active contractors are calculated as any contractor with an active contractor payment during the invoice period.
+      field :active_contractors, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active_contractors') } }
+      # The number of active employees the company was or will be invoiced for that invoice period. Active employees are calculated as the count of onboarded employees hired before the end of the invoice period and not terminated before the start of the invoice period.
+      field :active_employees, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active_employees') } }
+      # unique identifier for the company associated with the invoice data
+      field :company_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # The first invoice period for the company. This will either be the invoice period of the first invoice-able event (first payroll or contractor payment) or the date they migrated to embedded, whichever is later.
+      field :initial_invoice_period, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('initial_invoice_period') } }
+
+
+      sig { params(active_contractors: T.nilable(::Integer), active_employees: T.nilable(::Integer), company_uuid: T.nilable(::String), initial_invoice_period: T.nilable(::String)).void }
+      def initialize(active_contractors: nil, active_employees: nil, company_uuid: nil, initial_invoice_period: nil)
+        @active_contractors = active_contractors
+        @active_employees = active_employees
+        @company_uuid = company_uuid
+        @initial_invoice_period = initial_invoice_period
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/address.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
+  
+    # The contractor’s home address.
+    class Address < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :city, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('city') } }
+
+      field :country, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('country') } }
+
+      field :state, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('state') } }
+
+      field :street_1, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('street_1') } }
+
+      field :street_2, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('street_2') } }
+
+      field :zip, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('zip') } }
+
+
+      sig { params(city: T.nilable(::String), country: T.nilable(::String), state: T.nilable(::String), street_1: T.nilable(::String), street_2: T.nilable(::String), zip: T.nilable(::String)).void }
+      def initialize(city: nil, country: nil, state: nil, street_1: nil, street_2: nil, zip: nil)
+        @city = city
+        @country = country
+        @state = state
+        @street_1 = street_1
+        @street_2 = street_2
+        @zip = zip
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The representation of an admin user in Gusto.
+    class Admin < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The unique id of the admin.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The email of the admin for Gusto's system. If the email matches an existing user, this will create an admin account for them.
+      field :email, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('email') } }
+      # The first name of the admin.
+      field :first_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('first_name') } }
+      # The last name of the admin.
+      field :last_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('last_name') } }
+
+
+      sig { params(uuid: ::String, email: T.nilable(::String), first_name: T.nilable(::String), last_name: T.nilable(::String)).void }
+      def initialize(uuid: nil, email: nil, first_name: nil, last_name: nil)
+        @uuid = uuid
+        @email = email
+        @first_name = first_name
+        @last_name = last_name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class Agencies < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # FIPS codes for state or county child support orders
+      field :fips_codes, T.nilable(T::Array[::GustoEmbedded::Shared::FipsCodes]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('fips_codes') } }
+      # Specifies if remitting payment to the agency is required outside of Gusto. If true, Gusto includes garnishment amounts for this agency in payroll calculation, but does not debit for or remit payment to the agency automatically. As of September 2024, only garnishments for South Carolina Integrated Child Support Services require manual payment.
+      # 
+      field :manual_payment_required, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('manual_payment_required') } }
+      # Name of state child support agency
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # Describes which child support case identifying attributes are required for this agency. While most agencies only require a single identifier, some (e.g. OH) require multiple identifiers.
+      field :required_attributes, T.nilable(T::Array[::GustoEmbedded::Shared::RequiredAttributes]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('required_attributes') } }
+      # Two letter state abbreviation
+      field :state, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('state') } }
+
+
+      sig { params(fips_codes: T.nilable(T::Array[::GustoEmbedded::Shared::FipsCodes]), manual_payment_required: T.nilable(T::Boolean), name: T.nilable(::String), required_attributes: T.nilable(T::Array[::GustoEmbedded::Shared::RequiredAttributes]), state: T.nilable(::String)).void }
+      def initialize(fips_codes: nil, manual_payment_required: nil, name: nil, required_attributes: nil, state: nil)
+        @fips_codes = fips_codes
+        @manual_payment_required = manual_payment_required
+        @name = name
+        @required_attributes = required_attributes
+        @state = state
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/applicable_benefits.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 ApplicableBenefits < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
+
+      field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('description') } }
+
+      field :id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('id') } }
+
+
+      sig { params(active: T.nilable(T::Boolean), description: T.nilable(::String), id: T.nilable(::Integer)).void }
+      def initialize(active: nil, description: nil, id: nil)
+        @active = active
+        @description = description
+        @id = id
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class ApplicableEarnings < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :category, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('category') } }
+
+      field :earning_id, T.nilable(::Float), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('earning_id') } }
+
+      field :earning_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('earning_type') } }
+
+      field :input_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('input_type') } }
+
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+
+
+      sig { params(category: T.nilable(::String), earning_id: T.nilable(::Float), earning_type: T.nilable(::String), input_type: T.nilable(::String), name: T.nilable(::String)).void }
+      def initialize(category: nil, earning_id: nil, earning_type: nil, input_type: nil, name: nil)
+        @category = category
+        @earning_id = earning_id
+        @earning_type = earning_type
+        @input_type = input_type
+        @name = name
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/applicable_if.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 ApplicableIf < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # An identifier for an individual requirement. Uniqueness is guaranteed within a requirement set.
+      field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('key') } }
+      # The required value of the requirement identified by `key`
+      field :value, T.nilable(::Object), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+
+      sig { params(key: T.nilable(::String), value: T.nilable(::Object)).void }
+      def initialize(key: nil, value: nil)
+        @key = key
+        @value = value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class ApplicableTaxes < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Some taxes may have an amount withheld from the employee and an amount withheld from the employer, e.g. Social Security. A `true` value indicates this is the employer's amount.
+      field :employer_tax, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employer_tax') } }
+
+      field :id, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('id') } }
+
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # Some taxes may have different rates or reporting requirements depending on if the employee is a resident or non-resident of the tax jurisdiction.
+      field :resident_tax, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('resident_tax') } }
+
+
+      sig { params(employer_tax: T.nilable(T::Boolean), id: T.nilable(::Integer), name: T.nilable(::String), resident_tax: T.nilable(T::Boolean)).void }
+      def initialize(employer_tax: nil, id: nil, name: nil, resident_tax: nil)
+        @employer_tax = employer_tax
+        @id = id
+        @name = name
+        @resident_tax = resident_tax
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/authentication.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
+  
+    # Example response
+    class Authentication < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # A new access token that can be used for subsequent authenticated requests
+      field :access_token, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('access_token') } }
+      # Datetime for when the new access token is created.
+      field :created_at, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('created_at') } }
+      # The TTL of this token. After this amount of time, you must hit the refresh token endpoint to continue making authenticated requests.
+      field :expires_in, T.nilable(::Float), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('expires_in') } }
+      # A token that must be passed to the refresh token endpoint to get a new authenticated token.
+      field :refresh_token, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('refresh_token') } }
+      # All of the scopes for which the access token provides access.
+      field :scope, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('scope') } }
+      # The literal string 'bearer'
+      field :token_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('token_type') } }
+
+
+      sig { params(access_token: T.nilable(::String), created_at: T.nilable(::String), expires_in: T.nilable(::Float), refresh_token: T.nilable(::String), scope: T.nilable(::String), token_type: T.nilable(::String)).void }
+      def initialize(access_token: nil, created_at: nil, expires_in: nil, refresh_token: nil, scope: nil, token_type: nil)
+        @access_token = access_token
+        @created_at = created_at
+        @expires_in = expires_in
+        @refresh_token = refresh_token
+        @scope = scope
+        @token_type = token_type
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/authorization_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
+  
+    # AuthorizationStatus - The employee's authorization status
+    class AuthorizationStatus < T::Enum
+      enums do
+        CITIZEN = new('citizen')
+        NONCITIZEN = new('noncitizen')
+        PERMANENT_RESIDENT = new('permanent_resident')
+        ALIEN = new('alien')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefit_summary.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
+  
+    # Benefit summary response
+    class BenefitSummary < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The aggregate of company contribution for all employees given the period of time and the specific company benefit.
+      field :company_benefit_contribution, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_benefit_contribution') } }
+      # The aggregate of employee deduction for all employees given the period of time and the specific company benefit.
+      field :company_benefit_deduction, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_benefit_deduction') } }
+      # Description of the benefit.
+      field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('description') } }
+
+      field :employees, T.nilable(::GustoEmbedded::Shared::BenefitSummaryEmployees), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employees') } }
+      # The end date of benefit summary.
+      field :end_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('end_date') } }
+      # The start date of benefit summary.
+      field :start_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('start_date') } }
+
+
+      sig { params(company_benefit_contribution: T.nilable(::String), company_benefit_deduction: T.nilable(::String), description: T.nilable(::String), employees: T.nilable(::GustoEmbedded::Shared::BenefitSummaryEmployees), end_date: T.nilable(::String), start_date: T.nilable(::String)).void }
+      def initialize(company_benefit_contribution: nil, company_benefit_deduction: nil, description: nil, employees: nil, end_date: nil, start_date: nil)
+        @company_benefit_contribution = company_benefit_contribution
+        @company_benefit_deduction = company_benefit_deduction
+        @description = description
+        @employees = employees
+        @end_date = end_date
+        @start_date = start_date
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class BenefitSummaryEmployees < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The sum of company contribution for this employee given the period of time and the benefit type.
+      field :benefit_contribution, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('benefit_contribution') } }
+      # The sum of employee benefit deduction for this employee given the period of time and the benefit type.
+      field :benefit_deduction, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('benefit_deduction') } }
+      # The sum of company contribution for this employee given the period of time and the specific company benefit.
+      field :company_benefit_contribution, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_benefit_contribution') } }
+      # The sum of employee deduction for this employee given the period of time and the specific company benefit.
+      field :company_benefit_deduction, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_benefit_deduction') } }
+      # Gross pay for this employee given the period of time.
+      field :gross_pay, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('gross_pay') } }
+      # Total imputed pay for this employee given the period of time (not scoped to a benefit type).
+      field :imputed_pay, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('imputed_pay') } }
+
+      field :payroll_benefits, T.nilable(::GustoEmbedded::Shared::PayrollBenefits), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payroll_benefits') } }
+      # The UUID of the employee
+      field :uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+
+
+      sig { params(benefit_contribution: T.nilable(::String), benefit_deduction: T.nilable(::String), company_benefit_contribution: T.nilable(::String), company_benefit_deduction: T.nilable(::String), gross_pay: T.nilable(::String), imputed_pay: T.nilable(::String), payroll_benefits: T.nilable(::GustoEmbedded::Shared::PayrollBenefits), uuid: T.nilable(::String)).void }
+      def initialize(benefit_contribution: nil, benefit_deduction: nil, company_benefit_contribution: nil, company_benefit_deduction: nil, gross_pay: nil, imputed_pay: nil, payroll_benefits: nil, uuid: nil)
+        @benefit_contribution = benefit_contribution
+        @benefit_deduction = benefit_deduction
+        @company_benefit_contribution = company_benefit_contribution
+        @company_benefit_deduction = company_benefit_deduction
+        @gross_pay = gross_pay
+        @imputed_pay = imputed_pay
+        @payroll_benefits = payroll_benefits
+        @uuid = uuid
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/benefit_summary_pay_period.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 BenefitSummaryPayPeriod < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The end of the payroll's pay period.
+      field :end_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('end_date') } }
+      # The beginning of the payroll's pay period.
+      field :start_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('start_date') } }
+
+
+      sig { params(end_date: T.nilable(::String), start_date: T.nilable(::String)).void }
+      def initialize(end_date: nil, start_date: nil)
+        @end_date = end_date
+        @start_date = start_date
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Benefit type requirements response
+    class BenefitTypeRequirements < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Whether the employee should use a benefit’s 'catch up' rate. Only Roth 401k and 401k benefits use this value for employees over 50.
+      field :catch_up, T.nilable(::GustoEmbedded::Shared::CatchUp), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('catch_up') } }
+      # The maximum company contribution amount per year. A null value signifies no limit.
+      field :company_contribution_annual_maximum, T.nilable(::GustoEmbedded::Shared::CompanyContributionAnnualMaximum), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution_annual_maximum') } }
+      # An object representing the type and value of the company contribution.
+      field :contribution, T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsContribution), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contribution') } }
+      # The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.
+      field :coverage_amount, T.nilable(::GustoEmbedded::Shared::CoverageAmount), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('coverage_amount') } }
+      # The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set.
+      field :coverage_salary_multiplier, T.nilable(::GustoEmbedded::Shared::CoverageSalaryMultiplier), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('coverage_salary_multiplier') } }
+      # Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.
+      field :deduct_as_percentage, T.nilable(::GustoEmbedded::Shared::DeductAsPercentage), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduct_as_percentage') } }
+      # The amount to be deducted, per pay period, from the employee's pay.
+      field :employee_deduction, T.nilable(::GustoEmbedded::Shared::EmployeeDeduction), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction') } }
+      # Some benefits require additional information to determine their limit. For example, for an HSA benefit, the limit option should be either 'Family' or 'Individual'. For a Dependent Care FSA benefit, the limit option should be either 'Joint Filing or Single' or 'Married and Filing Separately'.
+      field :limit_option, T.nilable(::GustoEmbedded::Shared::LimitOption), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('limit_option') } }
+
+
+      sig { params(catch_up: T.nilable(::GustoEmbedded::Shared::CatchUp), company_contribution_annual_maximum: T.nilable(::GustoEmbedded::Shared::CompanyContributionAnnualMaximum), contribution: T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsContribution), coverage_amount: T.nilable(::GustoEmbedded::Shared::CoverageAmount), coverage_salary_multiplier: T.nilable(::GustoEmbedded::Shared::CoverageSalaryMultiplier), deduct_as_percentage: T.nilable(::GustoEmbedded::Shared::DeductAsPercentage), employee_deduction: T.nilable(::GustoEmbedded::Shared::EmployeeDeduction), limit_option: T.nilable(::GustoEmbedded::Shared::LimitOption)).void }
+      def initialize(catch_up: nil, company_contribution_annual_maximum: nil, contribution: nil, coverage_amount: nil, coverage_salary_multiplier: nil, deduct_as_percentage: nil, employee_deduction: nil, limit_option: nil)
+        @catch_up = catch_up
+        @company_contribution_annual_maximum = company_contribution_annual_maximum
+        @contribution = contribution
+        @coverage_amount = coverage_amount
+        @coverage_salary_multiplier = coverage_salary_multiplier
+        @deduct_as_percentage = deduct_as_percentage
+        @employee_deduction = employee_deduction
+        @limit_option = limit_option
+      end
+    end
+  end
+end