finch-api 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.13

data/rbi/lib/finch-api/models/sandbox/employment_update_params.rbi

@@ -1,373 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module Sandbox
-      class EmploymentUpdateParams < FinchAPI::BaseModel
-        extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # Worker's compensation classification code for this employee
-        sig { returns(T.nilable(String)) }
-        attr_accessor :class_code
-
-        # Custom fields for the individual. These are fields which are defined by the
-        #   employer in the system. Custom fields are not currently supported for assisted
-        #   connections.
-        sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField])) }
-        attr_reader :custom_fields
-
-        sig do
-          params(
-            custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)]
-          )
-            .void
-        end
-        attr_writer :custom_fields
-
-        # The department object.
-        sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department)) }
-        attr_reader :department
-
-        sig do
-          params(
-            department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash))
-          )
-            .void
-        end
-        attr_writer :department
-
-        # The employment object.
-        sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment)) }
-        attr_reader :employment
-
-        sig do
-          params(
-            employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash))
-          )
-            .void
-        end
-        attr_writer :employment
-
-        # The detailed employment status of the individual.
-        sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol)) }
-        attr_accessor :employment_status
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :end_date
-
-        # The legal first name of the individual.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :first_name
-
-        # The employee's income as reported by the provider. This may not always be
-        #   annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
-        #   depending on what information the provider returns.
-        sig { returns(T.nilable(FinchAPI::Models::Income)) }
-        attr_reader :income
-
-        sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))).void }
-        attr_writer :income
-
-        # The array of income history.
-        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) }
-        attr_accessor :income_history
-
-        # `true` if the individual an an active employee or contractor at the company.
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_accessor :is_active
-
-        # The legal last name of the individual.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :last_name
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :latest_rehire_date
-
-        sig { returns(T.nilable(FinchAPI::Models::Location)) }
-        attr_reader :location
-
-        sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void }
-        attr_writer :location
-
-        # The manager object representing the manager of the individual within the org.
-        sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager)) }
-        attr_reader :manager
-
-        sig do
-          params(
-            manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash))
-          )
-            .void
-        end
-        attr_writer :manager
-
-        # The legal middle name of the individual.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :middle_name
-
-        # The source system's unique employment identifier for this individual
-        sig { returns(T.nilable(String)) }
-        attr_reader :source_id
-
-        sig { params(source_id: String).void }
-        attr_writer :source_id
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :start_date
-
-        # The current title of the individual.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :title
-
-        sig do
-          params(
-            class_code: T.nilable(String),
-            custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)],
-            department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)),
-            employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)),
-            employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol),
-            end_date: T.nilable(String),
-            first_name: T.nilable(String),
-            income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)),
-            income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))]),
-            is_active: T.nilable(T::Boolean),
-            last_name: T.nilable(String),
-            latest_rehire_date: T.nilable(String),
-            location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)),
-            manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash)),
-            middle_name: T.nilable(String),
-            source_id: String,
-            start_date: T.nilable(String),
-            title: T.nilable(String),
-            request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(
-          class_code: nil,
-          custom_fields: nil,
-          department: nil,
-          employment: nil,
-          employment_status: nil,
-          end_date: nil,
-          first_name: nil,
-          income: nil,
-          income_history: nil,
-          is_active: nil,
-          last_name: nil,
-          latest_rehire_date: nil,
-          location: nil,
-          manager: nil,
-          middle_name: nil,
-          source_id: nil,
-          start_date: nil,
-          title: nil,
-          request_options: {}
-        )
-        end
-
-        sig do
-          override
-            .returns(
-              {
-                class_code: T.nilable(String),
-                custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField],
-                department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department),
-                employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment),
-                employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol),
-                end_date: T.nilable(String),
-                first_name: T.nilable(String),
-                income: T.nilable(FinchAPI::Models::Income),
-                income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]),
-                is_active: T.nilable(T::Boolean),
-                last_name: T.nilable(String),
-                latest_rehire_date: T.nilable(String),
-                location: T.nilable(FinchAPI::Models::Location),
-                manager: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager),
-                middle_name: T.nilable(String),
-                source_id: String,
-                start_date: T.nilable(String),
-                title: T.nilable(String),
-                request_options: FinchAPI::RequestOptions
-              }
-            )
-        end
-        def to_hash
-        end
-
-        class CustomField < FinchAPI::BaseModel
-          sig { returns(T.nilable(String)) }
-          attr_accessor :name
-
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :value
-
-          sig { params(value: T.anything).void }
-          attr_writer :value
-
-          sig { params(name: T.nilable(String), value: T.anything).returns(T.attached_class) }
-          def self.new(name: nil, value: nil)
-          end
-
-          sig { override.returns({name: T.nilable(String), value: T.anything}) }
-          def to_hash
-          end
-        end
-
-        class Department < FinchAPI::BaseModel
-          # The name of the department associated with the individual.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :name
-
-          # The department object.
-          sig { params(name: T.nilable(String)).returns(T.attached_class) }
-          def self.new(name: nil)
-          end
-
-          sig { override.returns({name: T.nilable(String)}) }
-          def to_hash
-          end
-        end
-
-        class Employment < FinchAPI::BaseModel
-          # The secondary employment type of the individual. Options: `full_time`,
-          #   `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
-          sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol)) }
-          attr_accessor :subtype
-
-          # The main employment type of the individual.
-          sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)) }
-          attr_accessor :type
-
-          # The employment object.
-          sig do
-            params(
-              subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol),
-              type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)
-            )
-              .returns(T.attached_class)
-          end
-          def self.new(subtype: nil, type: nil)
-          end
-
-          sig do
-            override
-              .returns(
-                {
-                  subtype: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol),
-                  type: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)
-                }
-              )
-          end
-          def to_hash
-          end
-
-          # The secondary employment type of the individual. Options: `full_time`,
-          #   `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
-          module Subtype
-            extend FinchAPI::Enum
-
-            TaggedSymbol =
-              T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype) }
-            OrSymbol =
-              T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol) }
-
-            FULL_TIME =
-              T.let(:full_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol)
-            INTERN =
-              T.let(:intern, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol)
-            PART_TIME =
-              T.let(:part_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol)
-            TEMP = T.let(:temp, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol)
-            SEASONAL =
-              T.let(:seasonal, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol)
-            INDIVIDUAL_CONTRACTOR =
-              T.let(
-                :individual_contractor,
-                FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol
-              )
-
-            sig do
-              override
-                .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol])
-            end
-            def self.values
-            end
-          end
-
-          # The main employment type of the individual.
-          module Type
-            extend FinchAPI::Enum
-
-            TaggedSymbol =
-              T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type) }
-            OrSymbol =
-              T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol) }
-
-            EMPLOYEE =
-              T.let(:employee, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol)
-            CONTRACTOR =
-              T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol)
-
-            sig do
-              override
-                .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol])
-            end
-            def self.values
-            end
-          end
-        end
-
-        # The detailed employment status of the individual.
-        module EmploymentStatus
-          extend FinchAPI::Enum
-
-          TaggedSymbol =
-            T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus) }
-          OrSymbol =
-            T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol) }
-
-          ACTIVE =
-            T.let(:active, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
-          DECEASED =
-            T.let(:deceased, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
-          LEAVE = T.let(:leave, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
-          ONBOARDING =
-            T.let(:onboarding, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
-          PREHIRE =
-            T.let(:prehire, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
-          RETIRED =
-            T.let(:retired, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
-          TERMINATED =
-            T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
-
-          sig do
-            override
-              .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol])
-          end
-          def self.values
-          end
-        end
-
-        class Manager < FinchAPI::BaseModel
-          # A stable Finch `id` (UUID v4) for an individual in the company.
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          # The manager object representing the manager of the individual within the org.
-          sig { params(id: String).returns(T.attached_class) }
-          def self.new(id: nil)
-          end
-
-          sig { override.returns({id: String}) }
-          def to_hash
-          end
-        end
-      end
-    end
-  end
-end