finch-api 0.1.0.pre.alpha.60 → 0.1.0.pre.alpha.61

data/rbi/finch_api/resources/hris/benefits.rbi

@@ -24,7 +24,9 @@ module FinchAPI
         end
         def create(
           # Query param: The entity IDs to specify which entities' data to access. Provide
-          # exactly one entity ID per request; a maximum of one is accepted.
+          # exactly one entity ID per request; a maximum of one is accepted. Required when
+          # the connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Body param: The company match for this benefit.
           company_contribution: nil,
@@ -51,7 +53,9 @@ module FinchAPI
         def retrieve(
           benefit_id,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )
@@ -70,7 +74,9 @@ module FinchAPI
           # Path param
           benefit_id,
           # Query param: The entity IDs to specify which entities' data to access. Provide
-          # exactly one entity ID per request; a maximum of one is accepted.
+          # exactly one entity ID per request; a maximum of one is accepted. Required when
+          # the connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Body param: Updated name or description.
           description: nil,
@@ -89,7 +95,9 @@ module FinchAPI
         end
         def list(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )
@@ -106,7 +114,9 @@ module FinchAPI
         end
         def list_supported_benefits(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )
@@ -125,7 +135,9 @@ module FinchAPI
         end
         def register(
           # Query param: The entity IDs to specify which entities' data to access. Provide
-          # exactly one entity ID per request; a maximum of one is accepted.
+          # exactly one entity ID per request; a maximum of one is accepted. Required when
+          # the connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Body param
           description: nil,

data/rbi/finch_api/resources/hris/company.rbi

@@ -13,7 +13,9 @@ module FinchAPI
         end
         def retrieve(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/hris/directory.rbi

@@ -19,7 +19,9 @@ module FinchAPI
         end
         def list(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,

data/rbi/finch_api/resources/hris/documents.rbi

@@ -18,7 +18,9 @@ module FinchAPI
         end
         def list(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Comma-delimited list of stable Finch uuids for each individual. If empty,
           # defaults to all individuals
@@ -47,7 +49,9 @@ module FinchAPI
           # The unique identifier of the document.
           document_id,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/hris/employments.rbi

@@ -23,7 +23,9 @@ module FinchAPI
           # Body param: The array of batch requests. Maximum 10000 items per request.
           requests:,
           # Query param: The entity IDs to specify which entities' data to access. Provide
-          # exactly one entity ID per request; a maximum of one is accepted.
+          # exactly one entity ID per request; a maximum of one is accepted. Required when
+          # the connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/hris/individuals.rbi

@@ -27,7 +27,9 @@ module FinchAPI
           # Body param: The array of batch requests. Maximum 10000 items per request.
           requests:,
           # Query param: The entity IDs to specify which entities' data to access. Provide
-          # exactly one entity ID per request; a maximum of one is accepted.
+          # exactly one entity ID per request; a maximum of one is accepted. Required when
+          # the connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Body param
           options: nil,

data/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi

@@ -29,7 +29,9 @@ module FinchAPI
           end
           def create(
             # Query param: The entity IDs to create the rule for. Provide exactly one entity
-            # ID per request; a maximum of one is accepted.
+            # ID per request; a maximum of one is accepted. Required when the connection has
+            # more than one entity — omitting it returns a `400` `invalid_request_error`.
+            # Optional for single-entity connections.
             entity_ids: nil,
             # Body param: Specifies the fields to be applied when the condition is met.
             attributes: nil,
@@ -61,7 +63,9 @@ module FinchAPI
             # Path param
             rule_id,
             # Query param: The entity IDs to update the rule for. Provide exactly one entity
-            # ID per request; a maximum of one is accepted.
+            # ID per request; a maximum of one is accepted. Required when the connection has
+            # more than one entity — omitting it returns a `400` `invalid_request_error`.
+            # Optional for single-entity connections.
             entity_ids: nil,
             # Body param
             optional_property: nil,
@@ -82,7 +86,9 @@ module FinchAPI
           end
           def list(
             # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
-            # a maximum of one is accepted.
+            # a maximum of one is accepted. Required when the connection has more than one
+            # entity — omitting it returns a `400` `invalid_request_error`. Optional for
+            # single-entity connections.
             entity_ids: nil,
             request_options: {}
           )
@@ -101,7 +107,9 @@ module FinchAPI
           def delete(
             rule_id,
             # The entity IDs to delete the rule for. Provide exactly one entity ID per
-            # request; a maximum of one is accepted.
+            # request; a maximum of one is accepted. Required when the connection has more
+            # than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+            # for single-entity connections.
             entity_ids: nil,
             request_options: {}
           )

data/rbi/finch_api/resources/hris/pay_statement_item.rbi

@@ -35,7 +35,9 @@ module FinchAPI
           # `YYYY-MM-DD` format.
           end_date: nil,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           # Case-insensitive partial match search by pay statement item name.
           name: nil,

data/rbi/finch_api/resources/hris/pay_statements.rbi

@@ -26,7 +26,9 @@ module FinchAPI
           # Body param: The array of batch requests. Maximum 10 payment_ids per request.
           requests:,
           # Query param: The entity IDs to specify which entities' data to access. Provide
-          # exactly one entity ID per request; a maximum of one is accepted.
+          # exactly one entity ID per request; a maximum of one is accepted. Required when
+          # the connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/hris/payments.rbi

@@ -21,7 +21,9 @@ module FinchAPI
           # format. Filters payments by their **pay_date** field.
           start_date:,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/payroll/pay_groups.rbi

@@ -15,7 +15,9 @@ module FinchAPI
         def retrieve(
           pay_group_id,
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           request_options: {}
         )
@@ -36,7 +38,9 @@ module FinchAPI
         end
         def list(
           # The entity IDs to specify which entities' data to access. Provide exactly one
-          # entity ID per request; a maximum of one is accepted.
+          # entity ID per request; a maximum of one is accepted. Required when the
+          # connection has more than one entity — omitting it returns a `400`
+          # `invalid_request_error`. Optional for single-entity connections.
           entity_ids: nil,
           individual_id: nil,
           pay_frequencies: nil,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.60
+  version: 0.1.0.pre.alpha.61
 platform: ruby
 authors:
 - Finch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-16 00:00:00.000000000 Z
+date: 2026-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi