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

data/rbi/finch_api/models/sandbox/employment_update_params.rbi

@@ -7,6 +7,9 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
         # Worker's compensation classification code for this employee
         sig { returns(T.nilable(String)) }
         attr_accessor :class_code
@@ -14,47 +17,69 @@ module FinchAPI
         # 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])) }
+        sig do
+          returns(
+            T.nilable(
+              T::Array[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]
+            )
+          )
+        end
         attr_reader :custom_fields
 
         sig do
           params(
-            custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Internal::AnyHash)]
-          )
-            .void
+            custom_fields:
+              T::Array[
+                FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
+              ]
+          ).void
         end
         attr_writer :custom_fields
 
         # The department object.
-        sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department)) }
+        sig do
+          returns(
+            T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Department)
+          )
+        end
         attr_reader :department
 
         sig do
           params(
-            department: T.nilable(
-              T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Internal::AnyHash)
-            )
-          )
-            .void
+            department:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash
+              )
+          ).void
         end
         attr_writer :department
 
         # The employment object.
-        sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment)) }
+        sig do
+          returns(
+            T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Employment)
+          )
+        end
         attr_reader :employment
 
         sig do
           params(
-            employment: T.nilable(
-              T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Internal::AnyHash)
-            )
-          )
-            .void
+            employment:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::OrHash
+              )
+          ).void
         end
         attr_writer :employment
 
         # The detailed employment status of the individual.
-        sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol)) }
+        sig do
+          returns(
+            T.nilable(
+              FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol
+            )
+          )
+        end
         attr_accessor :employment_status
 
         sig { returns(T.nilable(String)) }
@@ -67,14 +92,14 @@ module FinchAPI
         # 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)) }
+        sig { returns(T.nilable(FinchAPI::Income)) }
         attr_reader :income
 
-        sig { params(income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))).void }
+        sig { params(income: T.nilable(FinchAPI::Income::OrHash)).void }
         attr_writer :income
 
         # The array of income history.
-        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)])) }
+        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Income)])) }
         attr_accessor :income_history
 
         # `true` if the individual an an active employee or contractor at the company.
@@ -88,21 +113,25 @@ module FinchAPI
         sig { returns(T.nilable(String)) }
         attr_accessor :latest_rehire_date
 
-        sig { returns(T.nilable(FinchAPI::Models::Location)) }
+        sig { returns(T.nilable(FinchAPI::Location)) }
         attr_reader :location
 
-        sig { params(location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void }
+        sig { params(location: T.nilable(FinchAPI::Location::OrHash)).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)) }
+        sig do
+          returns(T.nilable(FinchAPI::Sandbox::EmploymentUpdateParams::Manager))
+        end
         attr_reader :manager
 
         sig do
           params(
-            manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Internal::AnyHash))
-          )
-            .void
+            manager:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash
+              )
+          ).void
         end
         attr_writer :manager
 
@@ -127,30 +156,41 @@ module FinchAPI
         sig do
           params(
             class_code: T.nilable(String),
-            custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Internal::AnyHash)],
-            department: T.nilable(
-              T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Internal::AnyHash)
-            ),
-            employment: T.nilable(
-              T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Internal::AnyHash)
-            ),
-            employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol),
+            custom_fields:
+              T::Array[
+                FinchAPI::Sandbox::EmploymentUpdateParams::CustomField::OrHash
+              ],
+            department:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Department::OrHash
+              ),
+            employment:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::OrHash
+              ),
+            employment_status:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol
+              ),
             end_date: T.nilable(String),
             first_name: T.nilable(String),
-            income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash)),
-            income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Internal::AnyHash))]),
+            income: T.nilable(FinchAPI::Income::OrHash),
+            income_history:
+              T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]),
             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::Internal::AnyHash)),
-            manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Internal::AnyHash)),
+            location: T.nilable(FinchAPI::Location::OrHash),
+            manager:
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Manager::OrHash
+              ),
             middle_name: T.nilable(String),
             source_id: String,
             start_date: T.nilable(String),
             title: T.nilable(String),
-            request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Internal::AnyHash)
-          )
-            .returns(T.attached_class)
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
         def self.new(
           # Worker's compensation classification code for this employee
@@ -190,36 +230,54 @@ module FinchAPI
           # The current title of the individual.
           title: nil,
           request_options: {}
-        ); end
+        )
+        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
-              }
-            )
+          override.returns(
+            {
+              class_code: T.nilable(String),
+              custom_fields:
+                T::Array[
+                  FinchAPI::Sandbox::EmploymentUpdateParams::CustomField
+                ],
+              department:
+                T.nilable(
+                  FinchAPI::Sandbox::EmploymentUpdateParams::Department
+                ),
+              employment:
+                T.nilable(
+                  FinchAPI::Sandbox::EmploymentUpdateParams::Employment
+                ),
+              employment_status:
+                T.nilable(
+                  FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol
+                ),
+              end_date: T.nilable(String),
+              first_name: T.nilable(String),
+              income: T.nilable(FinchAPI::Income),
+              income_history: T.nilable(T::Array[T.nilable(FinchAPI::Income)]),
+              is_active: T.nilable(T::Boolean),
+              last_name: T.nilable(String),
+              latest_rehire_date: T.nilable(String),
+              location: T.nilable(FinchAPI::Location),
+              manager:
+                T.nilable(FinchAPI::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
-        def to_hash; end
 
         class CustomField < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
           sig { returns(T.nilable(String)) }
           attr_accessor :name
 
@@ -229,14 +287,25 @@ module FinchAPI
           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 do
+            params(name: T.nilable(String), value: T.anything).returns(
+              T.attached_class
+            )
+          end
+          def self.new(name: nil, value: nil)
+          end
 
-          sig { override.returns({name: T.nilable(String), value: T.anything}) }
-          def to_hash; end
+          sig do
+            override.returns({ name: T.nilable(String), value: T.anything })
+          end
+          def to_hash
+          end
         end
 
         class Department < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
           # The name of the department associated with the individual.
           sig { returns(T.nilable(String)) }
           attr_accessor :name
@@ -246,28 +315,51 @@ module FinchAPI
           def self.new(
             # The name of the department associated with the individual.
             name: nil
-          ); end
-          sig { override.returns({name: T.nilable(String)}) }
-          def to_hash; end
+          )
+          end
+
+          sig { override.returns({ name: T.nilable(String) }) }
+          def to_hash
+          end
         end
 
         class Employment < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
           # 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)) }
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol
+              )
+            )
+          end
           attr_accessor :subtype
 
           # The main employment type of the individual.
