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

data/rbi/finch_api/models/hris/individual.rbi

@@ -6,7 +6,18 @@ module FinchAPI
       module Individual
         extend FinchAPI::Internal::Type::Union
 
+        Variants =
+          T.type_alias do
+            T.any(
+              FinchAPI::HRIS::Individual::UnionMember0,
+              FinchAPI::HRIS::Individual::BatchError
+            )
+          end
+
         class UnionMember0 < 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(String) }
           attr_accessor :id
@@ -15,7 +26,13 @@ module FinchAPI
           attr_accessor :dob
 
           # The EEOC-defined ethnicity of the individual.
-          sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol)) }
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+              )
+            )
+          end
           attr_accessor :ethnicity
 
           # The legal first name of the individual.
@@ -23,7 +40,13 @@ module FinchAPI
           attr_accessor :first_name
 
           # The gender of the individual.
-          sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol)) }
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+              )
+            )
+          end
           attr_accessor :gender
 
           # The legal last name of the individual.
@@ -34,20 +57,36 @@ module FinchAPI
           sig { returns(T.nilable(String)) }
           attr_accessor :middle_name
 
-          sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber)])) }
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  T.nilable(
+                    FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber
+                  )
+                ]
+              )
+            )
+          end
           attr_accessor :phone_numbers
 
           # The preferred name of the individual.
           sig { returns(T.nilable(String)) }
           attr_accessor :preferred_name
 
-          sig { returns(T.nilable(FinchAPI::Models::Location)) }
+          sig { returns(T.nilable(FinchAPI::Location)) }
           attr_reader :residence
 
-          sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash))).void }
+          sig { params(residence: T.nilable(FinchAPI::Location::OrHash)).void }
           attr_writer :residence
 
-          sig { returns(T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email])) }
+          sig do
+            returns(
+              T.nilable(
+                T::Array[FinchAPI::HRIS::Individual::UnionMember0::Email]
+              )
+            )
+          end
           attr_accessor :emails
 
           # Social Security Number of the individual in **encrypted** format. This field is
@@ -67,27 +106,36 @@ module FinchAPI
             params(
               id: String,
               dob: T.nilable(String),
-              ethnicity: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::OrSymbol),
+              ethnicity:
+                T.nilable(
+                  FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::OrSymbol
+                ),
               first_name: T.nilable(String),
-              gender: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::OrSymbol),
+              gender:
+                T.nilable(
+                  FinchAPI::HRIS::Individual::UnionMember0::Gender::OrSymbol
+                ),
               last_name: T.nilable(String),
               middle_name: T.nilable(String),
-              phone_numbers: T.nilable(
-                T::Array[
-                  T.nilable(
-                    T.any(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber, FinchAPI::Internal::AnyHash)
-                  )
-                ]
-              ),
+              phone_numbers:
+                T.nilable(
+                  T::Array[
+                    T.nilable(
+                      FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::OrHash
+                    )
+                  ]
+                ),
               preferred_name: T.nilable(String),
-              residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Internal::AnyHash)),
-              emails: T.nilable(
-                T::Array[T.any(FinchAPI::Models::HRIS::Individual::UnionMember0::Email, FinchAPI::Internal::AnyHash)]
-              ),
+              residence: T.nilable(FinchAPI::Location::OrHash),
+              emails:
+                T.nilable(
+                  T::Array[
+                    FinchAPI::HRIS::Individual::UnionMember0::Email::OrHash
+                  ]
+                ),
               encrypted_ssn: T.nilable(String),
               ssn: T.nilable(String)
-            )
-              .returns(T.attached_class)
+            ).returns(T.attached_class)
           end
           def self.new(
             # A stable Finch `id` (UUID v4) for an individual in the company.
@@ -117,169 +165,313 @@ module FinchAPI
             # body.
             # [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
             ssn: nil
-          ); end
+          )
+          end
+
           sig do
