com.tryfinch.api.models.EnrolledIndividual.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of finch-kotlin-core Show documentation
Show all versions of finch-kotlin-core Show documentation
The Finch HRIS API provides a unified way to connect to a multitide of HRIS
systems. The API requires an access token issued by Finch.
By default, Organization and Payroll requests use Finch's
[Data Syncs](/developer-resources/Data-Syncs). If a request is made before the
initial sync has completed, Finch will request data live from the provider. The
latency on live requests may range from seconds to minutes depending on the
provider and batch size. For automated integrations, Deductions requests (both
read and write) are always made live to the provider. Latencies may range from
seconds to minutes depending on the provider and batch size.
Employer products are specified by the product parameter, a space-separated list
of products that your application requests from an employer authenticating
through Finch Connect. Valid product names are—
- `company`: Read basic company data
- `directory`: Read company directory and organization structure
- `individual`: Read individual data, excluding income and employment data
- `employment`: Read individual employment and income data
- `payment`: Read payroll and contractor related payments by the company
- `pay_statement`: Read detailed pay statements for each individual
- `benefits`: Create and manage deductions and contributions and enrollment for
an employer
[![Open in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4?action=collection%2Ffork&collection-url=entityId%3D21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4%26entityType%3Dcollection%26workspaceId%3D1edf19bc-e0a8-41e9-ac55-481a4b50790b)
The newest version!
// File generated from our OpenAPI spec by Stainless.
package com.tryfinch.api.models
import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.tryfinch.api.core.Enum
import com.tryfinch.api.core.ExcludeMissing
import com.tryfinch.api.core.JsonField
import com.tryfinch.api.core.JsonMissing
import com.tryfinch.api.core.JsonValue
import com.tryfinch.api.core.NoAutoDetect
import com.tryfinch.api.core.toImmutable
import com.tryfinch.api.errors.FinchInvalidDataException
import java.util.Objects
@JsonDeserialize(builder = EnrolledIndividual.Builder::class)
@NoAutoDetect
class EnrolledIndividual
private constructor(
private val individualId: JsonField,
private val code: JsonField,
private val body: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
fun individualId(): String? = individualId.getNullable("individual_id")
/** HTTP status code. Either 201 or 200 */
fun code(): Code? = code.getNullable("code")
fun body(): Body? = body.getNullable("body")
@JsonProperty("individual_id") @ExcludeMissing fun _individualId() = individualId
/** HTTP status code. Either 201 or 200 */
@JsonProperty("code") @ExcludeMissing fun _code() = code
@JsonProperty("body") @ExcludeMissing fun _body() = body
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): EnrolledIndividual = apply {
if (!validated) {
individualId()
code()
body()?.validate()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var individualId: JsonField = JsonMissing.of()
private var code: JsonField = JsonMissing.of()
private var body: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(enrolledIndividual: EnrolledIndividual) = apply {
this.individualId = enrolledIndividual.individualId
this.code = enrolledIndividual.code
this.body = enrolledIndividual.body
additionalProperties(enrolledIndividual.additionalProperties)
}
fun individualId(individualId: String) = individualId(JsonField.of(individualId))
@JsonProperty("individual_id")
@ExcludeMissing
fun individualId(individualId: JsonField) = apply {
this.individualId = individualId
}
/** HTTP status code. Either 201 or 200 */
fun code(code: Code) = code(JsonField.of(code))
/** HTTP status code. Either 201 or 200 */
@JsonProperty("code")
@ExcludeMissing
fun code(code: JsonField) = apply { this.code = code }
fun body(body: Body) = body(JsonField.of(body))
@JsonProperty("body")
@ExcludeMissing
fun body(body: JsonField) = apply { this.body = body }
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): EnrolledIndividual =
EnrolledIndividual(
individualId,
code,
body,
additionalProperties.toImmutable(),
)
}
@JsonDeserialize(builder = Body.Builder::class)
@NoAutoDetect
class Body
private constructor(
private val name: JsonField,
private val finchCode: JsonField,
private val message: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
/** Identifier indicating whether the benefit was newly enrolled or updated. */
fun name(): String? = name.getNullable("name")
/** A descriptive identifier for the response */
fun finchCode(): String? = finchCode.getNullable("finch_code")
/** Short description in English that provides more information about the response. */
fun message(): String? = message.getNullable("message")
/** Identifier indicating whether the benefit was newly enrolled or updated. */
@JsonProperty("name") @ExcludeMissing fun _name() = name
/** A descriptive identifier for the response */
@JsonProperty("finch_code") @ExcludeMissing fun _finchCode() = finchCode
/** Short description in English that provides more information about the response. */
@JsonProperty("message") @ExcludeMissing fun _message() = message
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Body = apply {
if (!validated) {
name()
finchCode()
message()
validated = true
}
}
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var name: JsonField = JsonMissing.of()
private var finchCode: JsonField = JsonMissing.of()
private var message: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(body: Body) = apply {
this.name = body.name
this.finchCode = body.finchCode
this.message = body.message
additionalProperties(body.additionalProperties)
}
/** Identifier indicating whether the benefit was newly enrolled or updated. */
fun name(name: String) = name(JsonField.of(name))
/** Identifier indicating whether the benefit was newly enrolled or updated. */
@JsonProperty("name")
@ExcludeMissing
fun name(name: JsonField) = apply { this.name = name }
/** A descriptive identifier for the response */
fun finchCode(finchCode: String) = finchCode(JsonField.of(finchCode))
/** A descriptive identifier for the response */
@JsonProperty("finch_code")
@ExcludeMissing
fun finchCode(finchCode: JsonField) = apply { this.finchCode = finchCode }
/** Short description in English that provides more information about the response. */
fun message(message: String) = message(JsonField.of(message))
/** Short description in English that provides more information about the response. */
@JsonProperty("message")
@ExcludeMissing
fun message(message: JsonField) = apply { this.message = message }
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): Body =
Body(
name,
finchCode,
message,
additionalProperties.toImmutable(),
)
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is Body && name == other.name && finchCode == other.finchCode && message == other.message && additionalProperties == other.additionalProperties /* spotless:on */
}
/* spotless:off */
private val hashCode: Int by lazy { Objects.hash(name, finchCode, message, additionalProperties) }
/* spotless:on */
override fun hashCode(): Int = hashCode
override fun toString() =
"Body{name=$name, finchCode=$finchCode, message=$message, additionalProperties=$additionalProperties}"
}
class Code
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is Code && value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val OK = Code(JsonField.of(200))
val CREATED = Code(JsonField.of(201))
val NOT_FOUND = Code(JsonField.of(404))
val FORBIDDEN = Code(JsonField.of(403))
fun of(value: Int) = Code(JsonField.of(value))
}
enum class Known {
OK,
CREATED,
NOT_FOUND,
FORBIDDEN,
}
enum class Value {
OK,
CREATED,
NOT_FOUND,
FORBIDDEN,
_UNKNOWN,
}
fun value(): Value =
when (this) {
OK -> Value.OK
CREATED -> Value.CREATED
NOT_FOUND -> Value.NOT_FOUND
FORBIDDEN -> Value.FORBIDDEN
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
OK -> Known.OK
CREATED -> Known.CREATED
NOT_FOUND -> Known.NOT_FOUND
FORBIDDEN -> Known.FORBIDDEN
else -> throw FinchInvalidDataException("Unknown Code: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is EnrolledIndividual && individualId == other.individualId && code == other.code && body == other.body && additionalProperties == other.additionalProperties /* spotless:on */
}
/* spotless:off */
private val hashCode: Int by lazy { Objects.hash(individualId, code, body, additionalProperties) }
/* spotless:on */
override fun hashCode(): Int = hashCode
override fun toString() =
"EnrolledIndividual{individualId=$individualId, code=$code, body=$body, additionalProperties=$additionalProperties}"
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy