finch-api 0.1.0.pre.alpha.41 → 0.1.0.pre.alpha.43

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

@@ -9,16 +9,16 @@ module FinchAPI
         Variants =
           T.type_alias do
             T.any(
-              FinchAPI::HRIS::Individual::UnionMember0,
+              FinchAPI::HRIS::Individual::IndividualResponseBody,
               FinchAPI::HRIS::Individual::BatchError
             )
           end
 
-        class UnionMember0 < FinchAPI::Internal::Type::BaseModel
+        class IndividualResponseBody < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                FinchAPI::HRIS::Individual::UnionMember0,
+                FinchAPI::HRIS::Individual::IndividualResponseBody,
                 FinchAPI::Internal::AnyHash
               )
             end
@@ -34,7 +34,7 @@ module FinchAPI
           sig do
             returns(
               T.nilable(
-                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
               )
             )
           end
@@ -48,7 +48,7 @@ module FinchAPI
           sig do
             returns(
               T.nilable(
-                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::TaggedSymbol
               )
             )
           end
@@ -67,7 +67,7 @@ module FinchAPI
               T.nilable(
                 T::Array[
                   T.nilable(
-                    FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber
                   )
                 ]
               )
@@ -88,7 +88,9 @@ module FinchAPI
           sig do
             returns(
               T.nilable(
-                T::Array[FinchAPI::HRIS::Individual::UnionMember0::Email]
+                T::Array[
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Email
+                ]
               )
             )
           end
@@ -113,12 +115,12 @@ module FinchAPI
               dob: T.nilable(String),
               ethnicity:
                 T.nilable(
-                  FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::OrSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::OrSymbol
                 ),
               first_name: T.nilable(String),
               gender:
                 T.nilable(
-                  FinchAPI::HRIS::Individual::UnionMember0::Gender::OrSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::OrSymbol
                 ),
               last_name: T.nilable(String),
               middle_name: T.nilable(String),
@@ -126,7 +128,7 @@ module FinchAPI
                 T.nilable(
                   T::Array[
                     T.nilable(
-                      FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::OrHash
+                      FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber::OrHash
                     )
                   ]
                 ),
@@ -135,7 +137,7 @@ module FinchAPI
               emails:
                 T.nilable(
                   T::Array[
-                    FinchAPI::HRIS::Individual::UnionMember0::Email::OrHash
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::Email::OrHash
                   ]
                 ),
               encrypted_ssn: T.nilable(String),
@@ -180,12 +182,12 @@ module FinchAPI
                 dob: T.nilable(String),
                 ethnicity:
                   T.nilable(
-                    FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
                   ),
                 first_name: T.nilable(String),
                 gender:
                   T.nilable(
-                    FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::TaggedSymbol
                   ),
                 last_name: T.nilable(String),
                 middle_name: T.nilable(String),
@@ -193,7 +195,7 @@ module FinchAPI
                   T.nilable(
                     T::Array[
                       T.nilable(
-                        FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber
+                        FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber
                       )
                     ]
                   ),
@@ -201,7 +203,9 @@ module FinchAPI
                 residence: T.nilable(FinchAPI::Location),
                 emails:
                   T.nilable(
-                    T::Array[FinchAPI::HRIS::Individual::UnionMember0::Email]
+                    T::Array[
+                      FinchAPI::HRIS::Individual::IndividualResponseBody::Email
+                    ]
                   ),
                 encrypted_ssn: T.nilable(String),
                 ssn: T.nilable(String)
@@ -219,7 +223,7 @@ module FinchAPI
               T.type_alias do
                 T.all(
                   Symbol,
-                  FinchAPI::HRIS::Individual::UnionMember0::Ethnicity
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity
                 )
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -227,48 +231,48 @@ module FinchAPI
             ASIAN =
               T.let(
                 :asian,
-                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
               )
             WHITE =
               T.let(
                 :white,
-                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
               )
             BLACK_OR_AFRICAN_AMERICAN =
               T.let(
                 :black_or_african_american,
-                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
               )
             NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER =
               T.let(
                 :native_hawaiian_or_pacific_islander,
-                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
               )
             AMERICAN_INDIAN_OR_ALASKA_NATIVE =
               T.let(
                 :american_indian_or_alaska_native,
-                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
               )
             HISPANIC_OR_LATINO =
               T.let(
                 :hispanic_or_latino,
-                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
               )
             TWO_OR_MORE_RACES =
               T.let(
                 :two_or_more_races,
-                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
               )
             DECLINE_TO_SPECIFY =
               T.let(
                 :decline_to_specify,
-                FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  FinchAPI::HRIS::Individual::UnionMember0::Ethnicity::TaggedSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Ethnicity::TaggedSymbol
                 ]
               )
             end
