finch-api 0.1.0.pre.alpha.29 → 0.1.0.pre.alpha.31

data/rbi/finch_api/models/hris/pay_statement_retrieve_many_params.rbi

@@ -23,18 +23,28 @@ module FinchAPI
         end
         attr_accessor :requests
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         sig do
           params(
             requests:
               T::Array[
                 FinchAPI::HRIS::PayStatementRetrieveManyParams::Request::OrHash
               ],
+            entity_ids: T::Array[String],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           # The array of batch requests.
           requests:,
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           request_options: {}
         )
         end
@@ -46,6 +56,7 @@ module FinchAPI
                 T::Array[
                   FinchAPI::HRIS::PayStatementRetrieveManyParams::Request
                 ],
+              entity_ids: T::Array[String],
               request_options: FinchAPI::RequestOptions
             }
           )

data/rbi/finch_api/models/hris/payment_list_params.rbi

@@ -25,10 +25,18 @@ module FinchAPI
         sig { returns(Date) }
         attr_accessor :start_date
 
+        # The entity IDs to specify which entities' data to access.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :entity_ids
+
+        sig { params(entity_ids: T::Array[String]).void }
+        attr_writer :entity_ids
+
         sig do
           params(
             end_date: Date,
             start_date: Date,
+            entity_ids: T::Array[String],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -39,6 +47,8 @@ module FinchAPI
           # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
           # format.
           start_date:,
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
           request_options: {}
         )
         end
@@ -48,6 +58,7 @@ module FinchAPI
             {
               end_date: Date,
               start_date: Date,
+              entity_ids: T::Array[String],
               request_options: FinchAPI::RequestOptions
             }
           )

data/rbi/finch_api/models/hris/supported_benefit.rbi

@@ -190,6 +190,11 @@ module FinchAPI
               :percent,
               FinchAPI::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol
             )
+          TIERED =
+            T.let(
+              :tiered,
+              FinchAPI::HRIS::SupportedBenefit::CompanyContribution::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/finch_api/models/hris/w42005.rbi

@@ -10,21 +10,18 @@ module FinchAPI
           end
 
         # Detailed information specific to the 2005 W4 form.
-        sig { returns(T.nilable(FinchAPI::HRIS::W42005::Data)) }
+        sig { returns(FinchAPI::HRIS::W42005::Data) }
         attr_reader :data
 
         sig { params(data: FinchAPI::HRIS::W42005::Data::OrHash).void }
         attr_writer :data
 
         # Specifies the form type, indicating that this document is a 2005 W4 form.
-        sig { returns(T.nilable(FinchAPI::HRIS::W42005::Type::TaggedSymbol)) }
-        attr_reader :type
-
-        sig { params(type: FinchAPI::HRIS::W42005::Type::OrSymbol).void }
-        attr_writer :type
+        sig { returns(FinchAPI::HRIS::W42005::Type::TaggedSymbol) }
+        attr_accessor :type
 
         # The tax year this W4 document applies to.
-        sig { returns(T.nilable(Float)) }
+        sig { returns(Float) }
         attr_accessor :year
 
         # A 2005 version of the W-4 tax form containing information on an individual's
@@ -33,16 +30,16 @@ module FinchAPI
           params(
             data: FinchAPI::HRIS::W42005::Data::OrHash,
             type: FinchAPI::HRIS::W42005::Type::OrSymbol,
-            year: T.nilable(Float)
+            year: Float
           ).returns(T.attached_class)
         end
         def self.new(
           # Detailed information specific to the 2005 W4 form.
-          data: nil,
+          data:,
           # Specifies the form type, indicating that this document is a 2005 W4 form.
-          type: nil,
+          type:,
           # The tax year this W4 document applies to.
-          year: nil
+          year:
         )
         end
 
@@ -51,7 +48,7 @@ module FinchAPI
             {
               data: FinchAPI::HRIS::W42005::Data,
               type: FinchAPI::HRIS::W42005::Type::TaggedSymbol,
-              year: T.nilable(Float)
+              year: Float
             }
           )
         end
@@ -65,7 +62,7 @@ module FinchAPI
             end
 
           # Additional withholding amount (in cents).
-          sig { returns(T.nilable(Integer)) }
+          sig { returns(Integer) }
           attr_accessor :additional_withholding
 
           # Indicates exemption status from federal tax withholding.
@@ -74,14 +71,7 @@ module FinchAPI
               T.nilable(FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol)
             )
           end
-          attr_reader :exemption
-
-          sig do
-            params(
-              exemption: FinchAPI::HRIS::W42005::Data::Exemption::OrSymbol
-            ).void
-          end
-          attr_writer :exemption
+          attr_accessor :exemption
 
           # The individual's filing status for tax purposes.
           sig do
@@ -94,53 +84,53 @@ module FinchAPI
           attr_accessor :filing_status
 
           # The unique identifier for the individual associated with this 2005 W4 form.
-          sig { returns(T.nilable(String)) }
-          attr_reader :individual_id
-
-          sig { params(individual_id: String).void }
-          attr_writer :individual_id
+          sig { returns(String) }
+          attr_accessor :individual_id
 
           # Total number of allowances claimed (in cents).
-          sig { returns(T.nilable(Integer)) }
+          sig { returns(Integer) }
           attr_accessor :total_number_of_allowances
 
           # Detailed information specific to the 2005 W4 form.
           sig do
             params(
-              additional_withholding: T.nilable(Integer),
-              exemption: FinchAPI::HRIS::W42005::Data::Exemption::OrSymbol,
+              additional_withholding: Integer,
+              exemption:
+                T.nilable(FinchAPI::HRIS::W42005::Data::Exemption::OrSymbol),
               filing_status:
                 T.nilable(FinchAPI::HRIS::W42005::Data::FilingStatus::OrSymbol),
               individual_id: String,
-              total_number_of_allowances: T.nilable(Integer)
+              total_number_of_allowances: Integer
             ).returns(T.attached_class)
           end
           def self.new(
             # Additional withholding amount (in cents).
-            additional_withholding: nil,
+            additional_withholding:,
             # Indicates exemption status from federal tax withholding.
-            exemption: nil,
+            exemption:,
             # The individual's filing status for tax purposes.
-            filing_status: nil,
+            filing_status:,
             # The unique identifier for the individual associated with this 2005 W4 form.
-            individual_id: nil,
+            individual_id:,
             # Total number of allowances claimed (in cents).
-            total_number_of_allowances: nil
+            total_number_of_allowances:
           )
           end
 
           sig do
             override.returns(
               {
-                additional_withholding: T.nilable(Integer),
+                additional_withholding: Integer,
                 exemption:
-                  FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol,
+                  T.nilable(
+                    FinchAPI::HRIS::W42005::Data::Exemption::TaggedSymbol
+                  ),
                 filing_status:
                   T.nilable(
                     FinchAPI::HRIS::W42005::Data::FilingStatus::TaggedSymbol
                   ),
                 individual_id: String,
-                total_number_of_allowances: T.nilable(Integer)
+                total_number_of_allowances: Integer
               }
             )
           end

data/rbi/finch_api/models/hris/w42020.rbi

@@ -10,21 +10,18 @@ module FinchAPI
           end
 
         # Detailed information specific to the 2020 W4 form.
-        sig { returns(T.nilable(FinchAPI::HRIS::W42020::Data)) }
+        sig { returns(FinchAPI::HRIS::W42020::Data) }
         attr_reader :data
 
         sig { params(data: FinchAPI::HRIS::W42020::Data::OrHash).void }
         attr_writer :data
 
         # Specifies the form type, indicating that this document is a 2020 W4 form.
-        sig { returns(T.nilable(FinchAPI::HRIS::W42020::Type::TaggedSymbol)) }
-        attr_reader :type
-
-        sig { params(type: FinchAPI::HRIS::W42020::Type::OrSymbol).void }
-        attr_writer :type
+        sig { returns(FinchAPI::HRIS::W42020::Type::TaggedSymbol) }
+        attr_accessor :type
 
         # The tax year this W4 document applies to.
-        sig { returns(T.nilable(Float)) }
+        sig { returns(Float) }
         attr_accessor :year
 
         # A 2020 version of the W-4 tax form containing information on an individual's
@@ -33,16 +30,16 @@ module FinchAPI
           params(
             data: FinchAPI::HRIS::W42020::Data::OrHash,
             type: FinchAPI::HRIS::W42020::Type::OrSymbol,
-            year: T.nilable(Float)
+            year: Float
           ).returns(T.attached_class)
         end
         def self.new(
           # Detailed information specific to the 2020 W4 form.
-          data: nil,
+          data:,
           # Specifies the form type, indicating that this document is a 2020 W4 form.
-          type: nil,
+          type:,
           # The tax year this W4 document applies to.
-          year: nil
+          year:
         )
         end
 
@@ -51,7 +48,7 @@ module FinchAPI
             {
               data: FinchAPI::HRIS::W42020::Data,
               type: FinchAPI::HRIS::W42020::Type::TaggedSymbol,
-              year: T.nilable(Float)
+              year: Float
             }
           )
         end
@@ -66,19 +63,19 @@ module FinchAPI
 
           # Amount claimed for dependents other than qualifying children under 17 (in
           # cents).
-          sig { returns(T.nilable(Integer)) }
+          sig { returns(Integer) }
           attr_accessor :amount_for_other_dependents
 
           # Amount claimed for dependents under 17 years old (in cents).
-          sig { returns(T.nilable(Integer)) }
+          sig { returns(Integer) }
           attr_accessor :amount_for_qualifying_children_under_17
 
           # Deductible expenses (in cents).
-          sig { returns(T.nilable(Integer)) }
+          sig { returns(Integer) }
           attr_accessor :deductions
 
           # Additional withholding amount (in cents).
-          sig { returns(T.nilable(Integer)) }
+          sig { returns(Integer) }
           attr_accessor :extra_withholding
 
           # The individual's filing status for tax purposes.
@@ -92,69 +89,66 @@ module FinchAPI
           attr_accessor :filing_status
 
           # The unique identifier for the individual associated with this document.
-          sig { returns(T.nilable(String)) }
-          attr_reader :individual_id
-
-          sig { params(individual_id: String).void }
-          attr_writer :individual_id
+          sig { returns(String) }
+          attr_accessor :individual_id
 
           # Additional income from sources outside of primary employment (in cents).
-          sig { returns(T.nilable(Integer)) }
+          sig { returns(Integer) }
           attr_accessor :other_income
 
           # Total amount claimed for dependents and other credits (in cents).
-          sig { returns(T.nilable(Integer)) }
+          sig { returns(Integer) }
           attr_accessor :total_claim_dependent_and_other_credits
 
           # Detailed information specific to the 2020 W4 form.
           sig do
             params(
-              amount_for_other_dependents: T.nilable(Integer),
-              amount_for_qualifying_children_under_17: T.nilable(Integer),
-              deductions: T.nilable(Integer),
-              extra_withholding: T.nilable(Integer),
+              amount_for_other_dependents: Integer,
+              amount_for_qualifying_children_under_17: Integer,
+              deductions: Integer,
+              extra_withholding: Integer,
               filing_status:
                 T.nilable(FinchAPI::HRIS::W42020::Data::FilingStatus::OrSymbol),
               individual_id: String,
-              other_income: T.nilable(Integer),
-              total_claim_dependent_and_other_credits: T.nilable(Integer)
+              other_income: Integer,
+              total_claim_dependent_and_other_credits: Integer
             ).returns(T.attached_class)
           end
           def self.new(
             # Amount claimed for dependents other than qualifying children under 17 (in
             # cents).
-            amount_for_other_dependents: nil,
+            amount_for_other_dependents:,
             # Amount claimed for dependents under 17 years old (in cents).
-            amount_for_qualifying_children_under_17: nil,
+            amount_for_qualifying_children_under_17:,
             # Deductible expenses (in cents).
-            deductions: nil,
+            deductions:,
             # Additional withholding amount (in cents).
-            extra_withholding: nil,
+            extra_withholding:,
             # The individual's filing status for tax purposes.
-            filing_status: nil,
+            filing_status:,
             # The unique identifier for the individual associated with this document.
-            individual_id: nil,
+            individual_id:,
             # Additional income from sources outside of primary employment (in cents).
-            other_income: nil,
+            other_income:,
             # Total amount claimed for dependents and other credits (in cents).
-            total_claim_dependent_and_other_credits: nil
+            total_claim_dependent_and_other_credits:
           )
           end
 
           sig do
             override.returns(
               {
-                amount_for_other_dependents: T.nilable(Integer),
-                amount_for_qualifying_children_under_17: T.nilable(Integer),
-                deductions: T.nilable(Integer),
-                extra_withholding: T.nilable(Integer),
+                amount_for_other_dependents: Integer,
+                amount_for_qualifying_children_under_17: Integer,
+                deductions: Integer,
+                extra_withholding: Integer,
                 filing_status:
                   T.nilable(
                     FinchAPI::HRIS::W42020::Data::FilingStatus::TaggedSymbol
                   ),
                 individual_id: String,
-                other_income: T.nilable(Integer),
-                total_claim_dependent_and_other_credits: T.nilable(Integer)
+                other_income: Integer,
+                total_claim_dependent_and_other_credits: Integer
               }
             )
           end

