finch-api 0.1.0.pre.alpha.30 → 0.1.0.pre.alpha.32

data/rbi/finch_api/models/hris/document_response.rbi

@@ -10,11 +10,8 @@ module FinchAPI
           end
 
         # A stable Finch id for the document.
-        sig { returns(T.nilable(String)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
+        sig { returns(String) }
+        attr_accessor :id
 
         # The ID of the individual associated with the document. This will be null for
         # employer-level documents.
@@ -22,28 +19,16 @@ module FinchAPI
         attr_accessor :individual_id
 
         # The type of document.
-        sig do
-          returns(
-            T.nilable(FinchAPI::HRIS::DocumentResponse::Type::TaggedSymbol)
-          )
-        end
-        attr_reader :type
-
-        sig do
-          params(type: FinchAPI::HRIS::DocumentResponse::Type::OrSymbol).void
-        end
-        attr_writer :type
+        sig { returns(FinchAPI::HRIS::DocumentResponse::Type::TaggedSymbol) }
+        attr_accessor :type
 
         # A URL to access the document. Format:
         # `https://api.tryfinch.com/employer/documents/:document_id`.
-        sig { returns(T.nilable(String)) }
-        attr_reader :url
-
-        sig { params(url: String).void }
-        attr_writer :url
+        sig { returns(String) }
+        attr_accessor :url
 
         # The year the document applies to, if available.
-        sig { returns(T.nilable(Float)) }
+        sig { returns(Float) }
         attr_accessor :year
 
         sig do
@@ -52,22 +37,22 @@ module FinchAPI
             individual_id: T.nilable(String),
             type: FinchAPI::HRIS::DocumentResponse::Type::OrSymbol,
             url: String,
-            year: T.nilable(Float)
+            year: Float
           ).returns(T.attached_class)
         end
         def self.new(
           # A stable Finch id for the document.
-          id: nil,
+          id:,
           # The ID of the individual associated with the document. This will be null for
           # employer-level documents.
-          individual_id: nil,
+          individual_id:,
           # The type of document.
-          type: nil,
+          type:,
           # A URL to access the document. Format:
           # `https://api.tryfinch.com/employer/documents/:document_id`.
-          url: nil,
+          url:,
           # The year the document applies to, if available.
-          year: nil
+          year:
         )
         end
 
@@ -78,7 +63,7 @@ module FinchAPI
               individual_id: T.nilable(String),
               type: FinchAPI::HRIS::DocumentResponse::Type::TaggedSymbol,
               url: String,
-              year: T.nilable(Float)
+              year: Float
             }
           )
         end

data/rbi/finch_api/models/hris/document_retreive_params.rbi

@@ -15,15 +15,34 @@ module FinchAPI
             )
           end
 
+        # 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(request_options: FinchAPI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            entity_ids: T::Array[String],
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          request_options: {}
+        )
         end
 
-        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
+        sig do
+          override.returns(
+            {
+              entity_ids: T::Array[String],
+              request_options: FinchAPI::RequestOptions
+            }
+          )
+        end
         def to_hash
         end
       end

data/rbi/finch_api/models/hris/employment_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::EmploymentRetrieveManyParams::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
@@ -44,6 +54,7 @@ module FinchAPI
             {
               requests:
                 T::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request],
+              entity_ids: T::Array[String],
               request_options: FinchAPI::RequestOptions
             }
           )

data/rbi/finch_api/models/hris/individual_retrieve_many_params.rbi

@@ -15,6 +15,13 @@ module FinchAPI
             )
           end
 
