finch-api 0.1.0.pre.alpha.47 → 0.1.0.pre.alpha.49

data/lib/finch_api/resources/payroll/pay_groups.rb

@@ -4,13 +4,16 @@ module FinchAPI
   module Resources
     class Payroll
       class PayGroups
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Payroll::PayGroupRetrieveParams} for more details.
+        #
         # Read information from a single pay group
         #
         # @overload retrieve(pay_group_id, entity_ids: nil, request_options: {})
         #
         # @param pay_group_id [String]
         #
-        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -30,11 +33,14 @@ module FinchAPI
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Payroll::PayGroupListParams} for more details.
+        #
         # Read company pay groups and frequencies
         #
         # @overload list(entity_ids: nil, individual_id: nil, pay_frequencies: nil, request_options: {})
         #
-        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        # @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         # @param individual_id [String]
         #

data/lib/finch_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  VERSION = "0.1.0.pre.alpha.47"
+  VERSION = "0.1.0.pre.alpha.49"
 end

data/rbi/finch_api/models/base_webhook_event.rbi

@@ -14,8 +14,7 @@ module FinchAPI
       sig { returns(String) }
       attr_accessor :account_id
 
-      # [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
-      # `connection_id` instead to identify the connection associated with this event.
+      # Unique Finch ID of the company for which data has been updated.
       sig { returns(String) }
       attr_accessor :company_id
 
@@ -46,8 +45,7 @@ module FinchAPI
         # connection. Use `connection_id` instead to identify the connection associated
         # with this event.
         account_id:,
-        # [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
-        # `connection_id` instead to identify the connection associated with this event.
+        # Unique Finch ID of the company for which data has been updated.
         company_id:,
         # Unique Finch ID of the connection associated with the webhook event.
         connection_id: nil,

data/rbi/finch_api/models/create_access_token_response.rbi

@@ -60,8 +60,7 @@ module FinchAPI
       sig { params(account_id: String).void }
       attr_writer :account_id
 
-      # [DEPRECATED] Use `connection_id` to identify the connection instead of this
-      # company ID
+      # The Finch UUID of the company associated with the `access_token`.
       sig { returns(T.nilable(String)) }
       attr_reader :company_id
 
@@ -119,8 +118,7 @@ module FinchAPI
         # [DEPRECATED] Use `connection_id` to identify the connection instead of this
         # account ID
         account_id: nil,
-        # [DEPRECATED] Use `connection_id` to identify the connection instead of this
-        # company ID
+        # The Finch UUID of the company associated with the `access_token`.
         company_id: nil,
         # The ID of your customer you provided to Finch when a connect session was created
         # for this connection

data/rbi/finch_api/models/hris/benefit_create_params.rbi

@@ -15,7 +15,8 @@ module FinchAPI
             )
           end
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -71,7 +72,8 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           # The company match for this benefit.
           company_contribution: nil,

data/rbi/finch_api/models/hris/benefit_list_params.rbi

@@ -15,7 +15,8 @@ module FinchAPI
             )
           end
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -29,7 +30,8 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/benefit_list_supported_benefits_params.rbi

@@ -15,7 +15,8 @@ module FinchAPI
             )
           end
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -29,7 +30,8 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/benefit_register_params.rbi

@@ -15,7 +15,8 @@ module FinchAPI
             )
           end
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -46,7 +47,8 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           description: nil,
           # The frequency of the benefit deduction/contribution.

data/rbi/finch_api/models/hris/benefit_retrieve_params.rbi

