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

data/lib/finch_api/models/sandbox/directory_create_params.rb

@@ -24,6 +24,14 @@ module FinchAPI
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
         class Body < FinchAPI::Internal::Type::BaseModel
+          # @!attribute benefit_eligibility_class
+          #   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.
+          #
+          #   @return [String, nil]
+          optional :benefit_eligibility_class, String, nil?: true
+
           # @!attribute class_code
           #   Worker's compensation classification code for this employee
           #
@@ -255,10 +263,12 @@ module FinchAPI
           #   @return [String, nil]
           optional :union_local, String, nil?: true
 
-          # @!method initialize(class_code: nil, custom_fields: nil, department: nil, dob: nil, emails: nil, employment: nil, employment_status: nil, encrypted_ssn: nil, end_date: nil, ethnicity: nil, first_name: nil, flsa_status: nil, gender: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, marital_status: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, source_id: nil, ssn: nil, start_date: nil, title: nil, union_code: nil, union_local: nil)
+          # @!method initialize(benefit_eligibility_class: nil, class_code: nil, custom_fields: nil, department: nil, dob: nil, emails: nil, employment: nil, employment_status: nil, encrypted_ssn: nil, end_date: nil, ethnicity: nil, first_name: nil, flsa_status: nil, gender: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, marital_status: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, source_id: nil, ssn: nil, start_date: nil, title: nil, union_code: nil, union_local: nil)
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::Sandbox::DirectoryCreateParams::Body} for more details.
           #
+          #   @param benefit_eligibility_class [String, nil] The employer defined benefit eligibility class that groups an employee into a se
+          #
           #   @param class_code [String, nil] Worker's compensation classification code for this employee
           #
           #   @param custom_fields [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl

data/lib/finch_api/models/sandbox/employment_update_params.rb

@@ -13,6 +13,14 @@ module FinchAPI
         #   @return [String]
         required :individual_id, String
 
+        # @!attribute benefit_eligibility_class
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :benefit_eligibility_class, String, nil?: true
+
         # @!attribute class_code
         #   Worker's compensation classification code for this employee
         #
@@ -163,12 +171,14 @@ module FinchAPI
         #   @return [String, nil]
         optional :union_local, String, nil?: true
 
-        # @!method initialize(individual_id:, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, union_code: nil, union_local: nil, request_options: {})
+        # @!method initialize(individual_id:, benefit_eligibility_class: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, union_code: nil, union_local: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Sandbox::EmploymentUpdateParams} for more details.
         #
         #   @param individual_id [String]
         #
+        #   @param benefit_eligibility_class [String, nil] The employer defined benefit eligibility class that groups an employee into a se
+        #
         #   @param class_code [String, nil] Worker's compensation classification code for this employee
         #
         #   @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl

data/lib/finch_api/models/sandbox/employment_update_response.rb

@@ -11,6 +11,14 @@ module FinchAPI
         #   @return [String, nil]
         optional :id, String
 
+        # @!attribute benefit_eligibility_class
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :benefit_eligibility_class, String, nil?: true
+
         # @!attribute class_code
         #   Worker's compensation classification code for this employee
         #
@@ -161,12 +169,14 @@ module FinchAPI
         #   @return [String, nil]
         optional :union_local, String, nil?: true
 
-        # @!method initialize(id: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, union_code: nil, union_local: nil)
+        # @!method initialize(id: nil, benefit_eligibility_class: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, union_code: nil, union_local: nil)
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Sandbox::EmploymentUpdateResponse} for more details.
         #
         #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
         #
+        #   @param benefit_eligibility_class [String, nil] The employer defined benefit eligibility class that groups an employee into a se
+        #
         #   @param class_code [String, nil] Worker's compensation classification code for this employee
         #
         #   @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl

data/lib/finch_api/resources/access_tokens.rb

@@ -3,6 +3,9 @@
 module FinchAPI
   module Resources
     class AccessTokens
+      # Some parameter documentations has been truncated, see
+      # {FinchAPI::Models::AccessTokenCreateParams} for more details.
+      #
       # Exchange the authorization code for an access token
       #
       # @overload create(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {})
@@ -13,7 +16,7 @@ module FinchAPI
       #
       # @param client_secret [String] The client secret for your application
       #
-      # @param redirect_uri [String] The redirect URI used in the authorization request (optional)
+      # @param redirect_uri [String] The redirect URI used when creating the Connect session. Required if the authori
       #
       # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/finch_api/resources/connect/sessions.rb

@@ -27,7 +27,7 @@ module FinchAPI
         #
         # @param recordkeeping [FinchAPI::Models::Connect::SessionNewParams::Recordkeeping, nil] Optional recordkeeping configuration. Can only be provided when the `recordkeepi
         #
-        # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
+        # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed. Required if you use
         #
         # @param sandbox [Symbol, FinchAPI::Models::Connect::SessionNewParams::Sandbox, nil] Sandbox mode for testing
         #
@@ -61,7 +61,7 @@ module FinchAPI
         #
         # @param products [Array<Symbol, FinchAPI::Models::Connect::SessionReauthenticateParams::Product>, nil] The products to request access to (optional for reauthentication). Use `benefits
         #
-        # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed
+        # @param redirect_uri [String, nil] The URI to redirect to after the Connect flow is completed. Required if you use
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/finch_api/resources/sandbox/employment.rb

@@ -9,10 +9,12 @@ module FinchAPI
         #
         # Update sandbox employment
         #
-        # @overload update(individual_id, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, union_code: nil, union_local: nil, request_options: {})
+        # @overload update(individual_id, benefit_eligibility_class: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, union_code: nil, union_local: nil, request_options: {})
         #
         # @param individual_id [String]
         #
+        # @param benefit_eligibility_class [String, nil] The employer defined benefit eligibility class that groups an employee into a se
+        #
         # @param class_code [String, nil] Worker's compensation classification code for this employee
         #
         # @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl

data/lib/finch_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  VERSION = "0.1.0-alpha.59"
+  VERSION = "0.1.0-alpha.61"
 end

data/rbi/finch_api/models/access_token_create_params.rbi

@@ -29,7 +29,10 @@ module FinchAPI
       sig { params(client_secret: String).void }
       attr_writer :client_secret
 
-      # 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).
       sig { returns(T.nilable(String)) }
       attr_reader :redirect_uri
 
@@ -52,7 +55,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: {}
       )