feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 48
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-166cc05754d8591beda094f4ee6f438f55d5f65d490ab364ea130c5100134375.yml
-openapi_spec_hash: 4582a35bbe9fb5404d1e4f804c877fa8
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-bdcc610cd7d5dcb5d3d7598a33957dd673cb81f14ca5d8dc9d41fced4230f114.yml
+openapi_spec_hash: 16dce00b8187a592fab5c88efc7bf7fc
 config_hash: 9ae56f40cec7304896138bfad5caf748

finch-java-core/src/main/kotlin/com/tryfinch/api/models/EmploymentData.kt

@@ -249,6 +249,7 @@ private constructor(
         private val firstName: JsonField<String>,
         private val gender: JsonField<Gender>,
         private val lastName: JsonField<String>,
+        private val maritalStatus: JsonField<MaritalStatus>,
         private val middleName: JsonField<String>,
         private val phoneNumbers: JsonField<List<PhoneNumber?>>,
         private val preferredName: JsonField<String>,
@@ -273,6 +274,9 @@ private constructor(
             @JsonProperty("last_name")
             @ExcludeMissing
             lastName: JsonField<String> = JsonMissing.of(),
+            @JsonProperty("marital_status")
+            @ExcludeMissing
+            maritalStatus: JsonField<MaritalStatus> = JsonMissing.of(),
             @JsonProperty("middle_name")
             @ExcludeMissing
             middleName: JsonField<String> = JsonMissing.of(),
@@ -299,6 +303,7 @@ private constructor(
             firstName,
             gender,
             lastName,
+            maritalStatus,
             middleName,
             phoneNumbers,
             preferredName,
@@ -355,6 +360,15 @@ private constructor(
          */
         fun lastName(): Optional<String> = lastName.getOptional("last_name")
 
+        /**
+         * The employee's marital status, used for beneficiary designation and spousal consent
+         * workflows.
+         *
+         * @throws FinchInvalidDataException if the JSON field has an unexpected type (e.g. if the
+         *   server responded with an unexpected value).
+         */
+        fun maritalStatus(): Optional<MaritalStatus> = maritalStatus.getOptional("marital_status")
+
         /**
          * The legal middle name of the individual.
          *
@@ -453,6 +467,16 @@ private constructor(
          */
         @JsonProperty("last_name") @ExcludeMissing fun _lastName(): JsonField<String> = lastName
 
+        /**
+         * Returns the raw JSON value of [maritalStatus].
+         *
+         * Unlike [maritalStatus], this method doesn't throw if the JSON field has an unexpected
+         * type.
+         */
+        @JsonProperty("marital_status")
+        @ExcludeMissing
+        fun _maritalStatus(): JsonField<MaritalStatus> = maritalStatus
+
         /**
          * Returns the raw JSON value of [middleName].
          *
@@ -538,6 +562,7 @@ private constructor(
              * .firstName()
              * .gender()
              * .lastName()
+             * .maritalStatus()
              * .middleName()
              * .phoneNumbers()
              * .preferredName()
@@ -556,6 +581,7 @@ private constructor(
             private var firstName: JsonField<String>? = null
             private var gender: JsonField<Gender>? = null
             private var lastName: JsonField<String>? = null
+            private var maritalStatus: JsonField<MaritalStatus>? = null
             private var middleName: JsonField<String>? = null
             private var phoneNumbers: JsonField<MutableList<PhoneNumber?>>? = null
             private var preferredName: JsonField<String>? = null
@@ -573,6 +599,7 @@ private constructor(
                 firstName = individualResponseBody.firstName
                 gender = individualResponseBody.gender
                 lastName = individualResponseBody.lastName
+                maritalStatus = individualResponseBody.maritalStatus
                 middleName = individualResponseBody.middleName
                 phoneNumbers = individualResponseBody.phoneNumbers.map { it.toMutableList() }
                 preferredName = individualResponseBody.preferredName
@@ -669,6 +696,28 @@ private constructor(
              */
             fun lastName(lastName: JsonField<String>) = apply { this.lastName = lastName }
 
+            /**
+             * The employee's marital status, used for beneficiary designation and spousal consent
+             * workflows.
+             */
+            fun maritalStatus(maritalStatus: MaritalStatus?) =
+                maritalStatus(JsonField.ofNullable(maritalStatus))
+
+            /** Alias for calling [Builder.maritalStatus] with `maritalStatus.orElse(null)`. */
+            fun maritalStatus(maritalStatus: Optional<MaritalStatus>) =
+                maritalStatus(maritalStatus.getOrNull())
+
+            /**
+             * Sets [Builder.maritalStatus] to an arbitrary JSON value.
+             *
+             * You should usually call [Builder.maritalStatus] with a well-typed [MaritalStatus]
+             * value instead. This method is primarily for setting the field to an undocumented or
+             * not yet supported value.
+             */
+            fun maritalStatus(maritalStatus: JsonField<MaritalStatus>) = apply {
+                this.maritalStatus = maritalStatus
+            }
+
             /** The legal middle name of the individual. */
             fun middleName(middleName: String?) = middleName(JsonField.ofNullable(middleName))
 
@@ -849,6 +898,7 @@ private constructor(
              * .firstName()
              * .gender()
              * .lastName()
+             * .maritalStatus()
              * .middleName()
              * .phoneNumbers()
              * .preferredName()
@@ -865,6 +915,7 @@ private constructor(
                     checkRequired("firstName", firstName),
                     checkRequired("gender", gender),
                     checkRequired("lastName", lastName),
+                    checkRequired("maritalStatus", maritalStatus),
                     checkRequired("middleName", middleName),
                     checkRequired("phoneNumbers", phoneNumbers).map { it.toImmutable() },
                     checkRequired("preferredName", preferredName),
@@ -898,6 +949,7 @@ private constructor(
             firstName()
             gender().ifPresent { it.validate() }
             lastName()
+            maritalStatus().ifPresent { it.validate() }
             middleName()
             phoneNumbers().ifPresent { it.forEach { it?.validate() } }
             preferredName()
@@ -930,6 +982,7 @@ private constructor(
                 (if (firstName.asKnown().isPresent) 1 else 0) +
                 (gender.asKnown().getOrNull()?.validity() ?: 0) +
                 (if (lastName.asKnown().isPresent) 1 else 0) +
+                (maritalStatus.asKnown().getOrNull()?.validity() ?: 0) +
                 (if (middleName.asKnown().isPresent) 1 else 0) +
                 (phoneNumbers.asKnown().getOrNull()?.sumOf { (it?.validity() ?: 0).toInt() } ?: 0) +
                 (if (preferredName.asKnown().isPresent) 1 else 0) +
@@ -1270,6 +1323,175 @@ private constructor(
             override fun toString() = value.toString()
         }
 
+        /**
+         * The employee's marital status, used for beneficiary designation and spousal consent
+         * workflows.
+         */
+        class MaritalStatus @JsonCreator private constructor(private val value: JsonField<String>) :
+            Enum {
+
+            /**
+             * Returns this class instance's raw value.
+             *
+             * This is usually only useful if this instance was deserialized from data that doesn't
+             * match any known member, and you want to know that value. For example, if the SDK is
+             * on an older version than the API, then the API may respond with new members that the
+             * SDK is unaware of.
+             */
+            @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField<String> = value
+
+            companion object {
+
+                @JvmField val SINGLE = of("single")
+
+                @JvmField val MARRIED = of("married")
+
+                @JvmField val DIVORCED = of("divorced")
+
+                @JvmField val WIDOWED = of("widowed")
+
+                @JvmField val DOMESTIC_PARTNER = of("domestic_partner")
+
+                @JvmField val UNKNOWN = of("unknown")
+
+                @JvmStatic fun of(value: String) = MaritalStatus(JsonField.of(value))
+            }
+
+            /** An enum containing [MaritalStatus]'s known values. */
+            enum class Known {
+                SINGLE,
+                MARRIED,
+                DIVORCED,
+                WIDOWED,
+                DOMESTIC_PARTNER,
+                UNKNOWN,
+            }
+
+            /**
+             * An enum containing [MaritalStatus]'s known values, as well as an [_UNKNOWN] member.
+             *
+             * An instance of [MaritalStatus] can contain an unknown value in a couple of cases:
+             * - It was deserialized from data that doesn't match any known member. For example, if
+             *   the SDK is on an older version than the API, then the API may respond with new
+             *   members that the SDK is unaware of.
+             * - It was constructed with an arbitrary value using the [of] method.
+             */
+            enum class Value {
+                SINGLE,
+                MARRIED,
+                DIVORCED,
+                WIDOWED,
+                DOMESTIC_PARTNER,
+                UNKNOWN,
+                /**
+                 * An enum member indicating that [MaritalStatus] was instantiated with an unknown
+                 * value.
+                 */
+                _UNKNOWN,
+            }
+
+            /**
+             * Returns an enum member corresponding to this class instance's value, or
+             * [Value._UNKNOWN] if the class was instantiated with an unknown value.
+             *
+             * Use the [known] method instead if you're certain the value is always known or if you
+             * want to throw for the unknown case.
+             */
+            fun value(): Value =
+                when (this) {
+                    SINGLE -> Value.SINGLE
+                    MARRIED -> Value.MARRIED
+                    DIVORCED -> Value.DIVORCED
+                    WIDOWED -> Value.WIDOWED
+                    DOMESTIC_PARTNER -> Value.DOMESTIC_PARTNER
+                    UNKNOWN -> Value.UNKNOWN
+                    else -> Value._UNKNOWN
+                }
+
+            /**
+             * Returns an enum member corresponding to this class instance's value.
+             *
+             * Use the [value] method instead if you're uncertain the value is always known and
+             * don't want to throw for the unknown case.
+             *
+             * @throws FinchInvalidDataException if this class instance's value is a not a known
+             *   member.
+             */
+            fun known(): Known =
+                when (this) {
+                    SINGLE -> Known.SINGLE
+                    MARRIED -> Known.MARRIED
+                    DIVORCED -> Known.DIVORCED
+                    WIDOWED -> Known.WIDOWED
+                    DOMESTIC_PARTNER -> Known.DOMESTIC_PARTNER
+                    UNKNOWN -> Known.UNKNOWN
+                    else -> throw FinchInvalidDataException("Unknown MaritalStatus: $value")
+                }
+
+            /**
+             * Returns this class instance's primitive wire representation.
+             *
+             * This differs from the [toString] method because that method is primarily for
+             * debugging and generally doesn't throw.
+             *
+             * @throws FinchInvalidDataException if this class instance's value does not have the
+             *   expected primitive type.
+             */
+            fun asString(): String =
+                _value().asString().orElseThrow {
+                    FinchInvalidDataException("Value is not a String")
+                }
+
+            private var validated: Boolean = false
+
+            /**
+             * Validates that the types of all values in this object match their expected types
+             * recursively.
+             *
+             * This method is _not_ forwards compatible with new types from the API for existing
+             * fields.
+             *
+             * @throws FinchInvalidDataException if any value type in this object doesn't match its
+             *   expected type.
+             */
+            fun validate(): MaritalStatus = apply {
+                if (validated) {
+                    return@apply
+                }
+
+                known()
+                validated = true
+            }
+
+            fun isValid(): Boolean =
+                try {
+                    validate()
+                    true
+                } catch (e: FinchInvalidDataException) {
+                    false
+                }
+
+            /**
+             * Returns a score indicating how many valid values are contained in this object
+             * recursively.
+             *
+             * Used for best match union deserialization.
+             */
+            @JvmSynthetic internal fun validity(): Int = if (value() == Value._UNKNOWN) 0 else 1
+
+            override fun equals(other: Any?): Boolean {
+                if (this === other) {
+                    return true
+                }
+
+                return other is MaritalStatus && value == other.value
+            }
+
+            override fun hashCode() = value.hashCode()
+
+            override fun toString() = value.toString()
+        }
+
         class PhoneNumber
         @JsonCreator(mode = JsonCreator.Mode.DISABLED)
         private constructor(
@@ -1982,6 +2204,7 @@ private constructor(
                 firstName == other.firstName &&
                 gender == other.gender &&
                 lastName == other.lastName &&
+                maritalStatus == other.maritalStatus &&
                 middleName == other.middleName &&
                 phoneNumbers == other.phoneNumbers &&
                 preferredName == other.preferredName &&
@@ -2000,6 +2223,7 @@ private constructor(
                 firstName,
                 gender,
                 lastName,
+                maritalStatus,
                 middleName,
                 phoneNumbers,
                 preferredName,
@@ -2014,7 +2238,7 @@ private constructor(
         override fun hashCode(): Int = hashCode
 
         override fun toString() =
-            "IndividualResponseBody{id=$id, dob=$dob, ethnicity=$ethnicity, firstName=$firstName, gender=$gender, lastName=$lastName, middleName=$middleName, phoneNumbers=$phoneNumbers, preferredName=$preferredName, residence=$residence, emails=$emails, encryptedSsn=$encryptedSsn, ssn=$ssn, additionalProperties=$additionalProperties}"
+            "IndividualResponseBody{id=$id, dob=$dob, ethnicity=$ethnicity, firstName=$firstName, gender=$gender, lastName=$lastName, maritalStatus=$maritalStatus, middleName=$middleName, phoneNumbers=$phoneNumbers, preferredName=$preferredName, residence=$residence, emails=$emails, encryptedSsn=$encryptedSsn, ssn=$ssn, additionalProperties=$additionalProperties}"
     }
 
     class BatchError