Finch-API · stainless-app · May 17, 2025 · May 16, 2025 · May 16, 2025
@@ -1,3 +1,3 @@
 {
-  ".": "7.1.0"
+  ".": "7.2.0"
 }
@@ -1,4 +1,4 @@
 configured_endpoints: 45
-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
@@ -1,5 +1,13 @@
 # Changelog
 
+## 7.2.0 (2025-05-16)
+
+Full Changelog: [v7.1.0...v7.2.0](https://github.com/Finch-API/finch-api-java/compare/v7.1.0...v7.2.0)
+
+### Features
+
+* **api:** api update ([b3a270c](https://github.com/Finch-API/finch-api-java/commit/b3a270c4bb71fc109642968652ff6ab99c73d9b6))
+
 ## 7.1.0 (2025-05-16)
 
 Full Changelog: [v7.0.0...v7.1.0](https://github.com/Finch-API/finch-api-java/compare/v7.0.0...v7.1.0)

@@ -2,8 +2,8 @@
 
 <!-- x-release-please-start-version -->
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/7.1.0)
-[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/7.1.0/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/7.1.0)
+[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/7.2.0)
+[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/7.2.0/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/7.2.0)
 
 <!-- x-release-please-end -->
 
@@ -15,7 +15,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 <!-- x-release-please-start-version -->
 
-The REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/7.1.0).
+The REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/7.2.0).
 
 <!-- x-release-please-end -->
 
@@ -26,7 +26,7 @@ The REST API documentation can be found on [developer.tryfinch.com](https://deve
 ### Gradle
 
 ```kotlin
-implementation("com.tryfinch.api:finch-java:7.1.0")
+implementation("com.tryfinch.api:finch-java:7.2.0")
 ```
 
 ### Maven
@@ -35,7 +35,7 @@ implementation("com.tryfinch.api:finch-java:7.1.0")
 <dependency>
   <groupId>com.tryfinch.api</groupId>
   <artifactId>finch-java</artifactId>
-  <version>7.1.0</version>
+  <version>7.2.0</version>
 </dependency>
 ```
 

@@ -8,7 +8,7 @@ repositories {
 
 allprojects {
     group = "com.tryfinch.api"
-    version = "7.1.0" // x-release-please-version
+    version = "7.2.0" // x-release-please-version
 }
 
 subprojects {

@@ -320,7 +320,7 @@ private constructor(
 
         /**
          * Custom fields for the individual. These are fields which are defined by the employer in
-         * the system.
+         * the system. Custom fields are not currently supported for assisted connections.
          *
          * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
@@ -741,7 +741,7 @@ private constructor(
 
             /**
              * Custom fields for the individual. These are fields which are defined by the employer
-             * in the system.
+             * in the system. Custom fields are not currently supported for assisted connections.
              */
             fun customFields(customFields: List<CustomField>?) =
                 customFields(JsonField.ofNullable(customFields))
@@ -1285,7 +1285,10 @@ private constructor(
                     additionalProperties = customField.additionalProperties.toMutableMap()
                 }
 
-                fun name(name: String) = name(JsonField.of(name))
+                fun name(name: String?) = name(JsonField.ofNullable(name))
+
+                /** Alias for calling [Builder.name] with `name.orElse(null)`. */
+                fun name(name: Optional<String>) = name(name.getOrNull())
 
                 /**
                  * Sets [Builder.name] to an arbitrary JSON value.

@@ -143,7 +143,8 @@ private constructor(
     fun employment(): Optional<Employment> = employment.getOptional("employment")
 
     /**
-     * The detailed employment status of the individual.
+     * The detailed employment status of the individual. Available options: `active`, `deceased`,
+     * `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
      *
      * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -492,7 +493,12 @@ private constructor(
          * Custom fields for the individual. These are fields which are defined by the employer in
          * the system. Custom fields are not currently supported for assisted connections.
          */
-        fun customFields(customFields: List<CustomField>) = customFields(JsonField.of(customFields))
+        fun customFields(customFields: List<CustomField>?) =
+            customFields(JsonField.ofNullable(customFields))
+
+        /** Alias for calling [Builder.customFields] with `customFields.orElse(null)`. */
+        fun customFields(customFields: Optional<List<CustomField>>) =
+            customFields(customFields.getOrNull())
 
         /**
          * Sets [Builder.customFields] to an arbitrary JSON value.
@@ -547,7 +553,10 @@ private constructor(
          */
         fun employment(employment: JsonField<Employment>) = apply { this.employment = employment }
 
-        /** The detailed employment status of the individual. */
+        /**
+         * The detailed employment status of the individual. Available options: `active`,
+         * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+         */
         fun employmentStatus(employmentStatus: EmploymentStatus?) =
             employmentStatus(JsonField.ofNullable(employmentStatus))
 
@@ -741,7 +750,10 @@ private constructor(
         fun middleName(middleName: JsonField<String>) = apply { this.middleName = middleName }
 
         /** The source system's unique employment identifier for this individual */
-        fun sourceId(sourceId: String) = sourceId(JsonField.of(sourceId))
+        fun sourceId(sourceId: String?) = sourceId(JsonField.ofNullable(sourceId))
+
+        /** Alias for calling [Builder.sourceId] with `sourceId.orElse(null)`. */
+        fun sourceId(sourceId: Optional<String>) = sourceId(sourceId.getOrNull())
 
         /**
          * Sets [Builder.sourceId] to an arbitrary JSON value.
@@ -1656,7 +1668,10 @@ private constructor(
             "Employment{subtype=$subtype, type=$type, additionalProperties=$additionalProperties}"
     }
 
-    /** The detailed employment status of the individual. */
+    /**
+     * The detailed employment status of the individual. Available options: `active`, `deceased`,
+     * `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+     */
     class EmploymentStatus @JsonCreator private constructor(private val value: JsonField<String>) :
         Enum {
 

@@ -291,7 +291,8 @@ private constructor(
         fun employment(): Optional<Employment> = employment.getOptional("employment")
 
         /**
-         * The detailed employment status of the individual.
+         * The detailed employment status of the individual. Available options: `active`,
+         * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
          *
          * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
@@ -763,8 +764,12 @@ private constructor(
              * Custom fields for the individual. These are fields which are defined by the employer
              * in the system. Custom fields are not currently supported for assisted connections.
              */
-            fun customFields(customFields: List<CustomField>) =
-                customFields(JsonField.of(customFields))
+            fun customFields(customFields: List<CustomField>?) =
+                customFields(JsonField.ofNullable(customFields))
+
+            /** Alias for calling [Builder.customFields] with `customFields.orElse(null)`. */
+            fun customFields(customFields: Optional<List<CustomField>>) =
+                customFields(customFields.getOrNull())
 
             /**
              * Sets [Builder.customFields] to an arbitrary JSON value.
@@ -865,7 +870,10 @@ private constructor(
                 this.employment = employment
             }
 
-            /** The detailed employment status of the individual. */
+            /**
+             * The detailed employment status of the individual. Available options: `active`,
+             * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+             */
             fun employmentStatus(employmentStatus: EmploymentStatus?) =
                 employmentStatus(JsonField.ofNullable(employmentStatus))
 
@@ -1183,7 +1191,10 @@ private constructor(
             fun residence(residence: JsonField<Location>) = apply { this.residence = residence }
 
             /** The source system's unique employment identifier for this individual */
-            fun sourceId(sourceId: String) = sourceId(JsonField.of(sourceId))
+            fun sourceId(sourceId: String?) = sourceId(JsonField.ofNullable(sourceId))
+
+            /** Alias for calling [Builder.sourceId] with `sourceId.orElse(null)`. */
+            fun sourceId(sourceId: Optional<String>) = sourceId(sourceId.getOrNull())
 
             /**
              * Sets [Builder.sourceId] to an arbitrary JSON value.
@@ -2447,7 +2458,10 @@ private constructor(
                 "Employment{subtype=$subtype, type=$type, additionalProperties=$additionalProperties}"
         }
 
-        /** The detailed employment status of the individual. */
+        /**
+         * The detailed employment status of the individual. Available options: `active`,
+         * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+         */
         class EmploymentStatus
         @JsonCreator
         private constructor(private val value: JsonField<String>) : Enum {

@@ -67,7 +67,8 @@ private constructor(
     fun employment(): Optional<Employment> = body.employment()
 
     /**
-     * The detailed employment status of the individual.
+     * The detailed employment status of the individual. Available options: `active`, `deceased`,
+     * `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
      *
      * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -373,10 +374,14 @@ private constructor(
          * Custom fields for the individual. These are fields which are defined by the employer in
          * the system. Custom fields are not currently supported for assisted connections.
          */
-        fun customFields(customFields: List<CustomField>) = apply {
+        fun customFields(customFields: List<CustomField>?) = apply {
             body.customFields(customFields)
         }
 
+        /** Alias for calling [Builder.customFields] with `customFields.orElse(null)`. */
+        fun customFields(customFields: Optional<List<CustomField>>) =
+            customFields(customFields.getOrNull())
+
         /**
          * Sets [Builder.customFields] to an arbitrary JSON value.
          *
@@ -425,7 +430,10 @@ private constructor(
          */
         fun employment(employment: JsonField<Employment>) = apply { body.employment(employment) }
 
-        /** The detailed employment status of the individual. */
+        /**
+         * The detailed employment status of the individual. Available options: `active`,
+         * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+         */
         fun employmentStatus(employmentStatus: EmploymentStatus?) = apply {
             body.employmentStatus(employmentStatus)
         }
@@ -617,7 +625,10 @@ private constructor(
         fun middleName(middleName: JsonField<String>) = apply { body.middleName(middleName) }
 
         /** The source system's unique employment identifier for this individual */
-        fun sourceId(sourceId: String) = apply { body.sourceId(sourceId) }
+        fun sourceId(sourceId: String?) = apply { body.sourceId(sourceId) }
+
+        /** Alias for calling [Builder.sourceId] with `sourceId.orElse(null)`. */
+        fun sourceId(sourceId: Optional<String>) = sourceId(sourceId.getOrNull())
 
         /**
          * Sets [Builder.sourceId] to an arbitrary JSON value.
@@ -925,7 +936,8 @@ private constructor(
         fun employment(): Optional<Employment> = employment.getOptional("employment")
 
         /**
-         * The detailed employment status of the individual.
+         * The detailed employment status of the individual. Available options: `active`,
+         * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
          *
          * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
@@ -1259,8 +1271,12 @@ private constructor(
              * Custom fields for the individual. These are fields which are defined by the employer
              * in the system. Custom fields are not currently supported for assisted connections.
              */
-            fun customFields(customFields: List<CustomField>) =
-                customFields(JsonField.of(customFields))
+            fun customFields(customFields: List<CustomField>?) =
+                customFields(JsonField.ofNullable(customFields))
+
+            /** Alias for calling [Builder.customFields] with `customFields.orElse(null)`. */
+            fun customFields(customFields: Optional<List<CustomField>>) =
+                customFields(customFields.getOrNull())
 
             /**
              * Sets [Builder.customFields] to an arbitrary JSON value.
@@ -1319,7 +1335,10 @@ private constructor(
                 this.employment = employment
             }
 
-            /** The detailed employment status of the individual. */
+            /**
+             * The detailed employment status of the individual. Available options: `active`,
+             * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+             */
             fun employmentStatus(employmentStatus: EmploymentStatus?) =
                 employmentStatus(JsonField.ofNullable(employmentStatus))
 
@@ -1521,7 +1540,10 @@ private constructor(
             fun middleName(middleName: JsonField<String>) = apply { this.middleName = middleName }
 
             /** The source system's unique employment identifier for this individual */
-            fun sourceId(sourceId: String) = sourceId(JsonField.of(sourceId))
+            fun sourceId(sourceId: String?) = sourceId(JsonField.ofNullable(sourceId))
+
+            /** Alias for calling [Builder.sourceId] with `sourceId.orElse(null)`. */
+            fun sourceId(sourceId: Optional<String>) = sourceId(sourceId.getOrNull())
 
             /**
              * Sets [Builder.sourceId] to an arbitrary JSON value.
@@ -2455,7 +2477,10 @@ private constructor(
             "Employment{subtype=$subtype, type=$type, additionalProperties=$additionalProperties}"
     }
 
-    /** The detailed employment status of the individual. */
+    /**
+     * The detailed employment status of the individual. Available options: `active`, `deceased`,
+     * `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+     */
     class EmploymentStatus @JsonCreator private constructor(private val value: JsonField<String>) :
         Enum {