@@ -282,35 +286,38 @@ module FinchAPI
 
             TaggedSymbol =
               T.type_alias do
-                T.all(Symbol, FinchAPI::HRIS::Individual::UnionMember0::Gender)
+                T.all(
+                  Symbol,
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Gender
+                )
               end
             OrSymbol = T.type_alias { T.any(Symbol, String) }
 
             FEMALE =
               T.let(
                 :female,
-                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::TaggedSymbol
               )
             MALE =
               T.let(
                 :male,
-                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::TaggedSymbol
               )
             OTHER =
               T.let(
                 :other,
-                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::TaggedSymbol
               )
             DECLINE_TO_SPECIFY =
               T.let(
                 :decline_to_specify,
-                FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+                FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::TaggedSymbol
               )
 
             sig do
               override.returns(
                 T::Array[
-                  FinchAPI::HRIS::Individual::UnionMember0::Gender::TaggedSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::TaggedSymbol
                 ]
               )
             end
@@ -322,7 +329,7 @@ module FinchAPI
             OrHash =
               T.type_alias do
                 T.any(
-                  FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber,
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber,
                   FinchAPI::Internal::AnyHash
                 )
               end
@@ -333,7 +340,7 @@ module FinchAPI
             sig do
               returns(
                 T.nilable(
-                  FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type::TaggedSymbol
                 )
               )
             end
@@ -344,7 +351,7 @@ module FinchAPI
                 data: T.nilable(String),
                 type:
                   T.nilable(
-                    FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::OrSymbol
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type::OrSymbol
                   )
               ).returns(T.attached_class)
             end
@@ -357,7 +364,7 @@ module FinchAPI
                   data: T.nilable(String),
                   type:
                     T.nilable(
-                      FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                      FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type::TaggedSymbol
                     )
                 }
               )
@@ -372,7 +379,7 @@ module FinchAPI
                 T.type_alias do
                   T.all(
                     Symbol,
-                    FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type
                   )
                 end
               OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -380,18 +387,18 @@ module FinchAPI
               WORK =
                 T.let(
                   :work,
-                  FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type::TaggedSymbol
                 )
               PERSONAL =
                 T.let(
                   :personal,
-                  FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type::TaggedSymbol
                 )
 
               sig do
                 override.returns(
                   T::Array[
-                    FinchAPI::HRIS::Individual::UnionMember0::PhoneNumber::Type::TaggedSymbol
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber::Type::TaggedSymbol
                   ]
                 )
               end
@@ -404,7 +411,7 @@ module FinchAPI
             OrHash =
               T.type_alias do
                 T.any(
-                  FinchAPI::HRIS::Individual::UnionMember0::Email,
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Email,
                   FinchAPI::Internal::AnyHash
                 )
               end
@@ -415,7 +422,7 @@ module FinchAPI
             sig do
               returns(
                 T.nilable(
-                  FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Email::Type::TaggedSymbol
                 )
               )
             end
@@ -426,7 +433,7 @@ module FinchAPI
                 data: String,
                 type:
                   T.nilable(
-                    FinchAPI::HRIS::Individual::UnionMember0::Email::Type::OrSymbol
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::Email::Type::OrSymbol
                   )
               ).returns(T.attached_class)
             end
@@ -439,7 +446,7 @@ module FinchAPI
                   data: String,
                   type:
                     T.nilable(
-                      FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                      FinchAPI::HRIS::Individual::IndividualResponseBody::Email::Type::TaggedSymbol
                     )
                 }
               )
@@ -454,7 +461,7 @@ module FinchAPI
                 T.type_alias do
                   T.all(
                     Symbol,
-                    FinchAPI::HRIS::Individual::UnionMember0::Email::Type
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::Email::Type
                   )
                 end
               OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -462,18 +469,18 @@ module FinchAPI
               WORK =
                 T.let(
                   :work,
-                  FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Email::Type::TaggedSymbol
                 )
               PERSONAL =
                 T.let(
                   :personal,
-                  FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::Email::Type::TaggedSymbol
                 )
 
               sig do
                 override.returns(
                   T::Array[
-                    FinchAPI::HRIS::Individual::UnionMember0::Email::Type::TaggedSymbol
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::Email::Type::TaggedSymbol
                   ]
                 )
               end

