fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/types/payroll_employee_compensations_type_item_paid_time_off_item.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  class PayrollEmployeeCompensationsTypeItemPaidTimeOffItem
+  # @return [String] The name of the PTO. This also serves as the unique, immutable identifier for
+#  the PTO.
+    attr_reader :name
+  # @return [String] The hours of this PTO taken during the pay period.
+    attr_reader :hours
+  # @return [String] The outstanding hours paid upon termination. This field is only applicable for
+#  termination payrolls.
+    attr_reader :final_payout_unused_hours_input
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param name [String] The name of the PTO. This also serves as the unique, immutable identifier for
+#  the PTO.
+    # @param hours [String] The hours of this PTO taken during the pay period.
+    # @param final_payout_unused_hours_input [String] The outstanding hours paid upon termination. This field is only applicable for
+#  termination payrolls.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::PayrollEmployeeCompensationsTypeItemPaidTimeOffItem]
+    def initialize(name: OMIT, hours: OMIT, final_payout_unused_hours_input: OMIT, additional_properties: nil)
+      @name = name if name != OMIT
+      @hours = hours if hours != OMIT
+      @final_payout_unused_hours_input = final_payout_unused_hours_input if final_payout_unused_hours_input != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "hours": hours, "final_payout_unused_hours_input": final_payout_unused_hours_input }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of
+#  PayrollEmployeeCompensationsTypeItemPaidTimeOffItem
+    #
+    # @param json_object [String] 
+    # @return [Gusto::PayrollEmployeeCompensationsTypeItemPaidTimeOffItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      hours = parsed_json["hours"]
+      final_payout_unused_hours_input = parsed_json["final_payout_unused_hours_input"]
+      new(
+        name: name,
+        hours: hours,
+        final_payout_unused_hours_input: final_payout_unused_hours_input,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PayrollEmployeeCompensationsTypeItemPaidTimeOffItem to
+#  a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.hours&.is_a?(String) != false || raise("Passed value for field obj.hours is not the expected type, validation failed.")
+      obj.final_payout_unused_hours_input&.is_a?(String) != false || raise("Passed value for field obj.final_payout_unused_hours_input is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/payroll_employee_compensations_type_item_payment_method.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Gusto
+# The employee's compensation payment method.
+  class PayrollEmployeeCompensationsTypeItemPaymentMethod
+
+    CHECK = "Check"
+    DIRECT_DEPOSIT = "Direct Deposit"
+
+  end
+end

data/lib/fern_gusto/types/payroll_employee_compensations_type_item_taxes_item.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  class PayrollEmployeeCompensationsTypeItemTaxesItem
+  # @return [String] 
+    attr_reader :name
+  # @return [Boolean] 
+    attr_reader :employer
+  # @return [Float] 
+    attr_reader :amount
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param name [String] 
+    # @param employer [Boolean] 
+    # @param amount [Float] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::PayrollEmployeeCompensationsTypeItemTaxesItem]
+    def initialize(name:, employer:, amount:, additional_properties: nil)
+      @name = name
+      @employer = employer
+      @amount = amount
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "employer": employer, "amount": amount }
+    end
+# Deserialize a JSON object to an instance of
+#  PayrollEmployeeCompensationsTypeItemTaxesItem
+    #
+    # @param json_object [String] 
+    # @return [Gusto::PayrollEmployeeCompensationsTypeItemTaxesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      employer = parsed_json["employer"]
+      amount = parsed_json["amount"]
+      new(
+        name: name,
+        employer: employer,
+        amount: amount,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PayrollEmployeeCompensationsTypeItemTaxesItem to a JSON
+#  object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.employer.is_a?(Boolean) != false || raise("Passed value for field obj.employer is not the expected type, validation failed.")
+      obj.amount.is_a?(Float) != false || raise("Passed value for field obj.amount is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/payroll_fixed_compensation_types_type.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require_relative "payroll_fixed_compensation_types_type_item"
+
+module Gusto
+  PAYROLL_FIXED_COMPENSATION_TYPES_TYPE = Array
+end

data/lib/fern_gusto/types/payroll_fixed_compensation_types_type_item.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  class PayrollFixedCompensationTypesTypeItem
+  # @return [String] The name of an available type of fixed compensation.
+    attr_reader :name
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param name [String] The name of an available type of fixed compensation.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::PayrollFixedCompensationTypesTypeItem]
+    def initialize(name: OMIT, additional_properties: nil)
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "name": name }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of
+#  PayrollFixedCompensationTypesTypeItem
+    #
+    # @param json_object [String] 
+    # @return [Gusto::PayrollFixedCompensationTypesTypeItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      new(name: name, additional_properties: struct)
+    end
+# Serialize an instance of PayrollFixedCompensationTypesTypeItem to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/payroll_pay_period_type.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+  class PayrollPayPeriodType
+  # @return [String] The start date, inclusive, of the pay period.
+    attr_reader :start_date
+  # @return [String] The start date, inclusive, of the pay period.
+    attr_reader :end_date
+  # @return [String] The UUID of the pay schedule for the payroll.
+    attr_reader :pay_schedule_uuid
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param start_date [String] The start date, inclusive, of the pay period.
+    # @param end_date [String] The start date, inclusive, of the pay period.
+    # @param pay_schedule_uuid [String] The UUID of the pay schedule for the payroll.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::PayrollPayPeriodType]
+    def initialize(start_date: OMIT, end_date: OMIT, pay_schedule_uuid: OMIT, additional_properties: nil)
+      @start_date = start_date if start_date != OMIT
+      @end_date = end_date if end_date != OMIT
+      @pay_schedule_uuid = pay_schedule_uuid if pay_schedule_uuid != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "start_date": start_date, "end_date": end_date, "pay_schedule_uuid": pay_schedule_uuid }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of PayrollPayPeriodType
+    #
+    # @param json_object [String] 
+    # @return [Gusto::PayrollPayPeriodType]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      start_date = parsed_json["start_date"]
+      end_date = parsed_json["end_date"]
+      pay_schedule_uuid = parsed_json["pay_schedule_uuid"]
+      new(
+        start_date: start_date,
+        end_date: end_date,
+        pay_schedule_uuid: pay_schedule_uuid,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PayrollPayPeriodType to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.start_date&.is_a?(String) != false || raise("Passed value for field obj.start_date is not the expected type, validation failed.")
+      obj.end_date&.is_a?(String) != false || raise("Passed value for field obj.end_date is not the expected type, validation failed.")
+      obj.pay_schedule_uuid&.is_a?(String) != false || raise("Passed value for field obj.pay_schedule_uuid is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/payroll_payment_speed_changed_type.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+# Only applicable when a payroll is moved to four day processing instead of fast
+#  ach.
+  class PayrollPaymentSpeedChangedType
+  # @return [String] Original check date when fast ach applies.
+    attr_reader :original_check_date
+  # @return [String] Current check date.
+    attr_reader :current_check_date
+  # @return [String] Original debit date when fast ach applies.
+    attr_reader :original_debit_date
+  # @return [String] Current debit date.
+    attr_reader :current_debit_date
+  # @return [String] The reason why the payroll is moved to four day.
+    attr_reader :reason
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param original_check_date [String] Original check date when fast ach applies.
+    # @param current_check_date [String] Current check date.
+    # @param original_debit_date [String] Original debit date when fast ach applies.
+    # @param current_debit_date [String] Current debit date.
+    # @param reason [String] The reason why the payroll is moved to four day.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::PayrollPaymentSpeedChangedType]
+    def initialize(original_check_date: OMIT, current_check_date: OMIT, original_debit_date: OMIT, current_debit_date: OMIT, reason: OMIT, additional_properties: nil)
+      @original_check_date = original_check_date if original_check_date != OMIT
+      @current_check_date = current_check_date if current_check_date != OMIT
+      @original_debit_date = original_debit_date if original_debit_date != OMIT
+      @current_debit_date = current_debit_date if current_debit_date != OMIT
+      @reason = reason if reason != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "original_check_date": original_check_date, "current_check_date": current_check_date, "original_debit_date": original_debit_date, "current_debit_date": current_debit_date, "reason": reason }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of PayrollPaymentSpeedChangedType
+    #
+    # @param json_object [String] 
+    # @return [Gusto::PayrollPaymentSpeedChangedType]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      original_check_date = parsed_json["original_check_date"]
+      current_check_date = parsed_json["current_check_date"]
+      original_debit_date = parsed_json["original_debit_date"]
+      current_debit_date = parsed_json["current_debit_date"]
+      reason = parsed_json["reason"]
+      new(
+        original_check_date: original_check_date,
+        current_check_date: current_check_date,
+        original_debit_date: original_debit_date,
+        current_debit_date: current_debit_date,
+        reason: reason,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PayrollPaymentSpeedChangedType to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.original_check_date&.is_a?(String) != false || raise("Passed value for field obj.original_check_date is not the expected type, validation failed.")
+      obj.current_check_date&.is_a?(String) != false || raise("Passed value for field obj.current_check_date is not the expected type, validation failed.")
+      obj.original_debit_date&.is_a?(String) != false || raise("Passed value for field obj.original_debit_date is not the expected type, validation failed.")
+      obj.current_debit_date&.is_a?(String) != false || raise("Passed value for field obj.current_debit_date is not the expected type, validation failed.")
+      obj.reason&.is_a?(String) != false || raise("Passed value for field obj.reason is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/payroll_payroll_status_meta_type.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Gusto
+# Information about the payroll's status and expected dates
+  class PayrollPayrollStatusMetaType
+  # @return [Boolean] true if the payroll may be cancelled
+    attr_reader :cancellable
+  # @return [String] The date an employee will be paid if the payroll is submitted now
+    attr_reader :expected_check_date
+  # @return [String] The normal check date for the associated pay period
+    attr_reader :initial_check_date
+  # @return [String] The time the employer's account will be debited if the payroll is submitted now
+    attr_reader :expected_debit_time
+  # @return [Boolean] expected_check_date > initial_check_date
+    attr_reader :payroll_late
+  # @return [String] Payroll must be submitted at or before this time to avoid late payroll
+    attr_reader :initial_debit_cutoff_time
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param cancellable [Boolean] true if the payroll may be cancelled
+    # @param expected_check_date [String] The date an employee will be paid if the payroll is submitted now
+    # @param initial_check_date [String] The normal check date for the associated pay period
+    # @param expected_debit_time [String] The time the employer's account will be debited if the payroll is submitted now
+    # @param payroll_late [Boolean] expected_check_date > initial_check_date
+    # @param initial_debit_cutoff_time [String] Payroll must be submitted at or before this time to avoid late payroll
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::PayrollPayrollStatusMetaType]
+    def initialize(cancellable: OMIT, expected_check_date: OMIT, initial_check_date: OMIT, expected_debit_time: OMIT, payroll_late: OMIT, initial_debit_cutoff_time: OMIT, additional_properties: nil)
+      @cancellable = cancellable if cancellable != OMIT
+      @expected_check_date = expected_check_date if expected_check_date != OMIT
+      @initial_check_date = initial_check_date if initial_check_date != OMIT
+      @expected_debit_time = expected_debit_time if expected_debit_time != OMIT
+      @payroll_late = payroll_late if payroll_late != OMIT
+      @initial_debit_cutoff_time = initial_debit_cutoff_time if initial_debit_cutoff_time != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "cancellable": cancellable, "expected_check_date": expected_check_date, "initial_check_date": initial_check_date, "expected_debit_time": expected_debit_time, "payroll_late": payroll_late, "initial_debit_cutoff_time": initial_debit_cutoff_time }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of PayrollPayrollStatusMetaType
+    #
+    # @param json_object [String] 
+    # @return [Gusto::PayrollPayrollStatusMetaType]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      cancellable = parsed_json["cancellable"]
+      expected_check_date = parsed_json["expected_check_date"]
+      initial_check_date = parsed_json["initial_check_date"]
+      expected_debit_time = parsed_json["expected_debit_time"]
+      payroll_late = parsed_json["payroll_late"]
+      initial_debit_cutoff_time = parsed_json["initial_debit_cutoff_time"]
+      new(
+        cancellable: cancellable,
+        expected_check_date: expected_check_date,
+        initial_check_date: initial_check_date,
+        expected_debit_time: expected_debit_time,
+        payroll_late: payroll_late,
+        initial_debit_cutoff_time: initial_debit_cutoff_time,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PayrollPayrollStatusMetaType to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.cancellable&.is_a?(Boolean) != false || raise("Passed value for field obj.cancellable is not the expected type, validation failed.")
+      obj.expected_check_date&.is_a?(String) != false || raise("Passed value for field obj.expected_check_date is not the expected type, validation failed.")
+      obj.initial_check_date&.is_a?(String) != false || raise("Passed value for field obj.initial_check_date is not the expected type, validation failed.")
+      obj.expected_debit_time&.is_a?(String) != false || raise("Passed value for field obj.expected_debit_time is not the expected type, validation failed.")
+      obj.payroll_late&.is_a?(Boolean) != false || raise("Passed value for field obj.payroll_late is not the expected type, validation failed.")
+      obj.initial_debit_cutoff_time&.is_a?(String) != false || raise("Passed value for field obj.initial_debit_cutoff_time is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/payroll_processing_request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require_relative "payroll_processing_request_status"
+require_relative "entity_error_object"
+require "ostruct"
+require "json"
+
+module Gusto
+  class PayrollProcessingRequest
+  # @return [Gusto::PayrollProcessingRequestStatus] The status of the payroll processing request
+    attr_reader :status
+  # @return [Array<Gusto::EntityErrorObject>] Errors that occurred during async payroll processing
+    attr_reader :errors
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param status [Gusto::PayrollProcessingRequestStatus] The status of the payroll processing request
+    # @param errors [Array<Gusto::EntityErrorObject>] Errors that occurred during async payroll processing
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Gusto::PayrollProcessingRequest]
+    def initialize(status: OMIT, errors: OMIT, additional_properties: nil)
+      @status = status if status != OMIT
+      @errors = errors if errors != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "status": status, "errors": errors }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of PayrollProcessingRequest
+    #
+    # @param json_object [String] 
+    # @return [Gusto::PayrollProcessingRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      status = parsed_json["status"]
+      errors = parsed_json["errors"]&.map do | item |
+  item = item.to_json
+  Gusto::EntityErrorObject.from_json(json_object: item)
+end
+      new(
+        status: status,
+        errors: errors,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of PayrollProcessingRequest to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.status&.is_a?(Gusto::PayrollProcessingRequestStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.errors&.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/fern_gusto/types/payroll_processing_request_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Gusto
+# The status of the payroll processing request
+  class PayrollProcessingRequestStatus
+
+    CALCULATING = "calculating"
+    CALCULATE_SUCCESS = "calculate_success"
+    SUBMITTING = "submitting"
+    SUBMIT_SUCCESS = "submit_success"
+    PROCESSING_FAILED = "processing_failed"
+
+  end
+end