data/rbi/finch_api/models/introspection.rbi

@@ -95,23 +95,15 @@ module FinchAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :customer_name
 
-      # Array of entity IDs associated with this connection.
-      sig { returns(T.nilable(T::Array[String])) }
-      attr_reader :entity_ids
-
-      sig { params(entity_ids: T::Array[String]).void }
-      attr_writer :entity_ids
-
-      # Indicates whether this connection manages a single entity or multiple entities.
-      sig do
-        returns(T.nilable(FinchAPI::Introspection::EntityMode::TaggedSymbol))
-      end
-      attr_reader :entity_mode
+      # Array of detailed entity information for each connected account in multi-account
+      # mode
+      sig { returns(T.nilable(T::Array[FinchAPI::Introspection::Entity])) }
+      attr_reader :entities
 
       sig do
-        params(entity_mode: FinchAPI::Introspection::EntityMode::OrSymbol).void
+        params(entities: T::Array[FinchAPI::Introspection::Entity::OrHash]).void
       end
-      attr_writer :entity_mode
+      attr_writer :entities
 
       # Whether the connection associated with the `access_token` uses the Assisted
       # Connect Flow. (`true` if using Assisted Connect, `false` if connection is
@@ -151,8 +143,7 @@ module FinchAPI
           customer_email: T.nilable(String),
           customer_id: T.nilable(String),
           customer_name: T.nilable(String),
-          entity_ids: T::Array[String],
-          entity_mode: FinchAPI::Introspection::EntityMode::OrSymbol,
+          entities: T::Array[FinchAPI::Introspection::Entity::OrHash],
           manual: T::Boolean,
           payroll_provider_id: String,
           username: T.nilable(String)
@@ -193,10 +184,9 @@ module FinchAPI
         # The name of your customer you provided to Finch when a connect session was
         # created for this connection
         customer_name: nil,
-        # Array of entity IDs associated with this connection.
-        entity_ids: nil,
-        # Indicates whether this connection manages a single entity or multiple entities.
-        entity_mode: nil,
+        # Array of detailed entity information for each connected account in multi-account
+        # mode
+        entities: nil,
         # Whether the connection associated with the `access_token` uses the Assisted
         # Connect Flow. (`true` if using Assisted Connect, `false` if connection is
         # automated)
@@ -228,8 +218,7 @@ module FinchAPI
             customer_email: T.nilable(String),
             customer_id: T.nilable(String),
             customer_name: T.nilable(String),
-            entity_ids: T::Array[String],
-            entity_mode: FinchAPI::Introspection::EntityMode::TaggedSymbol,
+            entities: T::Array[FinchAPI::Introspection::Entity],
             manual: T::Boolean,
             payroll_provider_id: String,
             username: T.nilable(String)
@@ -571,24 +560,59 @@ module FinchAPI
         end
       end
 
-      # Indicates whether this connection manages a single entity or multiple entities.
-      module EntityMode
-        extend FinchAPI::Internal::Type::Enum
+      class Entity < FinchAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(FinchAPI::Introspection::Entity, FinchAPI::Internal::AnyHash)
+          end
 
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, FinchAPI::Introspection::EntityMode) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        # The connection account ID for this entity
+        sig { returns(String) }
+        attr_accessor :id
 
