release: 0.1.0-alpha.19

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.18"
+  ".": "0.1.0-alpha.19"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-dbbf65e94ae7a53cd5a313974761102447ccda3096fd40967c137ad3f80f7154.yml
-openapi_spec_hash: 3cc9d87b60dc27283735d610d4b51a53
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-944a0f9d35f3b8ec2ba62fa12e551cf89f0b845f8ed1e3c7f67a9fb80b32d96f.yml
+openapi_spec_hash: 37c849e7b5dd941c011385b49467e077
 config_hash: 53778a0b839c4f6ad34fbba051f5e8a6

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.1.0-alpha.19 (2025-05-16)
+
+Full Changelog: [v0.1.0-alpha.18...v0.1.0-alpha.19](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.18...v0.1.0-alpha.19)
+
+### Features
+
+* **api:** api update ([e7b5270](https://github.com/Finch-API/finch-api-ruby/commit/e7b527009b74ba9ea5a0c681d12627617971ce31))
+
+
+### Chores
+
+* **internal:** version bump ([4c65aec](https://github.com/Finch-API/finch-api-ruby/commit/4c65aecc566acd9f72c296c003b12bd36acbd8ca))
+
 ## 0.1.0-alpha.18 (2025-05-16)
 
 Full Changelog: [v0.1.0-alpha.17...v0.1.0-alpha.18](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.17...v0.1.0-alpha.18)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    finch-api (0.1.0.pre.alpha.17)
+    finch-api (0.1.0.pre.alpha.18)
       connection_pool
 
 GEM

README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "finch-api", "~> 0.1.0.pre.alpha.18"
+gem "finch-api", "~> 0.1.0.pre.alpha.19"
 ```
 
 <!-- x-release-please-end -->

lib/finch_api/models/hris/employment_data.rb

@@ -25,7 +25,8 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
 
           # @!attribute custom_fields
           #   Custom fields for the individual. These are fields which are defined by the
-          #   employer in the system.
+          #   employer in the system. Custom fields are not currently supported for assisted
+          #   connections.
           #
           #   @return [Array<FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField>, nil]
           required :custom_fields,
@@ -189,7 +190,7 @@ class CustomField < FinchAPI::Internal::Type::BaseModel
             # @!attribute name
             #
             #   @return [String, nil]
-            optional :name, String
+            optional :name, String, nil?: true
 
             # @!attribute value
             #
@@ -199,7 +200,7 @@ class CustomField < FinchAPI::Internal::Type::BaseModel
                      nil?: true
 
             # @!method initialize(name: nil, value: nil)
-            #   @param name [String]
+            #   @param name [String, nil]
             #   @param value [String, Array<Object>, Object, Float, Boolean, nil]
 
             # @see FinchAPI::HRIS::EmploymentData::UnionMember0::CustomField#value
@@ -222,7 +223,7 @@ module Value
               #   @return [Array(String, Array<Object>, Object, Float, Boolean)]
 
               define_sorbet_constant!(:Variants) do
-                T.type_alias { T.any(String, T::Array[T.anything], T.anything, Float, T::Boolean) }
+                T.type_alias { T.nilable(T.any(String, T::Array[T.anything], T.anything, Float, T::Boolean)) }
               end
 
               # @type [FinchAPI::Internal::Type::Converter]

lib/finch_api/models/sandbox/directory_create_params.rb

@@ -42,7 +42,8 @@ class Body < FinchAPI::Internal::Type::BaseModel
           optional :custom_fields,
                    -> {
                      FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField]
-                   }
+                   },
+                   nil?: true
 
           # @!attribute department
           #   The department object.
@@ -71,7 +72,8 @@ class Body < FinchAPI::Internal::Type::BaseModel
           optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true
 
           # @!attribute employment_status
-          #   The detailed employment status of the individual.
+          #   The detailed employment status of the individual. Available options: `active`,
+          #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
           #
           #   @return [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
           optional :employment_status,
@@ -188,7 +190,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
           #   The source system's unique employment identifier for this individual
           #
           #   @return [String, nil]
-          optional :source_id, String
+          optional :source_id, String, nil?: true
 
           # @!attribute ssn
           #   Social Security Number of the individual. This field is only available with the
@@ -216,7 +218,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
           #
           #   @param class_code [String, nil] Worker's compensation classification code for this employee
           #
-          #   @param custom_fields [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
+          #   @param custom_fields [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
           #
           #   @param department [FinchAPI::Sandbox::DirectoryCreateParams::Body::Department, nil] The department object.
           #
@@ -226,7 +228,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
           #
           #   @param employment [FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
           #
-          #   @param employment_status [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual.
+          #   @param employment_status [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
           #
           #   @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
           #
@@ -260,7 +262,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
           #
           #   @param residence [FinchAPI::Location, nil]
           #
-          #   @param source_id [String] The source system's unique employment identifier for this individual
+          #   @param source_id [String, nil] The source system's unique employment identifier for this individual
           #
           #   @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
           #
@@ -356,7 +358,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel
             #
             #   The employment object.
             #
-            #   @param subtype [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
+            #   @param subtype [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
             #
             #   @param type [Symbol, FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment::Type, nil] The main employment type of the individual.
 
@@ -392,7 +394,8 @@ module Type
             end
           end
 
-          # The detailed employment status of the individual.
+          # The detailed employment status of the individual. Available options: `active`,
+          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
           #
           # @see FinchAPI::Sandbox::DirectoryCreateParams::Body#employment_status
           module EmploymentStatus

lib/finch_api/models/sandbox/employment_update_params.rb

@@ -23,7 +23,8 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
         optional :custom_fields,
                  -> {
                    FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::EmploymentUpdateParams::CustomField]
-                 }
+                 },
+                 nil?: true
 
         # @!attribute department
         #   The department object.
@@ -38,7 +39,8 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
         optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true
 
         # @!attribute employment_status
-        #   The detailed employment status of the individual.
+        #   The detailed employment status of the individual. Available options: `active`,
+        #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
         #
         #   @return [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
         optional :employment_status,
@@ -110,7 +112,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
         #   The source system's unique employment identifier for this individual
         #
         #   @return [String, nil]
-        optional :source_id, String
+        optional :source_id, String, nil?: true
 
         # @!attribute start_date
         #
@@ -129,13 +131,13 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
         #
         #   @param class_code [String, nil] Worker's compensation classification code for this employee
         #
-        #   @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
+        #   @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
         #
         #   @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
         #
         #   @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
         #
-        #   @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
+        #   @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
         #
         #   @param end_date [String, nil]
         #
@@ -157,7 +159,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
         #
         #   @param middle_name [String, nil] The legal middle name of the individual.
         #
-        #   @param source_id [String] The source system's unique employment identifier for this individual
+        #   @param source_id [String, nil] The source system's unique employment identifier for this individual
         #
         #   @param start_date [String, nil]
         #
@@ -218,7 +220,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel
           #
           #   The employment object.
           #
-          #   @param subtype [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
+          #   @param subtype [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
           #
           #   @param type [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::Employment::Type, nil] The main employment type of the individual.
 
@@ -254,7 +256,8 @@ module Type
           end
         end
 
-        # The detailed employment status of the individual.
+        # The detailed employment status of the individual. Available options: `active`,
+        # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
         module EmploymentStatus
           extend FinchAPI::Internal::Type::Enum
 

lib/finch_api/models/sandbox/employment_update_response.rb

@@ -24,7 +24,8 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
         #
         #   @return [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>, nil]
         optional :custom_fields,
-                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] }
+                 -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField] },
+                 nil?: true
 
         # @!attribute department
         #   The department object.
@@ -39,7 +40,8 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
         optional :employment, -> { FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment }, nil?: true
 
         # @!attribute employment_status
-        #   The detailed employment status of the individual.
+        #   The detailed employment status of the individual. Available options: `active`,
+        #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
         #
         #   @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil]
         optional :employment_status,
@@ -111,7 +113,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
         #   The source system's unique employment identifier for this individual
         #
         #   @return [String, nil]
-        optional :source_id, String
+        optional :source_id, String, nil?: true
 
         # @!attribute start_date
         #
@@ -132,13 +134,13 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
         #
         #   @param class_code [String, nil] Worker's compensation classification code for this employee
         #
-        #   @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
+        #   @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateResponse::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
         #
         #   @param department [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Department, nil] The department object.
         #
         #   @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, nil] The employment object.
         #
-        #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual.
+        #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
         #
         #   @param end_date [String, nil]
         #
@@ -160,7 +162,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
         #
         #   @param middle_name [String, nil] The legal middle name of the individual.
         #
-        #   @param source_id [String] The source system's unique employment identifier for this individual
+        #   @param source_id [String, nil] The source system's unique employment identifier for this individual
         #
         #   @param start_date [String, nil]
         #
@@ -222,7 +224,7 @@ class Employment < FinchAPI::Internal::Type::BaseModel
           #
           #   The employment object.
           #
-          #   @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_ti
+          #   @param subtype [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Subtype, nil] The secondary employment type of the individual. Options: `full_time`, `part_tim
           #
           #   @param type [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment::Type, nil] The main employment type of the individual.
 
@@ -258,7 +260,8 @@ module Type
           end
         end
 
-        # The detailed employment status of the individual.
+        # The detailed employment status of the individual. Available options: `active`,
+        # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
         #
         # @see FinchAPI::Models::Sandbox::EmploymentUpdateResponse#employment_status
         module EmploymentStatus

lib/finch_api/resources/sandbox/employment.rb

@@ -15,13 +15,13 @@ class Employment
         #
         # @param class_code [String, nil] Worker's compensation classification code for this employee
         #
-        # @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
+        # @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
         #
         # @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
         #
         # @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
         #
-        # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
+        # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
         #
         # @param end_date [String, nil]
         #
@@ -43,7 +43,7 @@ class Employment
         #
         # @param middle_name [String, nil] The legal middle name of the individual.
         #
-        # @param source_id [String] The source system's unique employment identifier for this individual
+        # @param source_id [String, nil] The source system's unique employment identifier for this individual
         #
         # @param start_date [String, nil]
         #

lib/finch_api/version.rb

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