-            override
-              .returns(
-                {
-                  id: String,
-                  dob: T.nilable(String),
-                  ethnicity: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol),
-                  first_name: T.nilable(String),
-                  gender: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol),
-                  last_name: T.nilable(String),
-                  middle_name: T.nilable(String),
-                  phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber)]),
-                  preferred_name: T.nilable(String),
-                  residence: T.nilable(FinchAPI::Models::Location),
-                  emails: T.nilable(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email]),
-                  encrypted_ssn: T.nilable(String),
-                  ssn: T.nilable(String)
-                }
-              )
+            override.returns(
+              {
+                id: String,
+                dob: T.nilable(String),
+                ethnicity:
+                  T.nilable(
+                    FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                  ),
+                first_name: T.nilable(String),
+                gender:
+                  T.nilable(
+                    FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+                  ),
+                last_name: T.nilable(String),
+                middle_name: T.nilable(String),
+                phone_numbers:
+                  T.nilable(
+                    T::Array[
+                      T.nilable(
+                        FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber
+                      )
+                    ]
+                  ),
+                preferred_name: T.nilable(String),
+                residence: T.nilable(FinchAPI::Location),
+                emails:
+                  T.nilable(
+                    T::Array[FinchAPI::HRIS::Individual::UnionMember0::Email]
+                  ),
+                encrypted_ssn: T.nilable(String),
+                ssn: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
           end
-          def to_hash; end
 
           # The EEOC-defined ethnicity of the individual.
           module Ethnicity
             extend FinchAPI::Internal::Type::Enum
 
             TaggedSymbol =
-              T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity) }
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::HRIS::Individual::UnionMember0::Ethnicity
+                )
+              end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            ASIAN = T.let(:asian, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol)
-            WHITE = T.let(:white, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol)
+            ASIAN =
+              T.let(
+                :asian,
+                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+              )
+            WHITE =
+              T.let(
+                :white,
+                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+              )
             BLACK_OR_AFRICAN_AMERICAN =
               T.let(
                 :black_or_african_american,
-                FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
               )
             NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER =
               T.let(
                 :native_hawaiian_or_pacific_islander,
-                FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
               )
             AMERICAN_INDIAN_OR_ALASKA_NATIVE =
               T.let(
                 :american_indian_or_alaska_native,
-                FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
               )
             HISPANIC_OR_LATINO =
-              T.let(:hispanic_or_latino, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol)
+              T.let(
+                :hispanic_or_latino,
+                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+              )
             TWO_OR_MORE_RACES =
-              T.let(:two_or_more_races, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol)
+              T.let(
+                :two_or_more_races,
+                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+              )
             DECLINE_TO_SPECIFY =
-              T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol)
+              T.let(
+                :decline_to_specify,
+                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+              )
 
-            sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol]) }
-            def self.values; end
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
           end
 
           # The gender of the individual.
           module Gender
             extend FinchAPI::Internal::Type::Enum
 
-            TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender) }
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, FinchAPI::HRIS::Individual::UnionMember0::Gender)
+              end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-            FEMALE = T.let(:female, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol)
-            MALE = T.let(:male, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol)
-            OTHER = T.let(:other, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol)
+            FEMALE =
+              T.let(
+                :female,
+                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+              )
+            MALE =
+              T.let(
+                :male,
+                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+              )
+            OTHER =
+              T.let(
+                :other,
+                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+              )
             DECLINE_TO_SPECIFY =
-              T.let(:decline_to_specify, FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol)
+              T.let(
+                :decline_to_specify,
+                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+              )
 
-            sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Gender::TaggedSymbol]) }
-            def self.values; end
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
           end
 
           class PhoneNumber < FinchAPI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
             sig { returns(T.nilable(String)) }
             attr_accessor :data
 
-            sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol)) }
+            sig do
+              returns(
+                T.nilable(
+                  FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                )
+              )
+            end
             attr_accessor :type
 
             sig do
               params(
                 data: T.nilable(String),
-                type: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::OrSymbol)
-              )
-                .returns(T.attached_class)
+                type:
+                  T.nilable(
+                    FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::OrSymbol
+                  )
+              ).returns(T.attached_class)
+            end
+            def self.new(data:, type:)
             end
