fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/payrolls/types/payroll_prepared.rb

@@ -0,0 +1,250 @@
+# frozen_string_literal: true
+require "date"
+require_relative "../../types/off_cycle_reason_type"
+require_relative "../../types/payroll_withholding_pay_period_type"
+require_relative "../../types/payroll_pay_period_type"
+require_relative "../../types/payroll_payroll_status_meta_type"
+require_relative "../../types/payroll_employee_compensations_type"
+require_relative "../../types/payroll_payment_speed_changed_type"
+require "date"
+require_relative "../../types/payroll_fixed_compensation_types_type"
+require_relative "../../types/payroll_processing_request"
+require "ostruct"
+require "json"
+
+module Gusto
+  module Payrolls
+
+    class PayrollPrepared
+    # @return [DateTime] 
+      attr_reader :payroll_deadline
+    # @return [String] 
+      attr_reader :check_date
+    # @return [Boolean] 
+      attr_reader :processed
+    # @return [String] 
+      attr_reader :processed_date
+    # @return [String] 
+      attr_reader :calculated_at
+    # @return [String] 
+      attr_reader :payroll_uuid
+    # @return [String] 
+      attr_reader :company_uuid
+    # @return [Boolean] 
+      attr_reader :off_cycle
+    # @return [Gusto::OffCycleReasonType] 
+      attr_reader :off_cycle_reason
+    # @return [Boolean] 
+      attr_reader :auto_pilot
+    # @return [Boolean] 
+      attr_reader :external
+    # @return [Boolean] 
+      attr_reader :final_termination_payroll
+    # @return [Gusto::PayrollWithholdingPayPeriodType] 
+      attr_reader :withholding_pay_period
+    # @return [Boolean] 
+      attr_reader :skip_regular_deductions
+    # @return [Boolean] 
+      attr_reader :fixed_withholding_rate
+    # @return [Gusto::PayrollPayPeriodType] 
+      attr_reader :pay_period
+    # @return [Gusto::PayrollPayrollStatusMetaType] 
+      attr_reader :payroll_status_meta
+    # @return [Gusto::PAYROLL_EMPLOYEE_COMPENSATIONS_TYPE] 
+      attr_reader :employee_compensations
+    # @return [Gusto::PayrollPaymentSpeedChangedType] 
+      attr_reader :payment_speed_changed
+    # @return [DateTime] 
+      attr_reader :created_at
+    # @return [Gusto::PAYROLL_FIXED_COMPENSATION_TYPES_TYPE] 
+      attr_reader :fixed_compensation_types
+    # @return [Gusto::PayrollProcessingRequest] 
+      attr_reader :processing_request
+    # @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 payroll_deadline [DateTime] 
+      # @param check_date [String] 
+      # @param processed [Boolean] 
+      # @param processed_date [String] 
+      # @param calculated_at [String] 
+      # @param payroll_uuid [String] 
+      # @param company_uuid [String] 
+      # @param off_cycle [Boolean] 
+      # @param off_cycle_reason [Gusto::OffCycleReasonType] 
+      # @param auto_pilot [Boolean] 
+      # @param external [Boolean] 
+      # @param final_termination_payroll [Boolean] 
+      # @param withholding_pay_period [Gusto::PayrollWithholdingPayPeriodType] 
+      # @param skip_regular_deductions [Boolean] 
+      # @param fixed_withholding_rate [Boolean] 
+      # @param pay_period [Gusto::PayrollPayPeriodType] 
+      # @param payroll_status_meta [Gusto::PayrollPayrollStatusMetaType] 
+      # @param employee_compensations [Gusto::PAYROLL_EMPLOYEE_COMPENSATIONS_TYPE] 
+      # @param payment_speed_changed [Gusto::PayrollPaymentSpeedChangedType] 
+      # @param created_at [DateTime] 
+      # @param fixed_compensation_types [Gusto::PAYROLL_FIXED_COMPENSATION_TYPES_TYPE] 
+      # @param processing_request [Gusto::PayrollProcessingRequest] 
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Gusto::Payrolls::PayrollPrepared]
+      def initialize(payroll_deadline: OMIT, check_date: OMIT, processed: OMIT, processed_date: OMIT, calculated_at: OMIT, payroll_uuid: OMIT, company_uuid: OMIT, off_cycle: OMIT, off_cycle_reason: OMIT, auto_pilot: OMIT, external: OMIT, final_termination_payroll: OMIT, withholding_pay_period: OMIT, skip_regular_deductions: OMIT, fixed_withholding_rate: OMIT, pay_period: OMIT, payroll_status_meta: OMIT, employee_compensations: OMIT, payment_speed_changed: OMIT, created_at: OMIT, fixed_compensation_types: OMIT, processing_request: OMIT, additional_properties: nil)
+        @payroll_deadline = payroll_deadline if payroll_deadline != OMIT
+        @check_date = check_date if check_date != OMIT
+        @processed = processed if processed != OMIT
+        @processed_date = processed_date if processed_date != OMIT
+        @calculated_at = calculated_at if calculated_at != OMIT
+        @payroll_uuid = payroll_uuid if payroll_uuid != OMIT
+        @company_uuid = company_uuid if company_uuid != OMIT
+        @off_cycle = off_cycle if off_cycle != OMIT
+        @off_cycle_reason = off_cycle_reason if off_cycle_reason != OMIT
+        @auto_pilot = auto_pilot if auto_pilot != OMIT
+        @external = external if external != OMIT
+        @final_termination_payroll = final_termination_payroll if final_termination_payroll != OMIT
+        @withholding_pay_period = withholding_pay_period if withholding_pay_period != OMIT
+        @skip_regular_deductions = skip_regular_deductions if skip_regular_deductions != OMIT
+        @fixed_withholding_rate = fixed_withholding_rate if fixed_withholding_rate != OMIT
+        @pay_period = pay_period if pay_period != OMIT
+        @payroll_status_meta = payroll_status_meta if payroll_status_meta != OMIT
+        @employee_compensations = employee_compensations if employee_compensations != OMIT
+        @payment_speed_changed = payment_speed_changed if payment_speed_changed != OMIT
+        @created_at = created_at if created_at != OMIT
+        @fixed_compensation_types = fixed_compensation_types if fixed_compensation_types != OMIT
+        @processing_request = processing_request if processing_request != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "payroll_deadline": payroll_deadline, "check_date": check_date, "processed": processed, "processed_date": processed_date, "calculated_at": calculated_at, "payroll_uuid": payroll_uuid, "company_uuid": company_uuid, "off_cycle": off_cycle, "off_cycle_reason": off_cycle_reason, "auto_pilot": auto_pilot, "external": external, "final_termination_payroll": final_termination_payroll, "withholding_pay_period": withholding_pay_period, "skip_regular_deductions": skip_regular_deductions, "fixed_withholding_rate": fixed_withholding_rate, "pay_period": pay_period, "payroll_status_meta": payroll_status_meta, "employee_compensations": employee_compensations, "payment_speed_changed": payment_speed_changed, "created_at": created_at, "fixed_compensation_types": fixed_compensation_types, "processing_request": processing_request }.reject do | _k, v |
+  v == OMIT
+end
+      end
+# Deserialize a JSON object to an instance of PayrollPrepared
+      #
+      # @param json_object [String] 
+      # @return [Gusto::Payrolls::PayrollPrepared]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        payroll_deadline = unless parsed_json["payroll_deadline"].nil?
+  DateTime.parse(parsed_json["payroll_deadline"])
+else
+  nil
+end
+        check_date = parsed_json["check_date"]
+        processed = parsed_json["processed"]
+        processed_date = parsed_json["processed_date"]
+        calculated_at = parsed_json["calculated_at"]
+        payroll_uuid = parsed_json["payroll_uuid"]
+        company_uuid = parsed_json["company_uuid"]
+        off_cycle = parsed_json["off_cycle"]
+        off_cycle_reason = parsed_json["off_cycle_reason"]
+        auto_pilot = parsed_json["auto_pilot"]
+        external = parsed_json["external"]
+        final_termination_payroll = parsed_json["final_termination_payroll"]
+        withholding_pay_period = parsed_json["withholding_pay_period"]
+        skip_regular_deductions = parsed_json["skip_regular_deductions"]
+        fixed_withholding_rate = parsed_json["fixed_withholding_rate"]
+        unless parsed_json["pay_period"].nil?
+          pay_period = parsed_json["pay_period"].to_json
+          pay_period = Gusto::PayrollPayPeriodType.from_json(json_object: pay_period)
+        else
+          pay_period = nil
+        end
+        unless parsed_json["payroll_status_meta"].nil?
+          payroll_status_meta = parsed_json["payroll_status_meta"].to_json
+          payroll_status_meta = Gusto::PayrollPayrollStatusMetaType.from_json(json_object: payroll_status_meta)
+        else
+          payroll_status_meta = nil
+        end
+        employee_compensations = parsed_json["employee_compensations"]&.map do | item |
+  item = item.to_json
+  Gusto::PayrollEmployeeCompensationsTypeItem.from_json(json_object: item)
+end
+        unless parsed_json["payment_speed_changed"].nil?
+          payment_speed_changed = parsed_json["payment_speed_changed"].to_json
+          payment_speed_changed = Gusto::PayrollPaymentSpeedChangedType.from_json(json_object: payment_speed_changed)
+        else
+          payment_speed_changed = nil
+        end
+        created_at = unless parsed_json["created_at"].nil?
+  DateTime.parse(parsed_json["created_at"])
+else
+  nil
+end
+        fixed_compensation_types = parsed_json["fixed_compensation_types"]&.map do | item |
+  item = item.to_json
+  Gusto::PayrollFixedCompensationTypesTypeItem.from_json(json_object: item)
+end
+        unless parsed_json["processing_request"].nil?
+          processing_request = parsed_json["processing_request"].to_json
+          processing_request = Gusto::PayrollProcessingRequest.from_json(json_object: processing_request)
+        else
+          processing_request = nil
+        end
+        new(
+          payroll_deadline: payroll_deadline,
+          check_date: check_date,
+          processed: processed,
+          processed_date: processed_date,
+          calculated_at: calculated_at,
+          payroll_uuid: payroll_uuid,
+          company_uuid: company_uuid,
+          off_cycle: off_cycle,
+          off_cycle_reason: off_cycle_reason,
+          auto_pilot: auto_pilot,
+          external: external,
+          final_termination_payroll: final_termination_payroll,
+          withholding_pay_period: withholding_pay_period,
+          skip_regular_deductions: skip_regular_deductions,
+          fixed_withholding_rate: fixed_withholding_rate,
+          pay_period: pay_period,
+          payroll_status_meta: payroll_status_meta,
+          employee_compensations: employee_compensations,
+          payment_speed_changed: payment_speed_changed,
+          created_at: created_at,
+          fixed_compensation_types: fixed_compensation_types,
+          processing_request: processing_request,
+          additional_properties: struct
+        )
+      end
+# Serialize an instance of PayrollPrepared 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.payroll_deadline&.is_a?(DateTime) != false || raise("Passed value for field obj.payroll_deadline is not the expected type, validation failed.")
+        obj.check_date&.is_a?(String) != false || raise("Passed value for field obj.check_date is not the expected type, validation failed.")
+        obj.processed&.is_a?(Boolean) != false || raise("Passed value for field obj.processed is not the expected type, validation failed.")
+        obj.processed_date&.is_a?(String) != false || raise("Passed value for field obj.processed_date is not the expected type, validation failed.")
+        obj.calculated_at&.is_a?(String) != false || raise("Passed value for field obj.calculated_at is not the expected type, validation failed.")
+        obj.payroll_uuid&.is_a?(String) != false || raise("Passed value for field obj.payroll_uuid is not the expected type, validation failed.")
+        obj.company_uuid&.is_a?(String) != false || raise("Passed value for field obj.company_uuid is not the expected type, validation failed.")
+        obj.off_cycle&.is_a?(Boolean) != false || raise("Passed value for field obj.off_cycle is not the expected type, validation failed.")
+        obj.off_cycle_reason&.is_a?(Gusto::OffCycleReasonType) != false || raise("Passed value for field obj.off_cycle_reason is not the expected type, validation failed.")
+        obj.auto_pilot&.is_a?(Boolean) != false || raise("Passed value for field obj.auto_pilot is not the expected type, validation failed.")
+        obj.external&.is_a?(Boolean) != false || raise("Passed value for field obj.external is not the expected type, validation failed.")
+        obj.final_termination_payroll&.is_a?(Boolean) != false || raise("Passed value for field obj.final_termination_payroll is not the expected type, validation failed.")
+        obj.withholding_pay_period&.is_a?(Gusto::PayrollWithholdingPayPeriodType) != false || raise("Passed value for field obj.withholding_pay_period is not the expected type, validation failed.")
+        obj.skip_regular_deductions&.is_a?(Boolean) != false || raise("Passed value for field obj.skip_regular_deductions is not the expected type, validation failed.")
+        obj.fixed_withholding_rate&.is_a?(Boolean) != false || raise("Passed value for field obj.fixed_withholding_rate is not the expected type, validation failed.")
+        obj.pay_period.nil? || Gusto::PayrollPayPeriodType.validate_raw(obj: obj.pay_period)
+        obj.payroll_status_meta.nil? || Gusto::PayrollPayrollStatusMetaType.validate_raw(obj: obj.payroll_status_meta)
+        obj.employee_compensations&.is_a?(Array) != false || raise("Passed value for field obj.employee_compensations is not the expected type, validation failed.")
+        obj.payment_speed_changed.nil? || Gusto::PayrollPaymentSpeedChangedType.validate_raw(obj: obj.payment_speed_changed)
+        obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+        obj.fixed_compensation_types&.is_a?(Array) != false || raise("Passed value for field obj.fixed_compensation_types is not the expected type, validation failed.")
+        obj.processing_request.nil? || Gusto::PayrollProcessingRequest.validate_raw(obj: obj.processing_request)
+      end
+    end
+  end
+end