data/rbi/finch_api/models/hris/individual_response.rbi

@@ -25,7 +25,7 @@ module FinchAPI
           params(
             body:
               T.any(
-                FinchAPI::HRIS::Individual::UnionMember0::OrHash,
+                FinchAPI::HRIS::Individual::IndividualResponseBody::OrHash,
                 FinchAPI::HRIS::Individual::BatchError::OrHash
               ),
             code: Integer,

data/rbi/finch_api/models/hris/register_company_benefit_response.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module HRIS
+      class RegisterCompanyBenefitResponse < FinchAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              FinchAPI::HRIS::RegisterCompanyBenefitResponse,
+              FinchAPI::Internal::AnyHash
+            )
+          end
+
+        # The id of the benefit.
+        sig { returns(String) }
+        attr_accessor :benefit_id
+
+        sig { returns(String) }
+        attr_accessor :job_id
+
+        sig do
+          params(benefit_id: String, job_id: String).returns(T.attached_class)
+        end
+        def self.new(
+          # The id of the benefit.
+          benefit_id:,
+          job_id:
+        )
+        end
+
+        sig { override.returns({ benefit_id: String, job_id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/finch_api/models/introspection.rbi

@@ -578,11 +578,16 @@ module FinchAPI
         sig { returns(T.nilable(String)) }
         attr_accessor :source_id
 
+        # The status of the entity connection
+        sig { returns(FinchAPI::Introspection::Entity::Status::TaggedSymbol) }
+        attr_accessor :status
+
         sig do
           params(
             id: String,
             name: T.nilable(String),
-            source_id: T.nilable(String)
+            source_id: T.nilable(String),
+            status: FinchAPI::Introspection::Entity::Status::OrSymbol
           ).returns(T.attached_class)
         end
         def self.new(
@@ -591,7 +596,9 @@ module FinchAPI
           # The name of the entity (payroll provider company name)
           name:,
           # The source ID of the entity
-          source_id:
+          source_id:,
+          # The status of the entity connection
+          status:
         )
         end
 
@@ -600,12 +607,68 @@ module FinchAPI
             {
               id: String,
               name: T.nilable(String),
-              source_id: T.nilable(String)
+              source_id: T.nilable(String),
+              status: FinchAPI::Introspection::Entity::Status::TaggedSymbol
             }
           )
         end
         def to_hash
         end
+
+        # The status of the entity connection
+        module Status
+          extend FinchAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, FinchAPI::Introspection::Entity::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              FinchAPI::Introspection::Entity::Status::TaggedSymbol
+            )
+          PROCESSING =
+            T.let(
+              :processing,
+              FinchAPI::Introspection::Entity::Status::TaggedSymbol
+            )
+          CONNECTED =
+            T.let(
+              :connected,
+              FinchAPI::Introspection::Entity::Status::TaggedSymbol
+            )
+          ERROR_NO_ACCOUNT_SETUP =
+            T.let(
+              :error_no_account_setup,
+              FinchAPI::Introspection::Entity::Status::TaggedSymbol
+            )
+          ERROR_PERMISSIONS =
+            T.let(
+              :error_permissions,
+              FinchAPI::Introspection::Entity::Status::TaggedSymbol
+            )
+          REAUTH =
+            T.let(
+              :reauth,
+              FinchAPI::Introspection::Entity::Status::TaggedSymbol
+            )
+          DISCONNECTED =
+            T.let(
+              :disconnected,
+              FinchAPI::Introspection::Entity::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[FinchAPI::Introspection::Entity::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/finch_api/models/job_completion_event.rbi

@@ -120,6 +120,21 @@ module FinchAPI
             :"job.data_sync_all.completed",
             FinchAPI::JobCompletionEvent::EventType::TaggedSymbol
           )
+        JOB_W4_FORM_EMPLOYEE_SYNC_COMPLETED =
+          T.let(
+            :"job.w4_form_employee_sync.completed",
+            FinchAPI::JobCompletionEvent::EventType::TaggedSymbol
+          )
+        JOB_INITIAL_DATA_SYNC_ORG_SUCCEEDED =
+          T.let(
+            :"job.initial_data_sync_org.succeeded",
+            FinchAPI::JobCompletionEvent::EventType::TaggedSymbol
+          )
+        JOB_INITIAL_DATA_SYNC_PAYROLL_SUCCEEDED =
+          T.let(
+            :"job.initial_data_sync_payroll.succeeded",
+            FinchAPI::JobCompletionEvent::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(