com.tryfinch.api.models.CompanyBenefit.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of finch-java-core Show documentation
Show all versions of finch-java-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)
// 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.JsonProperty
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
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.toUnmodifiable
import java.util.Objects
import java.util.Optional
@JsonDeserialize(builder = CompanyBenefit.Builder::class)
@NoAutoDetect
class CompanyBenefit
private constructor(
private val benefitId: JsonField,
private val type: JsonField,
private val description: JsonField,
private val frequency: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
fun benefitId(): String = benefitId.getRequired("benefit_id")
/** Type of benefit. */
fun type(): Optional = Optional.ofNullable(type.getNullable("type"))
fun description(): Optional =
Optional.ofNullable(description.getNullable("description"))
fun frequency(): Optional =
Optional.ofNullable(frequency.getNullable("frequency"))
@JsonProperty("benefit_id") @ExcludeMissing fun _benefitId() = benefitId
/** Type of benefit. */
@JsonProperty("type") @ExcludeMissing fun _type() = type
@JsonProperty("description") @ExcludeMissing fun _description() = description
@JsonProperty("frequency") @ExcludeMissing fun _frequency() = frequency
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): CompanyBenefit = apply {
if (!validated) {
benefitId()
type()
description()
frequency()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is CompanyBenefit &&
this.benefitId == other.benefitId &&
this.type == other.type &&
this.description == other.description &&
this.frequency == other.frequency &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
benefitId,
type,
description,
frequency,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"CompanyBenefit{benefitId=$benefitId, type=$type, description=$description, frequency=$frequency, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var benefitId: JsonField = JsonMissing.of()
private var type: JsonField = JsonMissing.of()
private var description: JsonField = JsonMissing.of()
private var frequency: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(companyBenefit: CompanyBenefit) = apply {
this.benefitId = companyBenefit.benefitId
this.type = companyBenefit.type
this.description = companyBenefit.description
this.frequency = companyBenefit.frequency
additionalProperties(companyBenefit.additionalProperties)
}
fun benefitId(benefitId: String) = benefitId(JsonField.of(benefitId))
@JsonProperty("benefit_id")
@ExcludeMissing
fun benefitId(benefitId: JsonField) = apply { this.benefitId = benefitId }
/** Type of benefit. */
fun type(type: BenefitType) = type(JsonField.of(type))
/** Type of benefit. */
@JsonProperty("type")
@ExcludeMissing
fun type(type: JsonField) = apply { this.type = type }
fun description(description: String) = description(JsonField.of(description))
@JsonProperty("description")
@ExcludeMissing
fun description(description: JsonField) = apply { this.description = description }
fun frequency(frequency: BenefitFrequency) = frequency(JsonField.of(frequency))
@JsonProperty("frequency")
@ExcludeMissing
fun frequency(frequency: JsonField) = apply { this.frequency = frequency }
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(): CompanyBenefit =
CompanyBenefit(
benefitId,
type,
description,
frequency,
additionalProperties.toUnmodifiable(),
)
}
}