data/lib/fern_gusto/recovery_cases/client.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "../types/recovery_case"
+require "json"
+require "async"
+require "async"
+require_relative "../../requests"
+
+module Gusto
+  class RecoveryCasesClient
+  # @return [Gusto::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::RecoveryCasesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Fetch all recovery cases for a company.
+#  scope: `recovery_cases:read`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::RecoveryCase>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.recovery_cases.list(company_uuid: "company_uuid")
+    def list(company_uuid:, request_options: nil)
+      response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/recovery_cases"
+end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do | item |
+        item = item.to_json
+        Gusto::RecoveryCase.from_json(json_object: item)
+      end
+    end
+# After resolving the underlying bank error, initiate a redebit for an open
+#  recovery case. This submission is asynchronous and a successful request responds
+#  with a 202 HTTP status.
+#  It may take up to four business days for the ACH debit to process; in the
+#  meantime, the status of the recovery case will be in the `initiated_redebit`
+#  state. When funds are successfully redebited, the recovery case is transitioned
+#  to the `recovered` state.
+#  If the company has exceeded maximum redebit attempts, or if the recovery case is
+#  not in a redebitable state, the response will be 422 Unprocessable Entity.
+#  scope: `recovery_cases:write`
+    #
+    # @param recovery_case_uuid [String] The UUID of the recovery case
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Void]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.recovery_cases.redebit(recovery_case_uuid: "recovery_case_uuid")
+    def redebit(recovery_case_uuid:, request_options: nil)
+      response = @request_client.conn.put do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/recovery_cases/#{recovery_case_uuid}/redebit"
+end
+    end
+  end
+  class AsyncRecoveryCasesClient
+  # @return [Gusto::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Gusto::RequestClient] 
+    # @return [Gusto::AsyncRecoveryCasesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+# Fetch all recovery cases for a company.
+#  scope: `recovery_cases:read`
+    #
+    # @param company_uuid [String] The UUID of the company
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Array<Gusto::RecoveryCase>]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.recovery_cases.list(company_uuid: "company_uuid")
+    def list(company_uuid:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_uuid}/recovery_cases"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::RecoveryCase.from_json(json_object: item)
+        end
+      end
+    end
+# After resolving the underlying bank error, initiate a redebit for an open
+#  recovery case. This submission is asynchronous and a successful request responds
+#  with a 202 HTTP status.
+#  It may take up to four business days for the ACH debit to process; in the
+#  meantime, the status of the recovery case will be in the `initiated_redebit`
+#  state. When funds are successfully redebited, the recovery case is transitioned
+#  to the `recovered` state.
+#  If the company has exceeded maximum redebit attempts, or if the recovery case is
+#  not in a redebitable state, the response will be 422 Unprocessable Entity.
+#  scope: `recovery_cases:write`
+    #
+    # @param recovery_case_uuid [String] The UUID of the recovery case
+    # @param request_options [Gusto::RequestOptions] 
+    # @return [Void]
+    # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.recovery_cases.redebit(recovery_case_uuid: "recovery_case_uuid")
+    def redebit(recovery_case_uuid:, request_options: nil)
+      Async do
+        response = @request_client.conn.put do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  unless request_options.nil? || request_options&.additional_query_parameters.nil?
+    req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+  end
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/recovery_cases/#{recovery_case_uuid}/redebit"
+end
+      end
+    end
+  end
+end