-            def self.new(data:, type:); end
 
             sig do
-              override
-                .returns(
-                  {
-                    data: T.nilable(String),
-                    type: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol)
-                  }
-                )
+              override.returns(
+                {
+                  data: T.nilable(String),
+                  type:
+                    T.nilable(
+                      FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                    )
+                }
+              )
+            end
+            def to_hash
             end
-            def to_hash; end
 
             module Type
               extend FinchAPI::Internal::Type::Enum
 
               TaggedSymbol =
-                T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type) }
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type
+                  )
+                end
               OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-              WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol)
+              WORK =
+                T.let(
+                  :work,
+                  FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                )
               PERSONAL =
-                T.let(:personal, FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol)
+                T.let(
+                  :personal,
+                  FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                )
 
               sig do
-                override
-                  .returns(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol])
+                override.returns(
+                  T::Array[
+                    FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
               end
-              def self.values; end
             end
           end
 
           class Email < FinchAPI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
             sig { returns(String) }
             attr_accessor :data
 
-            sig { returns(T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol)) }
+            sig do
+              returns(
+                T.nilable(
+                  FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                )
+              )
+            end
             attr_accessor :type
 
             sig do
               params(
                 data: String,
-                type: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::OrSymbol)
-              )
-                .returns(T.attached_class)
+                type:
+                  T.nilable(
+                    FinchAPI::HRIS::Individual::UnionMember0::Email::Type::OrSymbol
+                  )
+              ).returns(T.attached_class)
+            end
+            def self.new(data:, type:)
             end
-            def self.new(data:, type:); end
 
             sig do
-              override
-                .returns(
-                  {data: String, type: T.nilable(FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol)}
-                )
+              override.returns(
+                {
+                  data: String,
+                  type:
+                    T.nilable(
+                      FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                    )
+                }
+              )
+            end
+            def to_hash
             end
-            def to_hash; end
 
             module Type
               extend FinchAPI::Internal::Type::Enum
 
               TaggedSymbol =
-                T.type_alias { T.all(Symbol, FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type) }
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    FinchAPI::HRIS::Individual::UnionMember0::Email::Type
+                  )
+                end
               OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-              WORK = T.let(:work, FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol)
-              PERSONAL = T.let(:personal, FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol)
+              WORK =
+                T.let(
+                  :work,
+                  FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                )
+              PERSONAL =
+                T.let(
+                  :personal,
+                  FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                )
 
-              sig { override.returns(T::Array[FinchAPI::Models::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol]) }
-              def self.values; end
+              sig do
+                override.returns(
+                  T::Array[
+                    FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
             end
           end
         end
 
         class BatchError < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
           sig { returns(Float) }
           attr_accessor :code
 
@@ -296,21 +488,28 @@ module FinchAPI
           attr_writer :finch_code
 
           sig do
-            params(code: Float, message: String, name: String, finch_code: String).returns(T.attached_class)
+            params(
+              code: Float,
+              message: String,
+              name: String,
+              finch_code: String
+            ).returns(T.attached_class)
+          end
+          def self.new(code:, message:, name:, finch_code: nil)
           end
-          def self.new(code:, message:, name:, finch_code: nil); end
 
-          sig { override.returns({code: Float, message: String, name: String, finch_code: String}) }
-          def to_hash; end
+          sig do
+            override.returns(
+              { code: Float, message: String, name: String, finch_code: String }
+            )
+          end
+          def to_hash
+          end
         end
 
-        sig do
-          override
-            .returns(
-              [FinchAPI::Models::HRIS::Individual::UnionMember0, FinchAPI::Models::HRIS::Individual::BatchError]
-            )
+        sig { override.returns(T::Array[FinchAPI::HRIS::Individual::Variants]) }
+        def self.variants
         end
-        def self.variants; end
       end
     end
   end