![JAR search and dependency download from the Maven repository](/logo.png)
com.tryfinch.api.models.ManualAsyncJob.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
import java.util.Optional
@JsonDeserialize(builder = ManualAsyncJob.Builder::class)
@NoAutoDetect
class ManualAsyncJob
private constructor(
private val jobId: JsonField,
private val status: JsonField,
private val body: JsonField>,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
fun jobId(): String = jobId.getRequired("job_id")
fun status(): Status = status.getRequired("status")
/** Specific information about the job, such as individual statuses for batch jobs. */
fun body(): Optional> = Optional.ofNullable(body.getNullable("body"))
@JsonProperty("job_id") @ExcludeMissing fun _jobId() = jobId
@JsonProperty("status") @ExcludeMissing fun _status() = status
/** Specific information about the job, such as individual statuses for batch jobs. */
@JsonProperty("body") @ExcludeMissing fun _body() = body
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): ManualAsyncJob = apply {
if (!validated) {
jobId()
status()
body()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is ManualAsyncJob &&
this.jobId == other.jobId &&
this.status == other.status &&
this.body == other.body &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
jobId,
status,
body,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"ManualAsyncJob{jobId=$jobId, status=$status, body=$body, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var jobId: JsonField = JsonMissing.of()
private var status: JsonField = JsonMissing.of()
private var body: JsonField> = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(manualAsyncJob: ManualAsyncJob) = apply {
this.jobId = manualAsyncJob.jobId
this.status = manualAsyncJob.status
this.body = manualAsyncJob.body
additionalProperties(manualAsyncJob.additionalProperties)
}
fun jobId(jobId: String) = jobId(JsonField.of(jobId))
@JsonProperty("job_id")
@ExcludeMissing
fun jobId(jobId: JsonField) = apply { this.jobId = jobId }
fun status(status: Status) = status(JsonField.of(status))
@JsonProperty("status")
@ExcludeMissing
fun status(status: JsonField) = apply { this.status = status }
/** Specific information about the job, such as individual statuses for batch jobs. */
fun body(body: List) = body(JsonField.of(body))
/** Specific information about the job, such as individual statuses for batch jobs. */
@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(): ManualAsyncJob =
ManualAsyncJob(
jobId,
status,
body.map { it.toUnmodifiable() },
additionalProperties.toUnmodifiable(),
)
}
class Status
@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 Status && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val PENDING = Status(JsonField.of("pending"))
@JvmField val IN_PROGRESS = Status(JsonField.of("in_progress"))
@JvmField val ERROR = Status(JsonField.of("error"))
@JvmField val COMPLETE = Status(JsonField.of("complete"))
@JvmStatic fun of(value: String) = Status(JsonField.of(value))
}
enum class Known {
PENDING,
IN_PROGRESS,
ERROR,
COMPLETE,
}
enum class Value {
PENDING,
IN_PROGRESS,
ERROR,
COMPLETE,
_UNKNOWN,
}
fun value(): Value =
when (this) {
PENDING -> Value.PENDING
IN_PROGRESS -> Value.IN_PROGRESS
ERROR -> Value.ERROR
COMPLETE -> Value.COMPLETE
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
PENDING -> Known.PENDING
IN_PROGRESS -> Known.IN_PROGRESS
ERROR -> Known.ERROR
COMPLETE -> Known.COMPLETE
else -> throw FinchInvalidDataException("Unknown Status: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy