com.tryfinch.api.models.PayGroupRetrieveResponse.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.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.toUnmodifiable
import com.tryfinch.api.errors.FinchInvalidDataException
import java.util.Objects
@JsonDeserialize(builder = PayGroupRetrieveResponse.Builder::class)
@NoAutoDetect
class PayGroupRetrieveResponse
private constructor(
private val id: JsonField,
private val name: JsonField,
private val payFrequencies: JsonField>,
private val individualIds: JsonField>,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** Finch id (uuidv4) for the pay group */
fun id(): String = id.getRequired("id")
/** Name of the pay group */
fun name(): String = name.getRequired("name")
/** List of pay frequencies associated with this pay group */
fun payFrequencies(): List = payFrequencies.getRequired("pay_frequencies")
fun individualIds(): List = individualIds.getRequired("individual_ids")
/** Finch id (uuidv4) for the pay group */
@JsonProperty("id") @ExcludeMissing fun _id() = id
/** Name of the pay group */
@JsonProperty("name") @ExcludeMissing fun _name() = name
/** List of pay frequencies associated with this pay group */
@JsonProperty("pay_frequencies") @ExcludeMissing fun _payFrequencies() = payFrequencies
@JsonProperty("individual_ids") @ExcludeMissing fun _individualIds() = individualIds
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): PayGroupRetrieveResponse = apply {
if (!validated) {
id()
name()
payFrequencies()
individualIds()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is PayGroupRetrieveResponse &&
this.id == other.id &&
this.name == other.name &&
this.payFrequencies == other.payFrequencies &&
this.individualIds == other.individualIds &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
id,
name,
payFrequencies,
individualIds,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"PayGroupRetrieveResponse{id=$id, name=$name, payFrequencies=$payFrequencies, individualIds=$individualIds, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var id: JsonField = JsonMissing.of()
private var name: JsonField = JsonMissing.of()
private var payFrequencies: JsonField> = JsonMissing.of()
private var individualIds: JsonField> = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(payGroupRetrieveResponse: PayGroupRetrieveResponse) = apply {
this.id = payGroupRetrieveResponse.id
this.name = payGroupRetrieveResponse.name
this.payFrequencies = payGroupRetrieveResponse.payFrequencies
this.individualIds = payGroupRetrieveResponse.individualIds
additionalProperties(payGroupRetrieveResponse.additionalProperties)
}
/** Finch id (uuidv4) for the pay group */
fun id(id: String) = id(JsonField.of(id))
/** Finch id (uuidv4) for the pay group */
@JsonProperty("id") @ExcludeMissing fun id(id: JsonField) = apply { this.id = id }
/** Name of the pay group */
fun name(name: String) = name(JsonField.of(name))
/** Name of the pay group */
@JsonProperty("name")
@ExcludeMissing
fun name(name: JsonField) = apply { this.name = name }
/** List of pay frequencies associated with this pay group */
fun payFrequencies(payFrequencies: List) =
payFrequencies(JsonField.of(payFrequencies))
/** List of pay frequencies associated with this pay group */
@JsonProperty("pay_frequencies")
@ExcludeMissing
fun payFrequencies(payFrequencies: JsonField>) = apply {
this.payFrequencies = payFrequencies
}
fun individualIds(individualIds: List) = individualIds(JsonField.of(individualIds))
@JsonProperty("individual_ids")
@ExcludeMissing
fun individualIds(individualIds: JsonField>) = apply {
this.individualIds = individualIds
}
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(): PayGroupRetrieveResponse =
PayGroupRetrieveResponse(
id,
name,
payFrequencies.map { it.toUnmodifiable() },
individualIds.map { it.toUnmodifiable() },
additionalProperties.toUnmodifiable(),
)
}
class PayFrequency
@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 other is PayFrequency && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val ANNUALLY = PayFrequency(JsonField.of("annually"))
@JvmField val SEMI_ANNUALLY = PayFrequency(JsonField.of("semi_annually"))
@JvmField val QUARTERLY = PayFrequency(JsonField.of("quarterly"))
@JvmField val MONTHLY = PayFrequency(JsonField.of("monthly"))
@JvmField val SEMI_MONTHLY = PayFrequency(JsonField.of("semi_monthly"))
@JvmField val BI_WEEKLY = PayFrequency(JsonField.of("bi_weekly"))
@JvmField val WEEKLY = PayFrequency(JsonField.of("weekly"))
@JvmField val DAILY = PayFrequency(JsonField.of("daily"))
@JvmField val OTHER = PayFrequency(JsonField.of("other"))
@JvmStatic fun of(value: String) = PayFrequency(JsonField.of(value))
}
enum class Known {
ANNUALLY,
SEMI_ANNUALLY,
QUARTERLY,
MONTHLY,
SEMI_MONTHLY,
BI_WEEKLY,
WEEKLY,
DAILY,
OTHER,
}
enum class Value {
ANNUALLY,
SEMI_ANNUALLY,
QUARTERLY,
MONTHLY,
SEMI_MONTHLY,
BI_WEEKLY,
WEEKLY,
DAILY,
OTHER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ANNUALLY -> Value.ANNUALLY
SEMI_ANNUALLY -> Value.SEMI_ANNUALLY
QUARTERLY -> Value.QUARTERLY
MONTHLY -> Value.MONTHLY
SEMI_MONTHLY -> Value.SEMI_MONTHLY
BI_WEEKLY -> Value.BI_WEEKLY
WEEKLY -> Value.WEEKLY
DAILY -> Value.DAILY
OTHER -> Value.OTHER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ANNUALLY -> Known.ANNUALLY
SEMI_ANNUALLY -> Known.SEMI_ANNUALLY
QUARTERLY -> Known.QUARTERLY
MONTHLY -> Known.MONTHLY
SEMI_MONTHLY -> Known.SEMI_MONTHLY
BI_WEEKLY -> Known.BI_WEEKLY
WEEKLY -> Known.WEEKLY
DAILY -> Known.DAILY
OTHER -> Known.OTHER
else -> throw FinchInvalidDataException("Unknown PayFrequency: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}