-        SINGLE =
-          T.let(:single, FinchAPI::Introspection::EntityMode::TaggedSymbol)
-        MULTI = T.let(:multi, FinchAPI::Introspection::EntityMode::TaggedSymbol)
+        # The name of the entity (payroll provider company name)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The source ID of the entity
+        sig { returns(T.nilable(String)) }
+        attr_accessor :source_id
+
+        # The type of entity
+        sig { returns(T.nilable(String)) }
+        attr_accessor :type
+
+        sig do
+          params(
+            id: String,
+            name: T.nilable(String),
+            source_id: T.nilable(String),
+            type: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The connection account ID for this entity
+          id:,
+          # The name of the entity (payroll provider company name)
+          name:,
+          # The source ID of the entity
+          source_id:,
+          # The type of entity
+          type:
+        )
+        end
 
         sig do
           override.returns(
-            T::Array[FinchAPI::Introspection::EntityMode::TaggedSymbol]
+            {
+              id: String,
+              name: T.nilable(String),
+              source_id: T.nilable(String),
+              type: T.nilable(String)
+            }
           )
         end
-        def self.values
+        def to_hash
         end
       end
     end

data/rbi/finch_api/models/jobs/automated_list_params.rbi

@@ -15,15 +15,6 @@ module FinchAPI
             )
           end
 
-        # The entity ID to use when authenticating with a multi-account token. Required
-        # when using a multi-account token to specify which entity's data to access.
-        # Example: `123e4567-e89b-12d3-a456-426614174000`
-        sig { returns(T.nilable(String)) }
-        attr_reader :entity_id
-
-        sig { params(entity_id: String).void }
-        attr_writer :entity_id
-
         # Number of items to return
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
@@ -40,17 +31,12 @@ module FinchAPI
 
         sig do
           params(
-            entity_id: String,
             limit: Integer,
             offset: Integer,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity ID to use when authenticating with a multi-account token. Required
-          # when using a multi-account token to specify which entity's data to access.
-          # Example: `123e4567-e89b-12d3-a456-426614174000`
-          entity_id: nil,
           # Number of items to return
           limit: nil,
           # Index to start from (defaults to 0)
@@ -62,7 +48,6 @@ module FinchAPI
         sig do
           override.returns(
             {
-              entity_id: String,
               limit: Integer,
               offset: Integer,
               request_options: FinchAPI::RequestOptions

data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi

@@ -15,35 +15,15 @@ module FinchAPI
             )
           end
 
-        # The entity ID to use when authenticating with a multi-account token. Required
-        # when using a multi-account token to specify which entity's data to access.
-        # Example: `123e4567-e89b-12d3-a456-426614174000`
-        sig { returns(T.nilable(String)) }
-        attr_reader :entity_id
-
-        sig { params(entity_id: String).void }
-        attr_writer :entity_id
-
         sig do
-          params(
-            entity_id: String,
-            request_options: FinchAPI::RequestOptions::OrHash
-          ).returns(T.attached_class)
+          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
         end
-        def self.new(
-          # The entity ID to use when authenticating with a multi-account token. Required
-          # when using a multi-account token to specify which entity's data to access.
-          # Example: `123e4567-e89b-12d3-a456-426614174000`
-          entity_id: nil,
-          request_options: {}
-        )
+        def self.new(request_options: {})
         end
 
-        sig do
-          override.returns(
-            { entity_id: String, request_options: FinchAPI::RequestOptions }
-          )
-        end
+        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
         def to_hash
         end
       end

data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi

@@ -15,35 +15,15 @@ module FinchAPI
             )
           end
 
-        # The entity ID to use when authenticating with a multi-account token. Required
-        # when using a multi-account token to specify which entity's data to access.
-        # Example: `123e4567-e89b-12d3-a456-426614174000`
-        sig { returns(T.nilable(String)) }
-        attr_reader :entity_id
-
-        sig { params(entity_id: String).void }
-        attr_writer :entity_id
-
         sig do
-          params(
-            entity_id: String,
-            request_options: FinchAPI::RequestOptions::OrHash
-          ).returns(T.attached_class)
+          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
         end
-        def self.new(
-          # The entity ID to use when authenticating with a multi-account token. Required
-          # when using a multi-account token to specify which entity's data to access.
-          # Example: `123e4567-e89b-12d3-a456-426614174000`
-          entity_id: nil,
-          request_options: {}
-        )
+        def self.new(request_options: {})
         end
 
-        sig do
-          override.returns(
-            { entity_id: String, request_options: FinchAPI::RequestOptions }
-          )
-        end
+        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
         def to_hash
         end
       end