@@ -18,7 +18,8 @@ module FinchAPI
         sig { returns(String) }
         attr_accessor :benefit_id
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -34,7 +35,8 @@ module FinchAPI
         end
         def self.new(
           benefit_id:,
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/benefit_update_params.rbi

@@ -18,7 +18,8 @@ module FinchAPI
         sig { returns(String) }
         attr_accessor :benefit_id
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -42,7 +43,8 @@ module FinchAPI
         end
         def self.new(
           benefit_id:,
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           # Updated name or description.
           description: nil,

data/rbi/finch_api/models/hris/benefits/individual_enroll_many_params.rbi

@@ -19,7 +19,8 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :benefit_id
 
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -61,7 +62,8 @@ module FinchAPI
           end
           def self.new(
             benefit_id:,
-            # The entity IDs to specify which entities' data to access.
+            # The entity IDs to specify which entities' data to access. Provide exactly one
+            # entity ID per request; a maximum of one is accepted.
             entity_ids: nil,
             # Array of the individual_id to enroll and a configuration object.
             individuals: nil,

data/rbi/finch_api/models/hris/benefits/individual_enrolled_ids_params.rbi

@@ -19,7 +19,8 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :benefit_id
 
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -35,7 +36,8 @@ module FinchAPI
           end
           def self.new(
             benefit_id:,
-            # The entity IDs to specify which entities' data to access.
+            # The entity IDs to specify which entities' data to access. Provide exactly one
+            # entity ID per request; a maximum of one is accepted.
             entity_ids: nil,
             request_options: {}
           )

data/rbi/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rbi

@@ -19,7 +19,8 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :benefit_id
 
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -44,7 +45,8 @@ module FinchAPI
           end
           def self.new(
             benefit_id:,
-            # The entity IDs to specify which entities' data to access.
+            # The entity IDs to specify which entities' data to access. Provide exactly one
+            # entity ID per request; a maximum of one is accepted.
             entity_ids: nil,
             # comma-delimited list of stable Finch uuids for each individual. If empty,
             # defaults to all individuals

data/rbi/finch_api/models/hris/benefits/individual_unenroll_many_params.rbi

@@ -19,7 +19,8 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :benefit_id
 
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -43,7 +44,8 @@ module FinchAPI
           end
           def self.new(
             benefit_id:,
-            # The entity IDs to specify which entities' data to access.
+            # The entity IDs to specify which entities' data to access. Provide exactly one
+            # entity ID per request; a maximum of one is accepted.
             entity_ids: nil,
             # Array of individual_ids to unenroll.
             individual_ids: nil,

data/rbi/finch_api/models/hris/company_retrieve_params.rbi

@@ -15,7 +15,8 @@ module FinchAPI
             )
           end
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -29,7 +30,8 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/directory_list_individuals_params.rbi

@@ -15,14 +15,15 @@ module FinchAPI
             )
           end
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
         sig { params(entity_ids: T::Array[String]).void }
         attr_writer :entity_ids
 
-        # Number of employees to return (defaults to all)
+        # Number of employees to return (defaults to 100, maximum 10000)
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
 
@@ -45,9 +46,10 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
-          # Number of employees to return (defaults to all)
+          # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,
           # Index to start from (defaults to 0)
           offset: nil,

data/rbi/finch_api/models/hris/directory_list_params.rbi

@@ -15,14 +15,15 @@ module FinchAPI
             )
           end
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
         sig { params(entity_ids: T::Array[String]).void }
         attr_writer :entity_ids
 
-        # Number of employees to return (defaults to all)
+        # Number of employees to return (defaults to 100, maximum 10000)
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
 
@@ -45,9 +46,10 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
-          # Number of employees to return (defaults to all)
+          # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,
           # Index to start from (defaults to 0)
           offset: nil,

data/rbi/finch_api/models/hris/document_list_params.rbi

@@ -15,7 +15,8 @@ module FinchAPI
             )
           end
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -73,7 +74,8 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           # Comma-delimited list of stable Finch uuids for each individual. If empty,
           # defaults to all individuals

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

@@ -18,7 +18,8 @@ module FinchAPI
         sig { returns(String) }
         attr_accessor :document_id
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -34,7 +35,8 @@ module FinchAPI
         end
         def self.new(
           document_id:,
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/hris/employment_retrieve_many_params.rbi

@@ -15,7 +15,7 @@ module FinchAPI
             )
           end
 
-        # The array of batch requests.
+        # The array of batch requests. Maximum 10000 items per request.
         sig do
           returns(
             T::Array[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request]
@@ -23,7 +23,8 @@ module FinchAPI
         end
         attr_accessor :requests
 
-        # The entity IDs to specify which entities' data to access.
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -41,9 +42,10 @@ module FinchAPI
           ).returns(T.attached_class)
         end
         def self.new(
-          # The array of batch requests.
+          # The array of batch requests. Maximum 10000 items per request.
           requests:,
-          # The entity IDs to specify which entities' data to access.
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           request_options: {}
         )
@@ -71,17 +73,13 @@ module FinchAPI
               )
             end
 
-          # A stable Finch `id` (UUID v4) for an individual in the company. There is no
-          # limit to the number of `individual_id` to send per request. It is preferantial
-          # to send all ids in a single request for Finch to optimize provider rate-limits.
+          # A stable Finch `id` (UUID v4) for an individual in the company.
           sig { returns(String) }
           attr_accessor :individual_id
 
           sig { params(individual_id: String).returns(T.attached_class) }
           def self.new(
-            # A stable Finch `id` (UUID v4) for an individual in the company. There is no
-            # limit to the number of `individual_id` to send per request. It is preferantial
-            # to send all ids in a single request for Finch to optimize provider rate-limits.
+            # A stable Finch `id` (UUID v4) for an individual in the company.
             individual_id:
           )
           end

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

@@ -15,7 +15,16 @@ module FinchAPI
             )
           end
 
-        # The entity IDs to specify which entities' data to access.
+        # The array of batch requests. Maximum 10000 items per request.
+        sig do
+          returns(
+            T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
+          )
+        end
+        attr_accessor :requests
+
+        # The entity IDs to specify which entities' data to access. Provide exactly one
+        # entity ID per request; a maximum of one is accepted.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -39,44 +48,27 @@ module FinchAPI
         end
         attr_writer :options
 
