gusto_embedded_client 0.2.5

data/lib/gusto_embedded/models/shared/contractor_payment_receipt_licensee.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 licensed payroll processor
+    class ContractorPaymentReceiptLicensee < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Always the fixed string "525 20th St"
+      field :address, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('address') } }
+      # Always the fixed string "San Francisco"
+      field :city, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('city') } }
+      # Always the fixed string "Gusto, Zenpayroll Inc."
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # Always the fixed string "4157778888"
+      field :phone_number, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('phone_number') } }
+      # Always the fixed string "94107"
+      field :postal_code, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('postal_code') } }
+      # Always the fixed string "CA"
+      field :state, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('state') } }
+
+
+      sig { params(address: T.nilable(::String), city: T.nilable(::String), name: T.nilable(::String), phone_number: T.nilable(::String), postal_code: T.nilable(::String), state: T.nilable(::String)).void }
+      def initialize(address: nil, city: nil, name: nil, phone_number: nil, postal_code: nil, state: nil)
+        @address = address
+        @city = city
+        @name = name
+        @phone_number = phone_number
+        @postal_code = postal_code
+        @state = state
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/contractor_payment_receipt_totals.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 subtotals for the contractor payment.
+    class ContractorPaymentReceiptTotals < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The total company debit for the contractor payment.
+      field :company_debit, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_debit') } }
+
+
+      sig { params(company_debit: T.nilable(::String)).void }
+      def initialize(company_debit: nil)
+        @company_debit = company_debit
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/contractor_payment_status.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
+  
+    # ContractorPaymentStatus - Contractor payment status
+    class ContractorPaymentStatus < T::Enum
+      enums do
+        FUNDED = new('Funded')
+        UNFUNDED = new('Unfunded')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/contractor_payment_wage_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
+  
+    # ContractorPaymentWageType - The wage type for the payment.
+    class ContractorPaymentWageType < T::Enum
+      enums do
+        HOURLY = new('Hourly')
+        FIXED = new('Fixed')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class ContractorPayments < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The bonus amount in the payment.
+      field :bonus, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('bonus') } }
+      # The business name of the contractor. Applies when `contractor_type` is `Business`.
+      field :contractor_business_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contractor_business_name') } }
+      # The first name of the contractor. Applies when `contractor_type` is `Individual`.
+      field :contractor_first_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contractor_first_name') } }
+      # The last name of the contractor.  Applies when `contractor_type` is `Individual`.
+      field :contractor_last_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contractor_last_name') } }
+      # The type of contractor.
+      # 
+      # `Individual` `Business`
+      field :contractor_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contractor_type') } }
+      # The UUID of the contractor.
+      field :contractor_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contractor_uuid') } }
+      # The payment method.
+      # 
+      # `Direct Deposit` `Check` `Historical Payment` `Correction Payment`
+      field :payment_method, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_method') } }
+      # The reimbursement amount in the payment.
+      field :reimbursement, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('reimbursement') } }
+      # The fixed wage of the payment, regardless of hours worked.
+      field :wage, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('wage') } }
+
+
+      sig { params(bonus: T.nilable(::String), contractor_business_name: T.nilable(::String), contractor_first_name: T.nilable(::String), contractor_last_name: T.nilable(::String), contractor_type: T.nilable(::String), contractor_uuid: T.nilable(::String), payment_method: T.nilable(::String), reimbursement: T.nilable(::String), wage: T.nilable(::String)).void }
+      def initialize(bonus: nil, contractor_business_name: nil, contractor_first_name: nil, contractor_last_name: nil, contractor_type: nil, contractor_uuid: nil, payment_method: nil, reimbursement: nil, wage: nil)
+        @bonus = bonus
+        @contractor_business_name = contractor_business_name
+        @contractor_first_name = contractor_first_name
+        @contractor_last_name = contractor_last_name
+        @contractor_type = contractor_type
+        @contractor_uuid = contractor_uuid
+        @payment_method = payment_method
+        @reimbursement = reimbursement
+        @wage = wage
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/contractor_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
+  
+    # ContractorType - The contractor's type, either "Individual" or "Business". 
+    class ContractorType < T::Enum
+      enums do
+        INDIVIDUAL = new('Individual')
+        BUSINESS = new('Business')
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,35 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # An object representing the type and value of the company contribution.
+    class Contribution < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The company contribution scheme.
+      # 
+      # "amount": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.
+      # 
+      # "percentage": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.
+      # 
+      # "tiered": The company contribution varies according to the size of the employee deduction.
+      field :type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('type') } }
+      # For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage.
+      # 
+      # For the `tiered` contribution type, an array of tiers.
+      field :value, T.nilable(::Object), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('value') } }
+
+
+      sig { params(type: T.nilable(::String), value: T.nilable(::Object)).void }
+      def initialize(type: nil, value: nil)
+        @type = type
+        @value = value
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/coverage_amount.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 amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.
+    class CoverageAmount < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :choices, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('choices') } }
+
+      field :default_value, T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsCoverageAmountDefaultValue), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('default_value') } }
+
+      field :editable, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('editable') } }
+
+      field :required, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('required') } }
+
+
+      sig { params(choices: T.nilable(T::Array[::String]), default_value: T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsCoverageAmountDefaultValue), editable: T.nilable(T::Boolean), required: T.nilable(T::Boolean)).void }
+      def initialize(choices: nil, default_value: nil, editable: nil, required: nil)
+        @choices = choices
+        @default_value = default_value
+        @editable = editable
+        @required = required
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/coverage_salary_multiplier.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 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.
+    class CoverageSalaryMultiplier < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :choices, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('choices') } }
+
+      field :default_value, T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsCoverageSalaryMultiplierDefaultValue), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('default_value') } }
+
+      field :editable, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('editable') } }
+
+      field :required, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('required') } }
+
+
+      sig { params(choices: T.nilable(T::Array[::String]), default_value: T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsCoverageSalaryMultiplierDefaultValue), editable: T.nilable(T::Boolean), required: T.nilable(T::Boolean)).void }
+      def initialize(choices: nil, default_value: nil, editable: nil, required: nil)
+        @choices = choices
+        @default_value = default_value
+        @editable = editable
+        @required = required
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/create_report.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
+  
+    # Example response
+    class CreateReport < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Company UUID
+      field :company_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # Title of the report
+      field :custom_name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('custom_name') } }
+      # File type
+      field :file_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('file_type') } }
+      # A unique identifier of the report request
+      field :request_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('request_uuid') } }
+
+
+      sig { params(company_uuid: T.nilable(::String), custom_name: T.nilable(::String), file_type: T.nilable(::String), request_uuid: T.nilable(::String)).void }
+      def initialize(company_uuid: nil, custom_name: nil, file_type: nil, request_uuid: nil)
+        @company_uuid = company_uuid
+        @custom_name = custom_name
+        @file_type = file_type
+        @request_uuid = request_uuid
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # CurrentEmploymentStatus - 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.
+    class CurrentEmploymentStatus < T::Enum
+      enums do
+        FULL_TIME = new('full_time')
+        PART_TIME_UNDER_TWENTY_HOURS = new('part_time_under_twenty_hours')
+        PART_TIME_TWENTY_PLUS_HOURS = new('part_time_twenty_plus_hours')
+        VARIABLE = new('variable')
+        SEASONAL = new('seasonal')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # CustomFieldType - Input type for the custom field.
+    class CustomFieldType < T::Enum
+      enums do
+        TEXT = new('text')
+        CURRENCY = new('currency')
+        NUMBER = new('number')
+        DATE = new('date')
+        RADIO = new('radio')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/deduct_as_percentage.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
+  
+    # Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.
+    class DeductAsPercentage < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :choices, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('choices') } }
+
+      field :default_value, T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsDeductAsPercentageDefaultValue), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('default_value') } }
+
+      field :editable, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('editable') } }
+
+      field :required, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('required') } }
+
+
+      sig { params(choices: T.nilable(T::Array[::String]), default_value: T.nilable(::GustoEmbedded::Shared::BenefitTypeRequirementsDeductAsPercentageDefaultValue), editable: T.nilable(T::Boolean), required: T.nilable(T::Boolean)).void }
+      def initialize(choices: nil, default_value: nil, editable: nil, required: nil)
+        @choices = choices
+        @default_value = default_value
+        @editable = editable
+        @required = required
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/deduction_reduces_taxable_income.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
+  
+    # DeductionReducesTaxableIncome - 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.
+    class DeductionReducesTaxableIncome < T::Enum
+      enums do
+        UNSET = new('unset')
+        REDUCES_TAXABLE_INCOME = new('reduces_taxable_income')
+        DOES_NOT_REDUCE_TAXABLE_INCOME = new('does_not_reduce_taxable_income')
+      end
+    end
+  end
+end

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

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

