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

data/rbi/finch_api/models/sandbox/directory_create_params.rbi

@@ -67,6 +67,12 @@ module FinchAPI
               )
             end
 
+          # The employer defined benefit eligibility class that groups an employee into a
+          # set of eligible benefit plans, as stored by the provider. Null when not
+          # configured.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :benefit_eligibility_class
+
           # Worker's compensation classification code for this employee
           sig { returns(T.nilable(String)) }
           attr_accessor :class_code
@@ -316,6 +322,7 @@ module FinchAPI
 
           sig do
             params(
+              benefit_eligibility_class: T.nilable(String),
               class_code: T.nilable(String),
               custom_fields:
                 T.nilable(
@@ -394,6 +401,10 @@ module FinchAPI
             ).returns(T.attached_class)
           end
           def self.new(
+            # The employer defined benefit eligibility class that groups an employee into a
+            # set of eligible benefit plans, as stored by the provider. Null when not
+            # configured.
+            benefit_eligibility_class: nil,
             # Worker's compensation classification code for this employee
             class_code: nil,
             # Custom fields for the individual. These are fields which are defined by the
@@ -472,6 +483,7 @@ module FinchAPI
           sig do
             override.returns(
               {
+                benefit_eligibility_class: T.nilable(String),
                 class_code: T.nilable(String),
                 custom_fields:
                   T.nilable(

data/rbi/finch_api/models/sandbox/employment_update_params.rbi

@@ -18,6 +18,12 @@ module FinchAPI
         sig { returns(String) }
         attr_accessor :individual_id
 
+        # The employer defined benefit eligibility class that groups an employee into a
+        # set of eligible benefit plans, as stored by the provider. Null when not
+        # configured.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :benefit_eligibility_class
+
         # Worker's compensation classification code for this employee
         sig { returns(T.nilable(String)) }
         attr_accessor :class_code
@@ -181,6 +187,7 @@ module FinchAPI
         sig do
           params(
             individual_id: String,
+            benefit_eligibility_class: T.nilable(String),
             class_code: T.nilable(String),
             custom_fields:
               T.nilable(
@@ -230,6 +237,10 @@ module FinchAPI
         end
         def self.new(
           individual_id:,
+          # The employer defined benefit eligibility class that groups an employee into a
+          # set of eligible benefit plans, as stored by the provider. Null when not
+          # configured.
+          benefit_eligibility_class: nil,
           # Worker's compensation classification code for this employee
           class_code: nil,
           # Custom fields for the individual. These are fields which are defined by the
@@ -288,6 +299,7 @@ module FinchAPI
           override.returns(
             {
               individual_id: String,
+              benefit_eligibility_class: T.nilable(String),
               class_code: T.nilable(String),
               custom_fields:
                 T.nilable(

data/rbi/finch_api/models/sandbox/employment_update_response.rbi

@@ -19,6 +19,12 @@ module FinchAPI
         sig { params(id: String).void }
         attr_writer :id
 
+        # The employer defined benefit eligibility class that groups an employee into a
+        # set of eligible benefit plans, as stored by the provider. Null when not
+        # configured.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :benefit_eligibility_class
+
         # Worker's compensation classification code for this employee
         sig { returns(T.nilable(String)) }
         attr_accessor :class_code
@@ -192,6 +198,7 @@ module FinchAPI
         sig do
           params(
             id: String,
+            benefit_eligibility_class: T.nilable(String),
             class_code: T.nilable(String),
             custom_fields:
               T.nilable(
@@ -241,6 +248,10 @@ module FinchAPI
         def self.new(
           # A stable Finch `id` (UUID v4) for an individual in the company.
           id: nil,
+          # The employer defined benefit eligibility class that groups an employee into a
+          # set of eligible benefit plans, as stored by the provider. Null when not
+          # configured.
+          benefit_eligibility_class: nil,
           # Worker's compensation classification code for this employee
           class_code: nil,
           # Custom fields for the individual. These are fields which are defined by the
@@ -298,6 +309,7 @@ module FinchAPI
           override.returns(
             {
               id: String,
+              benefit_eligibility_class: T.nilable(String),
               class_code: T.nilable(String),
               custom_fields:
                 T.nilable(

data/rbi/finch_api/resources/access_tokens.rbi

@@ -20,7 +20,10 @@ module FinchAPI
         client_id: nil,
         # The client secret for your application
         client_secret: nil,
-        # The redirect URI used in the authorization request (optional)
+        # The redirect URI used when creating the Connect session. Required if the
+        # authorization code came from the redirect flow, and it must match the
+        # `redirect_uri` used to create the session. Omit it if the code came from the
+        # embedded flow (Connect SDK).
         redirect_uri: nil,
         request_options: {}
       )

data/rbi/finch_api/resources/connect/sessions.rbi

@@ -50,7 +50,9 @@ module FinchAPI
           # `recordkeeping` product is requested. Currently supports `recordkeeper` set to
           # `voya`, `empower`, `fidelity`, or `transamerica`.
           recordkeeping: nil,
-          # The URI to redirect to after the Connect flow is completed
+          # The URI to redirect to after the Connect flow is completed. Required if you use
+          # the redirect flow, and it must be registered on the Credentials tab of the Finch
+          # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
           redirect_uri: nil,
           # Sandbox mode for testing
           sandbox: nil,
@@ -83,7 +85,9 @@ module FinchAPI
           # `benefits` to access deductions endpoints — `deduction` is a deprecated alias
           # that is still accepted but should not be combined with `benefits`.
           products: nil,
-          # The URI to redirect to after the Connect flow is completed
+          # The URI to redirect to after the Connect flow is completed. Required if you use
+          # the redirect flow, and it must be registered on the Credentials tab of the Finch
+          # Developer Dashboard. Omit it for the embedded flow (Connect SDK).
           redirect_uri: nil,
           request_options: {}
         )

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

@@ -26,7 +26,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: Array of the individual_id to enroll and a configuration object.
             individuals: nil,
@@ -47,7 +49,9 @@ module FinchAPI
           def enrolled_ids(
             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: {}
           )
@@ -69,7 +73,9 @@ module FinchAPI
           def retrieve_many_benefits(
             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,
             # comma-delimited list of stable Finch uuids for each individual. If empty,
             # defaults to all individuals
@@ -93,7 +99,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: Array of individual_ids to unenroll.
             individual_ids: nil,

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,

data/rbi/finch_api/resources/sandbox/employment.rbi

@@ -8,6 +8,7 @@ module FinchAPI
         sig do
           params(
             individual_id: String,
+            benefit_eligibility_class: T.nilable(String),
             class_code: T.nilable(String),
             custom_fields:
               T.nilable(
@@ -57,6 +58,10 @@ module FinchAPI
         end
         def update(
           individual_id,
+          # The employer defined benefit eligibility class that groups an employee into a
+          # set of eligible benefit plans, as stored by the provider. Null when not
+          # configured.
+          benefit_eligibility_class: nil,
           # Worker's compensation classification code for this employee
           class_code: nil,
           # Custom fields for the individual. These are fields which are defined by the