gusto_embedded_client 0.2.5

data/lib/gusto_embedded/models/shared/payroll_credit_blockers_type_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
+  
+    # PayrollCreditBlockersTypeStatus - The status of the credit blocker
+    class PayrollCreditBlockersTypeStatus < T::Enum
+      enums do
+        UNRESOLVED = new('unresolved')
+        PENDING_REVIEW = new('pending_review')
+        RESOLVED = new('resolved')
+        FAILED = new('failed')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_credit_blockers_type_unblock_options.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 PayrollCreditBlockersTypeUnblockOptions < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The payment check date associated with the unblock option.
+      field :check_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('check_date') } }
+      # Additional data associated with the unblock option.
+      field :metadata, T.nilable(::GustoEmbedded::Shared::PayrollCreditBlockersTypeMetadata), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('metadata') } }
+      # The type of unblock option for the credit blocker.
+      field :unblock_type, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('unblock_type') } }
+
+
+      sig { params(check_date: T.nilable(::String), metadata: T.nilable(::GustoEmbedded::Shared::PayrollCreditBlockersTypeMetadata), unblock_type: T.nilable(::String)).void }
+      def initialize(check_date: nil, metadata: nil, unblock_type: nil)
+        @check_date = check_date
+        @metadata = metadata
+        @unblock_type = unblock_type
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_employee_compensations_type.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
+  
+
+    class PayrollEmployeeCompensationsType < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # An array of employee benefits for the pay period. Benefits are only included for processed payroll when the include parameter is present.
+      field :benefits, T.nilable(T::Array[::GustoEmbedded::Shared::Benefits]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('benefits') } }
+      # The employee's check amount, equal to net_pay + reimbursements. This value is only available for processed payrolls.
+      field :check_amount, T.nilable(::Float), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('check_amount') } }
+      # An array of employee deductions for the pay period. Deductions are only included for processed payroll when the include parameter is present.
+      field :deductions, T.nilable(T::Array[::GustoEmbedded::Shared::Deductions]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('deductions') } }
+      # The UUID of the employee.
+      field :employee_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_uuid') } }
+      # This employee will be excluded (skipped) from payroll calculation and will not be paid for the payroll. Cancelling a payroll would reset all employees' excluded back to false.
+      field :excluded, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('excluded') } }
+      # An array of fixed compensations for the employee. Fixed compensations include tips, bonuses, and one time reimbursements. If this payroll has been processed, only fixed compensations with a value greater than 0.00 are returned. For an unprocessed payroll, all active fixed compensations are returned.
+      field :fixed_compensations, T.nilable(T::Array[::GustoEmbedded::Shared::FixedCompensations]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('fixed_compensations') } }
+      # The employee's gross pay, equal to regular wages + cash tips + payroll tips + any other additional earnings, excluding imputed income. This value is only available for processed payrolls.
+      field :gross_pay, T.nilable(::Float), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('gross_pay') } }
+      # An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours. If this payroll has been processed, only hourly compensations with a value greater than 0.00 are returned. For an unprocessed payroll, all active hourly compensations are returned.
+      field :hourly_compensations, T.nilable(T::Array[::GustoEmbedded::Shared::HourlyCompensations]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('hourly_compensations') } }
+      # Custom text that will be printed as a personal note to the employee on a paystub.
+      field :memo, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('memo') } }
+      # The employee's net pay, equal to gross_pay - employee taxes - employee deductions or garnishments - cash tips. This value is only available for processed payrolls.
+      field :net_pay, T.nilable(::Float), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('net_pay') } }
+      # An array of all paid time off the employee is eligible for this pay period.
+      field :paid_time_off, T.nilable(T::Array[::GustoEmbedded::Shared::PayrollEmployeeCompensationsTypePaidTimeOff]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('paid_time_off') } }
+      # The employee's compensation payment method.
+      field :payment_method, T.nilable(::GustoEmbedded::Shared::PayrollEmployeeCompensationsTypePaymentMethod), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_method'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PayrollEmployeeCompensationsTypePaymentMethod, true) } }
+      # An array of employer and employee taxes for the pay period. Only included for processed or calculated payrolls when `taxes` is present in the `include` parameter.
+      field :taxes, T.nilable(T::Array[::GustoEmbedded::Shared::Taxes]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('taxes') } }
+      # The current version of this employee compensation. This field is only available for prepared payrolls. 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(benefits: T.nilable(T::Array[::GustoEmbedded::Shared::Benefits]), check_amount: T.nilable(::Float), deductions: T.nilable(T::Array[::GustoEmbedded::Shared::Deductions]), employee_uuid: T.nilable(::String), excluded: T.nilable(T::Boolean), fixed_compensations: T.nilable(T::Array[::GustoEmbedded::Shared::FixedCompensations]), gross_pay: T.nilable(::Float), hourly_compensations: T.nilable(T::Array[::GustoEmbedded::Shared::HourlyCompensations]), memo: T.nilable(::String), net_pay: T.nilable(::Float), paid_time_off: T.nilable(T::Array[::GustoEmbedded::Shared::PayrollEmployeeCompensationsTypePaidTimeOff]), payment_method: T.nilable(::GustoEmbedded::Shared::PayrollEmployeeCompensationsTypePaymentMethod), taxes: T.nilable(T::Array[::GustoEmbedded::Shared::Taxes]), version: T.nilable(::String)).void }
+      def initialize(benefits: nil, check_amount: nil, deductions: nil, employee_uuid: nil, excluded: nil, fixed_compensations: nil, gross_pay: nil, hourly_compensations: nil, memo: nil, net_pay: nil, paid_time_off: nil, payment_method: nil, taxes: nil, version: nil)
+        @benefits = benefits
+        @check_amount = check_amount
+        @deductions = deductions
+        @employee_uuid = employee_uuid
+        @excluded = excluded
+        @fixed_compensations = fixed_compensations
+        @gross_pay = gross_pay
+        @hourly_compensations = hourly_compensations
+        @memo = memo
+        @net_pay = net_pay
+        @paid_time_off = paid_time_off
+        @payment_method = payment_method
+        @taxes = taxes
+        @version = version
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_employee_compensations_type_paid_time_off.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 PayrollEmployeeCompensationsTypePaidTimeOff < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The outstanding hours paid upon termination. This field is only applicable for termination payrolls.
+      field :final_payout_unused_hours_input, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('final_payout_unused_hours_input') } }
+      # The hours of this PTO taken during the pay period.
+      field :hours, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('hours') } }
+      # The name of the PTO. This also serves as the unique, immutable identifier for the PTO.
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+
+
+      sig { params(final_payout_unused_hours_input: T.nilable(::String), hours: T.nilable(::String), name: T.nilable(::String)).void }
+      def initialize(final_payout_unused_hours_input: nil, hours: nil, name: nil)
+        @final_payout_unused_hours_input = final_payout_unused_hours_input
+        @hours = hours
+        @name = name
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_employee_compensations_type_payment_method.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
+  
+    # PayrollEmployeeCompensationsTypePaymentMethod - The employee's compensation payment method.
+    class PayrollEmployeeCompensationsTypePaymentMethod < T::Enum
+      enums do
+        CHECK = new('Check')
+        DIRECT_DEPOSIT = new('Direct Deposit')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_fixed_compensation_types_type.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 PayrollFixedCompensationTypesType < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The name of an available type of fixed compensation.
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+
+
+      sig { params(name: T.nilable(::String)).void }
+      def initialize(name: nil)
+        @name = name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # Example response
+    class PayrollMinimal < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The UUID of the company for the payroll.
+      field :company_uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # The UUID of the payroll.
+      field :payroll_uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payroll_uuid') } }
+      # Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.
+      field :processed, T::Boolean, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('processed') } }
+      # The UUID of the payroll.
+      field :uuid, ::String, { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # Indicates whether the payroll is an auto pilot payroll
+      field :auto_pilot, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('auto_pilot') } }
+      # A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.
+      field :calculated_at, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('calculated_at') } }
+      # The date on which employees will be paid for the payroll.
+      field :check_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('check_date') } }
+      # Datetime for when the resource was created.
+      field :created_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(true) } }
+      # Only included for processed payrolls
+      field :credit_blockers, T.nilable(T::Array[::GustoEmbedded::Shared::PayrollCreditBlockersType]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('credit_blockers') } }
+      # Indicates whether the payroll is an external payroll
+      field :external, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('external') } }
+      # Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.
+      field :final_termination_payroll, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('final_termination_payroll') } }
+      # Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only included for off-cycle payrolls.
+      field :fixed_withholding_rate, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('fixed_withholding_rate') } }
+      # Indicates whether the payroll is an off-cycle payroll
+      field :off_cycle, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('off_cycle') } }
+      # The off-cycle reason. Only included for off-cycle payrolls.
+      field :off_cycle_reason, T.nilable(::GustoEmbedded::Shared::OffCycleReasonType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('off_cycle_reason'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::OffCycleReasonType, true) } }
+
+      field :pay_period, T.nilable(::GustoEmbedded::Shared::PayrollPayPeriodType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('pay_period') } }
+      # Only applicable when a payroll is moved to four day processing instead of fast ach.
+      field :payment_speed_changed, T.nilable(::GustoEmbedded::Shared::PayrollPaymentSpeedChangedType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_speed_changed') } }
+      # A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time.  If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.
+      field :payroll_deadline, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payroll_deadline'), 'decoder': Utils.datetime_from_iso_format(true) } }
+      # Information about the payroll's status and expected dates
+      field :payroll_status_meta, T.nilable(::GustoEmbedded::Shared::PayrollPayrollStatusMetaType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payroll_status_meta') } }
+      # The date at which the payroll was processed. Null if the payroll isn't processed yet.
+      field :processed_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('processed_date') } }
+      # Block regular deductions and contributions for this payroll.  Only included for off-cycle payrolls.
+      field :skip_regular_deductions, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('skip_regular_deductions') } }
+      # Only included for processed or calculated payrolls
+      field :submission_blockers, T.nilable(T::Array[::GustoEmbedded::Shared::PayrollSubmissionBlockersType]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('submission_blockers') } }
+      # The subtotals for the payroll.
+      field :totals, T.nilable(::GustoEmbedded::Shared::PayrollTotalsType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('totals') } }
+      # The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls.
+      field :withholding_pay_period, T.nilable(::GustoEmbedded::Shared::PayrollWithholdingPayPeriodType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('withholding_pay_period'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PayrollWithholdingPayPeriodType, true) } }
+
+
+      sig { params(company_uuid: ::String, payroll_uuid: ::String, processed: T::Boolean, uuid: ::String, auto_pilot: T.nilable(T::Boolean), calculated_at: T.nilable(::String), check_date: T.nilable(::String), created_at: T.nilable(::DateTime), credit_blockers: T.nilable(T::Array[::GustoEmbedded::Shared::PayrollCreditBlockersType]), external: T.nilable(T::Boolean), final_termination_payroll: T.nilable(T::Boolean), fixed_withholding_rate: T.nilable(T::Boolean), off_cycle: T.nilable(T::Boolean), off_cycle_reason: T.nilable(::GustoEmbedded::Shared::OffCycleReasonType), pay_period: T.nilable(::GustoEmbedded::Shared::PayrollPayPeriodType), payment_speed_changed: T.nilable(::GustoEmbedded::Shared::PayrollPaymentSpeedChangedType), payroll_deadline: T.nilable(::DateTime), payroll_status_meta: T.nilable(::GustoEmbedded::Shared::PayrollPayrollStatusMetaType), processed_date: T.nilable(::String), skip_regular_deductions: T.nilable(T::Boolean), submission_blockers: T.nilable(T::Array[::GustoEmbedded::Shared::PayrollSubmissionBlockersType]), totals: T.nilable(::GustoEmbedded::Shared::PayrollTotalsType), withholding_pay_period: T.nilable(::GustoEmbedded::Shared::PayrollWithholdingPayPeriodType)).void }
+      def initialize(company_uuid: nil, payroll_uuid: nil, processed: nil, uuid: nil, auto_pilot: nil, calculated_at: nil, check_date: nil, created_at: nil, credit_blockers: nil, external: nil, final_termination_payroll: nil, fixed_withholding_rate: nil, off_cycle: nil, off_cycle_reason: nil, pay_period: nil, payment_speed_changed: nil, payroll_deadline: nil, payroll_status_meta: nil, processed_date: nil, skip_regular_deductions: nil, submission_blockers: nil, totals: nil, withholding_pay_period: nil)
+        @company_uuid = company_uuid
+        @payroll_uuid = payroll_uuid
+        @processed = processed
+        @uuid = uuid
+        @auto_pilot = auto_pilot
+        @calculated_at = calculated_at
+        @check_date = check_date
+        @created_at = created_at
+        @credit_blockers = credit_blockers
+        @external = external
+        @final_termination_payroll = final_termination_payroll
+        @fixed_withholding_rate = fixed_withholding_rate
+        @off_cycle = off_cycle
+        @off_cycle_reason = off_cycle_reason
+        @pay_period = pay_period
+        @payment_speed_changed = payment_speed_changed
+        @payroll_deadline = payroll_deadline
+        @payroll_status_meta = payroll_status_meta
+        @processed_date = processed_date
+        @skip_regular_deductions = skip_regular_deductions
+        @submission_blockers = submission_blockers
+        @totals = totals
+        @withholding_pay_period = withholding_pay_period
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_pay_period_type.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 PayrollPayPeriodType < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The start date, inclusive, of the pay period.
+      field :end_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('end_date') } }
+      # The UUID of the pay schedule for the payroll.
+      field :pay_schedule_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('pay_schedule_uuid') } }
+      # The start date, inclusive, of the 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), pay_schedule_uuid: T.nilable(::String), start_date: T.nilable(::String)).void }
+      def initialize(end_date: nil, pay_schedule_uuid: nil, start_date: nil)
+        @end_date = end_date
+        @pay_schedule_uuid = pay_schedule_uuid
+        @start_date = start_date
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_payment_speed_changed_type.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
+  
+    # Only applicable when a payroll is moved to four day processing instead of fast ach.
+    class PayrollPaymentSpeedChangedType < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Current check date.
+      field :current_check_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('current_check_date') } }
+      # Current debit date.
+      field :current_debit_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('current_debit_date') } }
+      # Original check date when fast ach applies.
+      field :original_check_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('original_check_date') } }
+      # Original debit date when fast ach applies.
+      field :original_debit_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('original_debit_date') } }
+      # The reason why the payroll is moved to four day.
+      field :reason, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('reason') } }
+
+
+      sig { params(current_check_date: T.nilable(::String), current_debit_date: T.nilable(::String), original_check_date: T.nilable(::String), original_debit_date: T.nilable(::String), reason: T.nilable(::String)).void }
+      def initialize(current_check_date: nil, current_debit_date: nil, original_check_date: nil, original_debit_date: nil, reason: nil)
+        @current_check_date = current_check_date
+        @current_debit_date = current_debit_date
+        @original_check_date = original_check_date
+        @original_debit_date = original_debit_date
+        @reason = reason
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_payroll_status_meta_type.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
+  
+    # Information about the payroll's status and expected dates
+    class PayrollPayrollStatusMetaType < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # true if the payroll may be cancelled.
+      field :cancellable, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('cancellable') } }
+      # The date an employee will be paid if the payroll is submitted now.
+      field :expected_check_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('expected_check_date') } }
+      # The time the employer's account will be debited if the payroll is submitted now.
+      field :expected_debit_time, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('expected_debit_time') } }
+      # The normal check date for the associated pay period.
+      field :initial_check_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('initial_check_date') } }
+      # Payroll must be submitted at or before this time to avoid late payroll.
+      field :initial_debit_cutoff_time, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('initial_debit_cutoff_time') } }
+      # expected_check_date > initial_check_date.
+      field :payroll_late, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payroll_late') } }
+
+
+      sig { params(cancellable: T.nilable(T::Boolean), expected_check_date: T.nilable(::String), expected_debit_time: T.nilable(::String), initial_check_date: T.nilable(::String), initial_debit_cutoff_time: T.nilable(::String), payroll_late: T.nilable(T::Boolean)).void }
+      def initialize(cancellable: nil, expected_check_date: nil, expected_debit_time: nil, initial_check_date: nil, initial_debit_cutoff_time: nil, payroll_late: nil)
+        @cancellable = cancellable
+        @expected_check_date = expected_check_date
+        @expected_debit_time = expected_debit_time
+        @initial_check_date = initial_check_date
+        @initial_debit_cutoff_time = initial_debit_cutoff_time
+        @payroll_late = payroll_late
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module GustoEmbedded
+  module Shared
+  
+    # An off-cycle payroll
+    class PayrollPrepared < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Indicates whether the payroll is an auto pilot payroll
+      field :auto_pilot, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('auto_pilot') } }
+      # A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.
+      field :calculated_at, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('calculated_at') } }
+      # The date on which employees will be paid for the payroll.
+      field :check_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('check_date') } }
+      # The UUID of the company for the payroll.
+      field :company_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # Datetime for when the resource was created.
+      field :created_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(true) } }
+
+      field :employee_compensations, T.nilable(T::Array[::GustoEmbedded::Shared::PayrollEmployeeCompensationsType]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_compensations') } }
+      # Indicates whether the payroll is an external payroll
+      field :external, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('external') } }
+      # Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.
+      field :final_termination_payroll, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('final_termination_payroll') } }
+
+      field :fixed_compensation_types, T.nilable(T::Array[::GustoEmbedded::Shared::PayrollFixedCompensationTypesType]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('fixed_compensation_types') } }
+      # Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only included for off-cycle payrolls.
+      field :fixed_withholding_rate, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('fixed_withholding_rate') } }
+      # Indicates whether the payroll is an off-cycle payroll
+      field :off_cycle, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('off_cycle') } }
+      # The off-cycle reason. Only included for off-cycle payrolls.
+      field :off_cycle_reason, T.nilable(::GustoEmbedded::Shared::OffCycleReasonType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('off_cycle_reason'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::OffCycleReasonType, true) } }
+
+      field :pay_period, T.nilable(::GustoEmbedded::Shared::PayrollPayPeriodType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('pay_period') } }
+      # Only applicable when a payroll is moved to four day processing instead of fast ach.
+      field :payment_speed_changed, T.nilable(::GustoEmbedded::Shared::PayrollPaymentSpeedChangedType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payment_speed_changed') } }
+      # A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time.  If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.
+      field :payroll_deadline, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payroll_deadline'), 'decoder': Utils.datetime_from_iso_format(true) } }
+      # Information about the payroll's status and expected dates
+      field :payroll_status_meta, T.nilable(::GustoEmbedded::Shared::PayrollPayrollStatusMetaType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payroll_status_meta') } }
+      # The UUID of the payroll.
+      field :payroll_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payroll_uuid') } }
+      # Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.
+      field :processed, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('processed') } }
+      # The date at which the payroll was processed. Null if the payroll isn't processed yet.
+      field :processed_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('processed_date') } }
+
+      field :processing_request, T.nilable(::GustoEmbedded::Shared::PayrollProcessingRequest), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('processing_request') } }
+      # Block regular deductions and contributions for this payroll.  Only included for off-cycle payrolls.
+      field :skip_regular_deductions, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('skip_regular_deductions') } }
+      # The UUID of the payroll.
+      field :uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('uuid') } }
+      # The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls.
+      field :withholding_pay_period, T.nilable(::GustoEmbedded::Shared::PayrollWithholdingPayPeriodType), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('withholding_pay_period'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PayrollWithholdingPayPeriodType, true) } }
+
+
+      sig { params(auto_pilot: T.nilable(T::Boolean), calculated_at: T.nilable(::String), check_date: T.nilable(::String), company_uuid: T.nilable(::String), created_at: T.nilable(::DateTime), employee_compensations: T.nilable(T::Array[::GustoEmbedded::Shared::PayrollEmployeeCompensationsType]), external: T.nilable(T::Boolean), final_termination_payroll: T.nilable(T::Boolean), fixed_compensation_types: T.nilable(T::Array[::GustoEmbedded::Shared::PayrollFixedCompensationTypesType]), fixed_withholding_rate: T.nilable(T::Boolean), off_cycle: T.nilable(T::Boolean), off_cycle_reason: T.nilable(::GustoEmbedded::Shared::OffCycleReasonType), pay_period: T.nilable(::GustoEmbedded::Shared::PayrollPayPeriodType), payment_speed_changed: T.nilable(::GustoEmbedded::Shared::PayrollPaymentSpeedChangedType), payroll_deadline: T.nilable(::DateTime), payroll_status_meta: T.nilable(::GustoEmbedded::Shared::PayrollPayrollStatusMetaType), payroll_uuid: T.nilable(::String), processed: T.nilable(T::Boolean), processed_date: T.nilable(::String), processing_request: T.nilable(::GustoEmbedded::Shared::PayrollProcessingRequest), skip_regular_deductions: T.nilable(T::Boolean), uuid: T.nilable(::String), withholding_pay_period: T.nilable(::GustoEmbedded::Shared::PayrollWithholdingPayPeriodType)).void }
+      def initialize(auto_pilot: nil, calculated_at: nil, check_date: nil, company_uuid: nil, created_at: nil, employee_compensations: nil, external: nil, final_termination_payroll: nil, fixed_compensation_types: nil, fixed_withholding_rate: nil, off_cycle: nil, off_cycle_reason: nil, pay_period: nil, payment_speed_changed: nil, payroll_deadline: nil, payroll_status_meta: nil, payroll_uuid: nil, processed: nil, processed_date: nil, processing_request: nil, skip_regular_deductions: nil, uuid: nil, withholding_pay_period: nil)
+        @auto_pilot = auto_pilot
+        @calculated_at = calculated_at
+        @check_date = check_date
+        @company_uuid = company_uuid
+        @created_at = created_at
+        @employee_compensations = employee_compensations
+        @external = external
+        @final_termination_payroll = final_termination_payroll
+        @fixed_compensation_types = fixed_compensation_types
+        @fixed_withholding_rate = fixed_withholding_rate
+        @off_cycle = off_cycle
+        @off_cycle_reason = off_cycle_reason
+        @pay_period = pay_period
+        @payment_speed_changed = payment_speed_changed
+        @payroll_deadline = payroll_deadline
+        @payroll_status_meta = payroll_status_meta
+        @payroll_uuid = payroll_uuid
+        @processed = processed
+        @processed_date = processed_date
+        @processing_request = processing_request
+        @skip_regular_deductions = skip_regular_deductions
+        @uuid = uuid
+        @withholding_pay_period = withholding_pay_period
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_processing_request.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 PayrollProcessingRequest < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Errors that occurred during async payroll processing
+      field :errors, T.nilable(T::Array[::GustoEmbedded::Shared::EntityErrorObject]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('errors') } }
+      # The status of the payroll processing request
+      field :status, T.nilable(::GustoEmbedded::Shared::PayrollProcessingRequestStatus), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('status'), 'decoder': Utils.enum_from_string(::GustoEmbedded::Shared::PayrollProcessingRequestStatus, true) } }
+
+
+      sig { params(errors: T.nilable(T::Array[::GustoEmbedded::Shared::EntityErrorObject]), status: T.nilable(::GustoEmbedded::Shared::PayrollProcessingRequestStatus)).void }
+      def initialize(errors: nil, status: nil)
+        @errors = errors
+        @status = status
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_processing_request_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
+  
+    # PayrollProcessingRequestStatus - The status of the payroll processing request
+    class PayrollProcessingRequestStatus < T::Enum
+      enums do
+        CALCULATING = new('calculating')
+        CALCULATE_SUCCESS = new('calculate_success')
+        SUBMITTING = new('submitting')
+        SUBMIT_SUCCESS = new('submit_success')
+        PROCESSING_FAILED = new('processing_failed')
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_receipt.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
+  
+    # Example response
+    class PayrollReceipt < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # A unique identifier of the company for the payroll.
+      field :company_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('company_uuid') } }
+      # The debit or funding date for the payroll
+      field :debit_date, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('debit_date') } }
+      # An array of employee compensations and withholdings for this payroll
+      field :employee_compensations, T.nilable(T::Array[::GustoEmbedded::Shared::EmployeeCompensations]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('employee_compensations') } }
+
+      field :liability_of_licensee, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('liability_of_licensee') } }
+      # Always the fixed string "ZenPayroll, Inc., dba Gusto is a licensed money transmitter. For more about Gusto’s licenses and your state-specific rights to request information, submit complaints, dispute errors, or cancel transactions, visit our license page."
+      field :license, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('license') } }
+      # URL for the license information for the licensed payroll processor. Always the fixed string "https://gusto.com/about/licenses"
+      field :license_uri, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('license_uri') } }
+      # The licensed payroll processor
+      field :licensee, T.nilable(::GustoEmbedded::Shared::Licensee), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('licensee') } }
+      # Always the fixed string "Payroll Recipients"
+      field :name_of_recipient, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name_of_recipient') } }
+      # The name of the company by whom the payroll was paid
+      field :name_of_sender, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name_of_sender') } }
+      # A unique identifier of the payroll receipt.
+      field :payroll_uuid, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('payroll_uuid') } }
+      # Always the fixed string "Payroll recipients include the employees listed below plus the tax agencies for the taxes listed below."
+      field :recipient_notice, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('recipient_notice') } }
+
+      field :right_to_refund, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('right_to_refund') } }
+      # An array of totaled employer and employee taxes for the pay period.
+      field :taxes, T.nilable(T::Array[::GustoEmbedded::Shared::PayrollReceiptTaxes]), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('taxes') } }
+      # The subtotals for the payroll.
+      field :totals, T.nilable(::GustoEmbedded::Shared::Totals), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('totals') } }
+
+
+      sig { params(company_uuid: T.nilable(::String), debit_date: T.nilable(::String), employee_compensations: T.nilable(T::Array[::GustoEmbedded::Shared::EmployeeCompensations]), liability_of_licensee: T.nilable(::String), license: T.nilable(::String), license_uri: T.nilable(::String), licensee: T.nilable(::GustoEmbedded::Shared::Licensee), name_of_recipient: T.nilable(::String), name_of_sender: T.nilable(::String), payroll_uuid: T.nilable(::String), recipient_notice: T.nilable(::String), right_to_refund: T.nilable(::String), taxes: T.nilable(T::Array[::GustoEmbedded::Shared::PayrollReceiptTaxes]), totals: T.nilable(::GustoEmbedded::Shared::Totals)).void }
+      def initialize(company_uuid: nil, debit_date: nil, employee_compensations: nil, liability_of_licensee: nil, license: nil, license_uri: nil, licensee: nil, name_of_recipient: nil, name_of_sender: nil, payroll_uuid: nil, recipient_notice: nil, right_to_refund: nil, taxes: nil, totals: nil)
+        @company_uuid = company_uuid
+        @debit_date = debit_date
+        @employee_compensations = employee_compensations
+        @liability_of_licensee = liability_of_licensee
+        @license = license
+        @license_uri = license_uri
+        @licensee = licensee
+        @name_of_recipient = name_of_recipient
+        @name_of_sender = name_of_sender
+        @payroll_uuid = payroll_uuid
+        @recipient_notice = recipient_notice
+        @right_to_refund = right_to_refund
+        @taxes = taxes
+        @totals = totals
+      end
+    end
+  end
+end

data/lib/gusto_embedded/models/shared/payroll_receipt_taxes.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 PayrollReceiptTaxes < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The total amount paid by both employer and employee for this tax.
+      field :amount, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('amount') } }
+      # The amount paid for this tax.
+      field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::GustoEmbedded::Utils.field_name('name') } }
+
+
+      sig { params(amount: T.nilable(::String), name: T.nilable(::String)).void }
+      def initialize(amount: nil, name: nil)
+        @amount = amount
+        @name = name
+      end
+    end
+  end
+end