data/lib/gusto_embedded/models/shared/department.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
+  
+
+    class Department < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The UUID of the company
+      field :company_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # Array of contractors assigned to the department.
+      field :contractors, T.nilable(T::Array[::GustoEmbedded::Shared::Contractors]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('contractors') } }
+      # Array of employees assigned to the department.
+      field :employees, T.nilable(T::Array[::GustoEmbedded::Shared::DepartmentEmployees]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employees') } }
+      # Name of the department
+      field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('title') } }
+      # The UUID of the department
+      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') } }
+
+
+      sig { params(company_uuid: T.nilable(::String), contractors: T.nilable(T::Array[::GustoEmbedded::Shared::Contractors]), employees: T.nilable(T::Array[::GustoEmbedded::Shared::DepartmentEmployees]), title: T.nilable(::String), uuid: T.nilable(::String), version: T.nilable(::String)).void }
+      def initialize(company_uuid: nil, contractors: nil, employees: nil, title: nil, uuid: nil, version: nil)
+        @company_uuid = company_uuid
+        @contractors = contractors
+        @employees = employees
+        @title = title
+        @uuid = uuid
+        @version = version
+      end
+    end
+  end
+end

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

data/lib/gusto_embedded/models/shared/departments.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 Departments < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Department UUID
+      field :department_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('department_uuid') } }
+      # Pay schedule UUID
+      field :pay_schedule_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('pay_schedule_uuid') } }
+
+
+      sig { params(department_uuid: T.nilable(::String), pay_schedule_uuid: T.nilable(::String)).void }
+      def initialize(department_uuid: nil, pay_schedule_uuid: nil)
+        @department_uuid = department_uuid
+        @pay_schedule_uuid = pay_schedule_uuid
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+
+    class Document < ::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') } }
+      # List of the document's fields and associated data. Values are set for auto-filled fields. This is only returned for documents with `required_signing` = `true`, and can be used for signing preparation.
+      field :fields_, T.nilable(T::Array[::GustoEmbedded::Shared::Fields]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('fields') } }
+      # The type identifier of the document
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+      # List of the document's pages and associated image URLs. This is only returned for documents with `required_signing` = `true`, and can be used for signing preparation.
+      field :pages, T.nilable(T::Array[::GustoEmbedded::Shared::Pages]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('pages') } }
+      # 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::RecipientType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_type'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::RecipientType, 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), fields_: T.nilable(T::Array[::GustoEmbedded::Shared::Fields]), name: T.nilable(::String), pages: T.nilable(T::Array[::GustoEmbedded::Shared::Pages]), quarter: T.nilable(::Integer), recipient_type: T.nilable(::GustoEmbedded::Shared::RecipientType), 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, fields_: nil, name: nil, pages: 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
+        @fields_ = fields_
+        @name = name
+        @pages = pages
+        @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