+        # 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
           returns(
             T.nilable(FinchAPI::HRIS::IndividualRetrieveManyParams::Options)
@@ -53,6 +60,7 @@ module FinchAPI
 
         sig do
           params(
+            entity_ids: T::Array[String],
             options:
               T.nilable(
                 FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash
@@ -64,12 +72,19 @@ module FinchAPI
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(options: nil, requests: nil, request_options: {})
+        def self.new(
+          # The entity IDs to specify which entities' data to access.
+          entity_ids: nil,
+          options: nil,
+          requests: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
             {
+              entity_ids: T::Array[String],
               options:
                 T.nilable(
                   FinchAPI::HRIS::IndividualRetrieveManyParams::Options

data/rbi/finch_api/models/hris/pay_statement.rbi

@@ -22,11 +22,7 @@ module FinchAPI
         # The array of deductions objects associated with this pay statement.
         sig do
           returns(
-            T.nilable(
-              T::Array[
-                T.nilable(FinchAPI::HRIS::PayStatement::EmployeeDeduction)
-              ]
-            )
+            T.nilable(T::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction])
           )
         end
         attr_accessor :employee_deductions
@@ -34,9 +30,7 @@ module FinchAPI
         sig do
           returns(
             T.nilable(
-              T::Array[
-                T.nilable(FinchAPI::HRIS::PayStatement::EmployerContribution)
-              ]
+              T::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]
             )
           )
         end
@@ -67,11 +61,7 @@ module FinchAPI
         attr_accessor :payment_method
 
         # The array of taxes objects associated with this pay statement.
-        sig do
-          returns(
-            T.nilable(T::Array[T.nilable(FinchAPI::HRIS::PayStatement::Tax)])
-          )
-        end
+        sig { returns(T.nilable(T::Array[FinchAPI::HRIS::PayStatement::Tax])) }
         attr_accessor :taxes
 
         # The number of hours worked for this pay period
@@ -95,17 +85,13 @@ module FinchAPI
             employee_deductions:
               T.nilable(
                 T::Array[
-                  T.nilable(
-                    FinchAPI::HRIS::PayStatement::EmployeeDeduction::OrHash
-                  )
+                  FinchAPI::HRIS::PayStatement::EmployeeDeduction::OrHash
                 ]
               ),
             employer_contributions:
               T.nilable(
                 T::Array[
-                  T.nilable(
-                    FinchAPI::HRIS::PayStatement::EmployerContribution::OrHash
-                  )
+                  FinchAPI::HRIS::PayStatement::EmployerContribution::OrHash
                 ]
               ),
             gross_pay: T.nilable(FinchAPI::Money::OrHash),
@@ -114,9 +100,7 @@ module FinchAPI
             payment_method:
               T.nilable(FinchAPI::HRIS::PayStatement::PaymentMethod::OrSymbol),
             taxes:
-              T.nilable(
-                T::Array[T.nilable(FinchAPI::HRIS::PayStatement::Tax::OrHash)]
-              ),
+              T.nilable(T::Array[FinchAPI::HRIS::PayStatement::Tax::OrHash]),
             total_hours: T.nilable(Float),
             type: T.nilable(FinchAPI::HRIS::PayStatement::Type::OrSymbol)
           ).returns(T.attached_class)
@@ -151,17 +135,11 @@ module FinchAPI
                 ),
               employee_deductions:
                 T.nilable(
-                  T::Array[
-                    T.nilable(FinchAPI::HRIS::PayStatement::EmployeeDeduction)
-                  ]
+                  T::Array[FinchAPI::HRIS::PayStatement::EmployeeDeduction]
                 ),
               employer_contributions:
                 T.nilable(
-                  T::Array[
-                    T.nilable(
-                      FinchAPI::HRIS::PayStatement::EmployerContribution
-                    )
-                  ]
+                  T::Array[FinchAPI::HRIS::PayStatement::EmployerContribution]
                 ),
               gross_pay: T.nilable(FinchAPI::Money),
               individual_id: String,
@@ -170,10 +148,7 @@ module FinchAPI
                 T.nilable(
                   FinchAPI::HRIS::PayStatement::PaymentMethod::TaggedSymbol
                 ),
-              taxes:
-                T.nilable(
-                  T::Array[T.nilable(FinchAPI::HRIS::PayStatement::Tax)]
-                ),
+              taxes: T.nilable(T::Array[FinchAPI::HRIS::PayStatement::Tax]),
               total_hours: T.nilable(Float),
               type: T.nilable(FinchAPI::HRIS::PayStatement::Type::TaggedSymbol)
             }

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