gusto_embedded_client 0.2.5

data/lib/gusto_embedded/models/shared/document_pdf.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 DocumentPdf < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # the URL of the document
+      field :document_url, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('document_url') } }
+      # the UUID of the document
+      field :uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+
+
+      sig { params(document_url: T.nilable(::String), uuid: T.nilable(::String)).void }
+      def initialize(document_url: nil, uuid: nil)
+        @document_url = document_url
+        @uuid = uuid
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class DocumentSigned < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The description of the document
+      field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('description') } }
+      # If the document is in a draft state
+      field :draft, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('draft') } }
+      # The type identifier of the document
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # The quarter of this document. This value is nullable and will not be present on all documents.
+      field :quarter, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('quarter') } }
+      # The type of recipient associated with the document (will be `Contractor` for Contractor Documents)
+      field :recipient_type, T.nilable(::GustoEmbedded::Shared::DocumentSignedRecipientType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::DocumentSignedRecipientType, true) } }
+      # Unique identifier for the recipient associated with the document
+      field :recipient_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_uuid') } }
+      # A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed.
+      field :requires_signing, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('requires_signing') } }
+      # When the document was signed (will be `null` if unsigned)
+      field :signed_at, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('signed_at') } }
+      # The title of the document
+      field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('title') } }
+      # The UUID of the document
+      field :uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The year of this document. This value is nullable and will not be present on all documents.
+      field :year, T.nilable(::Integer), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('year') } }
+
+
+      sig { params(description: T.nilable(::String), draft: T.nilable(T::Boolean), name: T.nilable(::String), quarter: T.nilable(::Integer), recipient_type: T.nilable(::GustoEmbedded::Shared::DocumentSignedRecipientType), recipient_uuid: T.nilable(::String), requires_signing: T.nilable(T::Boolean), signed_at: T.nilable(::String), title: T.nilable(::String), uuid: T.nilable(::String), year: T.nilable(::Integer)).void }
+      def initialize(description: nil, draft: nil, name: nil, quarter: nil, recipient_type: nil, recipient_uuid: nil, requires_signing: nil, signed_at: nil, title: nil, uuid: nil, year: nil)
+        @description = description
+        @draft = draft
+        @name = name
+        @quarter = quarter
+        @recipient_type = recipient_type
+        @recipient_uuid = recipient_uuid
+        @requires_signing = requires_signing
+        @signed_at = signed_at
+        @title = title
+        @uuid = uuid
+        @year = year
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # DocumentSignedRecipientType - The type of recipient associated with the document (will be `Contractor` for Contractor Documents)
+    class DocumentSignedRecipientType < T::Enum
+      enums do
+        COMPANY = new('Company')
+        EMPLOYEE = new('Employee')
+        CONTRACTOR = new('Contractor')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class DocumentType < T::Enum
+      enums do
+        PRINTABLE_PAYROLL_CHECKS = new('printable_payroll_checks')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/earning_type.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
+  
+    # Example response
+    class EarningType < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The ID of the earning type.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The name of the earning type.
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+
+
+      sig { params(uuid: ::String, name: T.nilable(::String)).void }
+      def initialize(uuid: nil, name: nil)
+        @uuid = uuid
+        @name = name
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/earning_type_list.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
+  
+    # Example response
+    class EarningTypeList < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The custom earning types for the company.
+      field :custom, T.nilable(T::Array[::GustoEmbedded::Shared::EarningType]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('custom') } }
+      # The default earning types for the company.
+      field :default, T.nilable(T::Array[::GustoEmbedded::Shared::EarningType]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('default') } }
+
+
+      sig { params(custom: T.nilable(T::Array[::GustoEmbedded::Shared::EarningType]), default: T.nilable(T::Array[::GustoEmbedded::Shared::EarningType])).void }
+      def initialize(custom: nil, default: nil)
+        @custom = custom
+        @default = default
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/earnings.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 Earnings < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :amount, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('amount') } }
+
+      field :earning_id, T.nilable(::Integer), { '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 :hours, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('hours') } }
+
+
+      sig { params(amount: T.nilable(::String), earning_id: T.nilable(::Integer), earning_type: T.nilable(::String), hours: T.nilable(::String)).void }
+      def initialize(amount: nil, earning_id: nil, earning_type: nil, hours: nil)
+        @amount = amount
+        @earning_id = earning_id
+        @earning_type = earning_type
+        @hours = hours
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The representation of an employee in Gusto.
+    class Employee < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :first_name, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('first_name') } }
+
+      field :last_name, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('last_name') } }
+      # The UUID of the employee in Gusto.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The UUID of the company the employee is employed by.
+      field :company_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # The current employment status of the employee. Full-time employees work 30+ hours per week. Part-time employees are split into two groups: those that work 20-29 hours a week, and those that work under 20 hours a week. Variable employees have hours that vary each week. Seasonal employees are hired for 6 months of the year or less.
+      field :current_employment_status, T.nilable(::GustoEmbedded::Shared::CurrentEmploymentStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('current_employment_status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::CurrentEmploymentStatus, true) } }
+      # Custom fields are only included for the employee if the include param has the custom_fields value set
+      field :custom_fields, T.nilable(T::Array[::GustoEmbedded::Shared::EmployeeCustomField]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('custom_fields') } }
+
+      field :date_of_birth, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('date_of_birth') } }
+      # The employee's department in the company.
+      field :department, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('department') } }
+
+      field :eligible_paid_time_off, T.nilable(T::Array[::GustoEmbedded::Shared::PaidTimeOff]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('eligible_paid_time_off') } }
+      # The personal email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing).
+      field :email, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('email') } }
+
+      field :garnishments, T.nilable(T::Array[::GustoEmbedded::Shared::Garnishment]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('garnishments') } }
+      # Indicates whether the employee has an SSN in Gusto.
+      field :has_ssn, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('has_ssn') } }
+
+      field :jobs, T.nilable(T::Array[::GustoEmbedded::Shared::Job]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('jobs') } }
+      # The UUID of the employee's manager.
+      field :manager_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('manager_uuid') } }
+
+      field :middle_initial, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('middle_initial') } }
+      # Whether the employee has completed onboarding.
+      field :onboarded, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('onboarded') } }
+      # Configuration for an employee onboarding documents during onboarding
+      field :onboarding_documents_config, T.nilable(::GustoEmbedded::Shared::OnboardingDocumentsConfig), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('onboarding_documents_config') } }
+      # The current onboarding status of the employee
+      field :onboarding_status, T.nilable(::GustoEmbedded::Shared::OnboardingStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('onboarding_status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::OnboardingStatus, true) } }
+      # The employee's payment method
+      field :payment_method, T.nilable(::GustoEmbedded::Shared::PaymentMethod), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_method'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PaymentMethod, true) } }
+
+      field :phone, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('phone') } }
+
+      field :preferred_first_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('preferred_first_name') } }
+      # Deprecated. This field always returns an empty string.
+      field :ssn, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('ssn') } }
+      # Whether the employee is terminated.
+      field :terminated, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('terminated') } }
+
+      field :terminations, T.nilable(T::Array[::GustoEmbedded::Shared::Termination]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('terminations') } }
+      # Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type.
+      field :two_percent_shareholder, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('two_percent_shareholder') } }
+      # The current version of the employee. 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') } }
+      # The work email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing).
+      field :work_email, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('work_email') } }
+
+
+      sig { params(first_name: ::String, last_name: ::String, uuid: ::String, company_uuid: T.nilable(::String), current_employment_status: T.nilable(::GustoEmbedded::Shared::CurrentEmploymentStatus), custom_fields: T.nilable(T::Array[::GustoEmbedded::Shared::EmployeeCustomField]), date_of_birth: T.nilable(::String), department: T.nilable(::String), eligible_paid_time_off: T.nilable(T::Array[::GustoEmbedded::Shared::PaidTimeOff]), email: T.nilable(::String), garnishments: T.nilable(T::Array[::GustoEmbedded::Shared::Garnishment]), has_ssn: T.nilable(T::Boolean), jobs: T.nilable(T::Array[::GustoEmbedded::Shared::Job]), manager_uuid: T.nilable(::String), middle_initial: T.nilable(::String), onboarded: T.nilable(T::Boolean), onboarding_documents_config: T.nilable(::GustoEmbedded::Shared::OnboardingDocumentsConfig), onboarding_status: T.nilable(::GustoEmbedded::Shared::OnboardingStatus), payment_method: T.nilable(::GustoEmbedded::Shared::PaymentMethod), phone: T.nilable(::String), preferred_first_name: T.nilable(::String), ssn: T.nilable(::String), terminated: T.nilable(T::Boolean), terminations: T.nilable(T::Array[::GustoEmbedded::Shared::Termination]), two_percent_shareholder: T.nilable(T::Boolean), version: T.nilable(::String), work_email: T.nilable(::String)).void }
+      def initialize(first_name: nil, last_name: nil, uuid: nil, company_uuid: nil, current_employment_status: nil, custom_fields: nil, date_of_birth: nil, department: nil, eligible_paid_time_off: nil, email: nil, garnishments: nil, has_ssn: nil, jobs: nil, manager_uuid: nil, middle_initial: nil, onboarded: nil, onboarding_documents_config: nil, onboarding_status: nil, payment_method: nil, phone: nil, preferred_first_name: nil, ssn: nil, terminated: nil, terminations: nil, two_percent_shareholder: nil, version: nil, work_email: nil)
+        @first_name = first_name
+        @last_name = last_name
+        @uuid = uuid
+        @company_uuid = company_uuid
+        @current_employment_status = current_employment_status
+        @custom_fields = custom_fields
+        @date_of_birth = date_of_birth
+        @department = department
+        @eligible_paid_time_off = eligible_paid_time_off
+        @email = email
+        @garnishments = garnishments
+        @has_ssn = has_ssn
+        @jobs = jobs
+        @manager_uuid = manager_uuid
+        @middle_initial = middle_initial
+        @onboarded = onboarded
+        @onboarding_documents_config = onboarding_documents_config
+        @onboarding_status = onboarding_status
+        @payment_method = payment_method
+        @phone = phone
+        @preferred_first_name = preferred_first_name
+        @ssn = ssn
+        @terminated = terminated
+        @terminations = terminations
+        @two_percent_shareholder = two_percent_shareholder
+        @version = version
+        @work_email = work_email
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class EmployeeAddress < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.
+      field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
+
+      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') } }
+      # Determines if home taxes should be withheld and paid for employee.
+      field :courtesy_withholding, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('courtesy_withholding') } }
+      # The date the employee started living at the address.
+      field :effective_date, T.nilable(::Date), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('effective_date'), 'decoder': Utils.date_from_iso_format(true) } }
+      # The UUID of the employee
+      field :employee_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_uuid') } }
+
+      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') } }
+      # The UUID of the employee address
+      field :uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # 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') } }
+
+      field :zip, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('zip') } }
+
+
+      sig { params(active: T.nilable(T::Boolean), city: T.nilable(::String), country: T.nilable(::String), courtesy_withholding: T.nilable(T::Boolean), effective_date: T.nilable(::Date), employee_uuid: T.nilable(::String), state: T.nilable(::String), street_1: T.nilable(::String), street_2: T.nilable(::String), uuid: T.nilable(::String), version: T.nilable(::String), zip: T.nilable(::String)).void }
+      def initialize(active: nil, city: nil, country: nil, courtesy_withholding: nil, effective_date: nil, employee_uuid: nil, state: nil, street_1: nil, street_2: nil, uuid: nil, version: nil, zip: nil)
+        @active = active
+        @city = city
+        @country = country
+        @courtesy_withholding = courtesy_withholding
+        @effective_date = effective_date
+        @employee_uuid = employee_uuid
+        @state = state
+        @street_1 = street_1
+        @street_2 = street_2
+        @uuid = uuid
+        @version = version
+        @zip = zip
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/employee_bank_account.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 EmployeeBankAccount < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # UUID of the bank account
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # Bank account type
+      field :account_type, T.nilable(::GustoEmbedded::Shared::EmployeeBankAccountAccountType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('account_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::EmployeeBankAccountAccountType, true) } }
+      # UUID of the employee
+      field :employee_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_uuid') } }
+      # Masked bank account number
+      field :hidden_account_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('hidden_account_number') } }
+      # Name for the bank account
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # The bank account's routing number
+      field :routing_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('routing_number') } }
+
+
+      sig { params(uuid: ::String, account_type: T.nilable(::GustoEmbedded::Shared::EmployeeBankAccountAccountType), employee_uuid: T.nilable(::String), hidden_account_number: T.nilable(::String), name: T.nilable(::String), routing_number: T.nilable(::String)).void }
+      def initialize(uuid: nil, account_type: nil, employee_uuid: nil, hidden_account_number: nil, name: nil, routing_number: nil)
+        @uuid = uuid
+        @account_type = account_type
+        @employee_uuid = employee_uuid
+        @hidden_account_number = hidden_account_number
+        @name = name
+        @routing_number = routing_number
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/employee_bank_account_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
+  
+    # EmployeeBankAccountAccountType - Bank account type
+    class EmployeeBankAccountAccountType < T::Enum
+      enums do
+        CHECKING = new('Checking')
+        SAVINGS = new('Savings')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The representation of an employee benefit.
+    class EmployeeBenefit < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The UUID of the employee benefit.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # Whether the employee benefit is active.
+      field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
+      # 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(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('catch_up') } }
+      # The UUID of the company benefit.
+      field :company_benefit_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_benefit_uuid') } }
+      # The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types.
+      # 
+      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
+      field :company_contribution, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution') } }
+      # The maximum company contribution amount per year. A null value signifies no limit.
+      field :company_contribution_annual_maximum, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution_annual_maximum') } }
+      # Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types.
+      # 
+      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
+      field :contribute_as_percentage, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contribute_as_percentage') } }
+      # An object representing the type and value of the company contribution.
+      field :contribution, T.nilable(::GustoEmbedded::Shared::Contribution), { '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(::String), { '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(::String), { '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(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduct_as_percentage') } }
+      # Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not "unset", coverage amount and coverage salary multiplier are ignored.
+      field :deduction_reduces_taxable_income, T.nilable(::GustoEmbedded::Shared::DeductionReducesTaxableIncome), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduction_reduces_taxable_income'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::DeductionReducesTaxableIncome, true) } }
+      # Whether the company contribution is elective (aka matching). For "tiered" contribution types, this is always true.
+      field :elective, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('elective') } }
+      # The amount to be deducted, per pay period, from the employee's pay.
+      field :employee_deduction, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction') } }
+      # The maximum employee deduction amount per year. A null value signifies no limit.
+      field :employee_deduction_annual_maximum, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction_annual_maximum') } }
+      # The UUID of the employee to which the benefit belongs.
+      field :employee_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_uuid') } }
+      # Some benefits require additional information to determine their limit.
+      # 
+      # `Family` and `Individual` are applicable to HSA benefit.
+      # 
+      # `Joint Filing or Single` and `Married and Filing Separately` are applicable to Dependent Care FSA benefit.
+      field :limit_option, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('limit_option') } }
+      # Identifier for a 401(k) loan assigned by the 401(k) provider
+      field :retirement_loan_identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('retirement_loan_identifier') } }
+      # 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), catch_up: T.nilable(T::Boolean), company_benefit_uuid: T.nilable(::String), company_contribution: T.nilable(::String), company_contribution_annual_maximum: T.nilable(::String), contribute_as_percentage: T.nilable(T::Boolean), contribution: T.nilable(::GustoEmbedded::Shared::Contribution), coverage_amount: T.nilable(::String), coverage_salary_multiplier: T.nilable(::String), deduct_as_percentage: T.nilable(T::Boolean), deduction_reduces_taxable_income: T.nilable(::GustoEmbedded::Shared::DeductionReducesTaxableIncome), elective: T.nilable(T::Boolean), employee_deduction: T.nilable(::String), employee_deduction_annual_maximum: T.nilable(::String), employee_uuid: T.nilable(::String), limit_option: T.nilable(::String), retirement_loan_identifier: T.nilable(::String), version: T.nilable(::String)).void }
+      def initialize(uuid: nil, active: nil, catch_up: nil, company_benefit_uuid: nil, company_contribution: nil, company_contribution_annual_maximum: nil, contribute_as_percentage: nil, contribution: nil, coverage_amount: nil, coverage_salary_multiplier: nil, deduct_as_percentage: nil, deduction_reduces_taxable_income: nil, elective: nil, employee_deduction: nil, employee_deduction_annual_maximum: nil, employee_uuid: nil, limit_option: nil, retirement_loan_identifier: nil, version: nil)
+        @uuid = uuid
+        @active = active
+        @catch_up = catch_up
+        @company_benefit_uuid = company_benefit_uuid
+        @company_contribution = company_contribution
+        @company_contribution_annual_maximum = company_contribution_annual_maximum
+        @contribute_as_percentage = contribute_as_percentage
+        @contribution = contribution
+        @coverage_amount = coverage_amount
+        @coverage_salary_multiplier = coverage_salary_multiplier
+        @deduct_as_percentage = deduct_as_percentage
+        @deduction_reduces_taxable_income = deduction_reduces_taxable_income
+        @elective = elective
+        @employee_deduction = employee_deduction
+        @employee_deduction_annual_maximum = employee_deduction_annual_maximum
+        @employee_uuid = employee_uuid
+        @limit_option = limit_option
+        @retirement_loan_identifier = retirement_loan_identifier
+        @version = version
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # The representation of an employee benefit for a company benefit.
+    class EmployeeBenefitForCompanyBenefit < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The UUID of the employee to which the benefit belongs.
+      field :employee_uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_uuid') } }
+      # Whether the employee benefit is active.
+      field :active, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('active') } }
+      # 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(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('catch_up') } }
+      # The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types.
+      # 
+      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
+      field :company_contribution, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution') } }
+      # The maximum company contribution amount per year. A null value signifies no limit.
+      field :company_contribution_annual_maximum, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_contribution_annual_maximum') } }
+      # Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types.
+      # 
+      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
+      field :contribute_as_percentage, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contribute_as_percentage') } }
+      # An object representing the type and value of the company contribution.
+      field :contribution, T.nilable(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitContribution), { '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(::String), { '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(::String), { '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(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduct_as_percentage') } }
+      # Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not "unset", coverage amount and coverage salary multiplier are ignored.
+      field :deduction_reduces_taxable_income, T.nilable(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deduction_reduces_taxable_income'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome, true) } }
+      # Whether the company contribution is elective (aka matching). For "tiered" contribution types, this is always true.
+      field :elective, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('elective') } }
+      # The amount to be deducted, per pay period, from the employee's pay.
+      field :employee_deduction, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction') } }
+      # The maximum employee deduction amount per year. A null value signifies no limit.
+      field :employee_deduction_annual_maximum, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_deduction_annual_maximum') } }
+      # Some benefits require additional information to determine their limit.
+      # 
+      # `Family` and `Individual` are applicable to HSA benefit.
+      # 
+      # `Joint Filing or Single` and `Married and Filing Separately` are applicable to Dependent Care FSA benefit.
+      field :limit_option, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('limit_option') } }
+      # Identifier for a 401(k) loan assigned by the 401(k) provider
+      field :retirement_loan_identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('retirement_loan_identifier') } }
+      # 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(employee_uuid: ::String, active: T.nilable(T::Boolean), catch_up: T.nilable(T::Boolean), company_contribution: T.nilable(::String), company_contribution_annual_maximum: T.nilable(::String), contribute_as_percentage: T.nilable(T::Boolean), contribution: T.nilable(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitContribution), coverage_amount: T.nilable(::String), coverage_salary_multiplier: T.nilable(::String), deduct_as_percentage: T.nilable(T::Boolean), deduction_reduces_taxable_income: T.nilable(::GustoEmbedded::Shared::EmployeeBenefitForCompanyBenefitDeductionReducesTaxableIncome), elective: T.nilable(T::Boolean), employee_deduction: T.nilable(::String), employee_deduction_annual_maximum: T.nilable(::String), limit_option: T.nilable(::String), retirement_loan_identifier: T.nilable(::String), version: T.nilable(::String)).void }
+      def initialize(employee_uuid: nil, active: nil, catch_up: nil, company_contribution: nil, company_contribution_annual_maximum: nil, contribute_as_percentage: nil, contribution: nil, coverage_amount: nil, coverage_salary_multiplier: nil, deduct_as_percentage: nil, deduction_reduces_taxable_income: nil, elective: nil, employee_deduction: nil, employee_deduction_annual_maximum: nil, limit_option: nil, retirement_loan_identifier: nil, version: nil)
+        @employee_uuid = employee_uuid
+        @active = active
+        @catch_up = catch_up
+        @company_contribution = company_contribution
+        @company_contribution_annual_maximum = company_contribution_annual_maximum
+        @contribute_as_percentage = contribute_as_percentage
+        @contribution = contribution
+        @coverage_amount = coverage_amount
+        @coverage_salary_multiplier = coverage_salary_multiplier
+        @deduct_as_percentage = deduct_as_percentage
+        @deduction_reduces_taxable_income = deduction_reduces_taxable_income
+        @elective = elective
+        @employee_deduction = employee_deduction
+        @employee_deduction_annual_maximum = employee_deduction_annual_maximum
+        @limit_option = limit_option
+        @retirement_loan_identifier = retirement_loan_identifier
+        @version = version
+      end
+    end
+  end
+end