-          sig { returns(T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol)) }
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol
+              )
+            )
+          end
           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)
+              subtype:
+                T.nilable(
+                  FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol
+                ),
+              type:
+                T.nilable(
+                  FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol
+                )
+            ).returns(T.attached_class)
           end
           def self.new(
             # The secondary employment type of the individual. Options: `full_time`,
@@ -275,17 +367,25 @@ module FinchAPI
             subtype: nil,
             # The main employment type of the individual.
             type: nil
-          ); end
+          )
+          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)
-                }
-              )
+            override.returns(
+              {
+                subtype:
+                  T.nilable(
+                    FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::OrSymbol
+                  ),
+                type:
+                  T.nilable(
+                    FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::OrSymbol
+                  )
+              }
+            )
+          end
+          def to_hash
           end
-          def to_hash; end
 
           # The secondary employment type of the individual. Options: `full_time`,
           # `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
@@ -293,29 +393,54 @@ module FinchAPI
             extend FinchAPI::Internal::Type::Enum
 
             TaggedSymbol =
-              T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype) }
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype
+                )
+              end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             FULL_TIME =
-              T.let(:full_time, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol)
+              T.let(
+                :full_time,
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol
+              )
             INTERN =
-              T.let(:intern, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol)
+              T.let(
+                :intern,
+                FinchAPI::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)
+              T.let(
+                :part_time,
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol
+              )
+            TEMP =
+              T.let(
+                :temp,
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol
+              )
             SEASONAL =
-              T.let(:seasonal, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol)
+              T.let(
+                :seasonal,
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol
+              )
             INDIVIDUAL_CONTRACTOR =
               T.let(
                 :individual_contractor,
-                FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol
               )
 
             sig do
-              override
-                .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol])
+              override.returns(
+                T::Array[
+                  FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
             end
-            def self.values; end
           end
 
           # The main employment type of the individual.
@@ -323,19 +448,34 @@ module FinchAPI
             extend FinchAPI::Internal::Type::Enum
 
             TaggedSymbol =
-              T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type) }
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type
+                )
+              end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             EMPLOYEE =
-              T.let(:employee, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol)
+              T.let(
+                :employee,
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol
+              )
             CONTRACTOR =
-              T.let(:contractor, FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol)
+              T.let(
+                :contractor,
+                FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol
+              )
 
             sig do
-              override
-                .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol])
+              override.returns(
+                T::Array[
+                  FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
             end
-            def self.values; end
           end
         end
 
@@ -344,31 +484,65 @@ module FinchAPI
           extend FinchAPI::Internal::Type::Enum
 
           TaggedSymbol =
-            T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus) }
+            T.type_alias do
+              T.all(
+                Symbol,
+                FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus
+              )
+            end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           ACTIVE =
-            T.let(:active, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
+            T.let(
+              :active,
+              FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol
+            )
           DECEASED =
-            T.let(:deceased, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
-          LEAVE = T.let(:leave, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
+            T.let(
+              :deceased,
+              FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol
+            )
+          LEAVE =
+            T.let(
+              :leave,
+              FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol
+            )
           ONBOARDING =
-            T.let(:onboarding, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
+            T.let(
+              :onboarding,
+              FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol
+            )
           PREHIRE =
-            T.let(:prehire, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
+            T.let(
+              :prehire,
+              FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol
+            )
           RETIRED =
-            T.let(:retired, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
+            T.let(
+              :retired,
+              FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol
+            )
           TERMINATED =
-            T.let(:terminated, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol)
+            T.let(
+              :terminated,
+              FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol
+            )
 
           sig do
-            override
-              .returns(T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol])
+            override.returns(
+              T::Array[
+                FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
           end
-          def self.values; end
         end
 
         class Manager < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
           # A stable Finch `id` (UUID v4) for an individual in the company.
           sig { returns(T.nilable(String)) }
           attr_reader :id
@@ -381,9 +555,12 @@ module FinchAPI
           def self.new(
             # A stable Finch `id` (UUID v4) for an individual in the company.
             id: nil
-          ); end
-          sig { override.returns({id: String}) }
-          def to_hash; end
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
         end
       end
     end