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

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
@@ -574,6 +584,9 @@ module FinchAPI
 
           class PhoneNumber < FinchAPI::Internal::Type::BaseModel
             # @!attribute data
+            #   The phone number. Format: E.164, with extension where applicable, e.g.
+            #   `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
+            #   the provider is returned.
             #
             #   @return [String, nil]
             optional :data, String, nil?: true
@@ -588,7 +601,12 @@ module FinchAPI
                      nil?: true
 
             # @!method initialize(data: nil, type: nil)
-            #   @param data [String, nil]
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber} for more
+            #   details.
+            #
+            #   @param data [String, nil] The phone number. Format: E.164, with extension where applicable, e.g. `+NNNNNNN
+            #
             #   @param type [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber::Type, nil]
 
             # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::PhoneNumber#type

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/models/sandbox/individual_update_params.rb

@@ -211,6 +211,9 @@ module FinchAPI
 
         class PhoneNumber < FinchAPI::Internal::Type::BaseModel
           # @!attribute data
+          #   The phone number. Format: E.164, with extension where applicable, e.g.
+          #   `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
+          #   the provider is returned.
           #
           #   @return [String, nil]
           optional :data, String, nil?: true
@@ -225,7 +228,12 @@ module FinchAPI
                    nil?: true
 
           # @!method initialize(data: nil, type: nil)
-          #   @param data [String, nil]
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber} for more
+          #   details.
+          #
+          #   @param data [String, nil] The phone number. Format: E.164, with extension where applicable, e.g. `+NNNNNNN
+          #
           #   @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber::Type, nil]
 
           # @see FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber#type

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

@@ -212,6 +212,9 @@ module FinchAPI
 
         class PhoneNumber < FinchAPI::Internal::Type::BaseModel
           # @!attribute data
+          #   The phone number. Format: E.164, with extension where applicable, e.g.
+          #   `+NNNNNNNNNNN xExtension`. If the number cannot be parsed, the raw value from
+          #   the provider is returned.
           #
           #   @return [String, nil]
           optional :data, String, nil?: true
@@ -224,7 +227,12 @@ module FinchAPI
                    nil?: true
 
           # @!method initialize(data: nil, type: nil)
-          #   @param data [String, nil]
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber} for more
+          #   details.
+          #
+          #   @param data [String, nil] The phone number. Format: E.164, with extension where applicable, e.g. `+NNNNNNN
+          #
           #   @param type [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type, nil]
 
           # @see FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber#type

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.58"
+  VERSION = "0.1.0-alpha.60"
 end