-        sig do
-          returns(
-            T.nilable(
-              T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request]
-            )
-          )
-        end
-        attr_reader :requests
-
         sig do
           params(
             requests:
               T::Array[
                 FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
-              ]
-          ).void
-        end
-        attr_writer :requests
-
-        sig do
-          params(
+              ],
             entity_ids: T::Array[String],
             options:
               T.nilable(
                 FinchAPI::HRIS::IndividualRetrieveManyParams::Options::OrHash
               ),
-            requests:
-              T::Array[
-                FinchAPI::HRIS::IndividualRetrieveManyParams::Request::OrHash
-              ],
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
-          # The entity IDs to specify which entities' data to access.
+          # The array of batch requests. Maximum 10000 items per request.
+          requests:,
+          # The entity IDs to specify which entities' data to access. Provide exactly one
+          # entity ID per request; a maximum of one is accepted.
           entity_ids: nil,
           options: nil,
-          requests: nil,
           request_options: {}
         )
         end
@@ -84,13 +76,13 @@ module FinchAPI
         sig do
           override.returns(
             {
+              requests:
+                T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
               entity_ids: T::Array[String],
               options:
                 T.nilable(
                   FinchAPI::HRIS::IndividualRetrieveManyParams::Options
                 ),
-              requests:
-                T::Array[FinchAPI::HRIS::IndividualRetrieveManyParams::Request],
               request_options: FinchAPI::RequestOptions
             }
           )
@@ -98,50 +90,47 @@ module FinchAPI
         def to_hash
         end
 
-        class Options < FinchAPI::Internal::Type::BaseModel
+        class Request < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                FinchAPI::HRIS::IndividualRetrieveManyParams::Options,
+                FinchAPI::HRIS::IndividualRetrieveManyParams::Request,
                 FinchAPI::Internal::AnyHash
               )
             end
 
-          sig { returns(T.nilable(T::Array[String])) }
-          attr_reader :include
+          sig { returns(String) }
+          attr_accessor :individual_id
 
-          sig { params(include: T::Array[String]).void }
-          attr_writer :include
-
-          sig { params(include: T::Array[String]).returns(T.attached_class) }
-          def self.new(include: nil)
+          sig { params(individual_id: String).returns(T.attached_class) }
+          def self.new(individual_id:)
           end
 
-          sig { override.returns({ include: T::Array[String] }) }
+          sig { override.returns({ individual_id: String }) }
           def to_hash
           end
         end
 
-        class Request < FinchAPI::Internal::Type::BaseModel
+        class Options < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                FinchAPI::HRIS::IndividualRetrieveManyParams::Request,
+                FinchAPI::HRIS::IndividualRetrieveManyParams::Options,
                 FinchAPI::Internal::AnyHash
               )
             end
 
-          sig { returns(T.nilable(String)) }
-          attr_reader :individual_id
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :include
 
-          sig { params(individual_id: String).void }
-          attr_writer :individual_id
+          sig { params(include: T::Array[String]).void }
+          attr_writer :include
 
-          sig { params(individual_id: String).returns(T.attached_class) }
-          def self.new(individual_id: nil)
+          sig { params(include: T::Array[String]).returns(T.attached_class) }
+          def self.new(include: nil)
           end
 
-          sig { override.returns({ individual_id: String }) }
+          sig { override.returns({ include: T::Array[String] }) }
           def to_hash
           end
         end

data/rbi/finch_api/models/hris/pay_statement_item/rule_create_params.rbi

@@ -16,7 +16,8 @@ module FinchAPI
               )
             end
 
-          # The entity IDs to create the rule for.
+          # The entity IDs to create the rule for. Provide exactly one entity ID per
+          # request; a maximum of one is accepted.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -105,7 +106,8 @@ module FinchAPI
             ).returns(T.attached_class)
           end
           def self.new(
-            # The entity IDs to create the rule for.
+            # The entity IDs to create the rule for. Provide exactly one entity ID per
+            # request; a maximum of one is accepted.
             entity_ids: nil,
             # Specifies the fields to be applied when the condition is met.
             attributes: nil,

data/rbi/finch_api/models/hris/pay_statement_item/rule_delete_params.rbi

@@ -19,7 +19,8 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :rule_id
 
-          # The entity IDs to delete the rule for.
+          # The entity IDs to delete the rule for. Provide exactly one entity ID per
+          # request; a maximum of one is accepted.
           sig { returns(T.nilable(T::Array[String])) }
           attr_reader :entity_ids
 
@@ -35,7 +36,8 @@ module FinchAPI
           end
           def self.new(
             rule_id:,
-            # The entity IDs to delete the rule for.
+            # The entity IDs to delete the rule for. Provide exactly one entity ID per
+            # request; a maximum of one is accepted.
             entity_ids: nil,
             request_options: {}
           )