com.tryfinch.api.models.SandboxJobConfiguration.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 = SandboxJobConfiguration.Builder::class)
@NoAutoDetect
class SandboxJobConfiguration
private constructor(
private val type: JsonField,
private val completionStatus: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
fun type(): Type = type.getRequired("type")
fun completionStatus(): CompletionStatus = completionStatus.getRequired("completion_status")
@JsonProperty("type") @ExcludeMissing fun _type() = type
@JsonProperty("completion_status") @ExcludeMissing fun _completionStatus() = completionStatus
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): SandboxJobConfiguration = apply {
if (!validated) {
type()
completionStatus()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is SandboxJobConfiguration &&
this.type == other.type &&
this.completionStatus == other.completionStatus &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
type,
completionStatus,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"SandboxJobConfiguration{type=$type, completionStatus=$completionStatus, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var type: JsonField = JsonMissing.of()
private var completionStatus: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(sandboxJobConfiguration: SandboxJobConfiguration) = apply {
this.type = sandboxJobConfiguration.type
this.completionStatus = sandboxJobConfiguration.completionStatus
additionalProperties(sandboxJobConfiguration.additionalProperties)
}
fun type(type: Type) = type(JsonField.of(type))
@JsonProperty("type")
@ExcludeMissing
fun type(type: JsonField) = apply { this.type = type }
fun completionStatus(completionStatus: CompletionStatus) =
completionStatus(JsonField.of(completionStatus))
@JsonProperty("completion_status")
@ExcludeMissing
fun completionStatus(completionStatus: JsonField) = apply {
this.completionStatus = completionStatus
}
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(): SandboxJobConfiguration =
SandboxJobConfiguration(
type,
completionStatus,
additionalProperties.toUnmodifiable(),
)
}
class CompletionStatus
@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 CompletionStatus && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val COMPLETE = CompletionStatus(JsonField.of("complete"))
@JvmField val REAUTH_ERROR = CompletionStatus(JsonField.of("reauth_error"))
@JvmField val PERMISSIONS_ERROR = CompletionStatus(JsonField.of("permissions_error"))
@JvmField val ERROR = CompletionStatus(JsonField.of("error"))
@JvmStatic fun of(value: String) = CompletionStatus(JsonField.of(value))
}
enum class Known {
COMPLETE,
REAUTH_ERROR,
PERMISSIONS_ERROR,
ERROR,
}
enum class Value {
COMPLETE,
REAUTH_ERROR,
PERMISSIONS_ERROR,
ERROR,
_UNKNOWN,
}
fun value(): Value =
when (this) {
COMPLETE -> Value.COMPLETE
REAUTH_ERROR -> Value.REAUTH_ERROR
PERMISSIONS_ERROR -> Value.PERMISSIONS_ERROR
ERROR -> Value.ERROR
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
COMPLETE -> Known.COMPLETE
REAUTH_ERROR -> Known.REAUTH_ERROR
PERMISSIONS_ERROR -> Known.PERMISSIONS_ERROR
ERROR -> Known.ERROR
else -> throw FinchInvalidDataException("Unknown CompletionStatus: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
class Type
@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 Type && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val DATA_SYNC_ALL = Type(JsonField.of("data_sync_all"))
@JvmStatic fun of(value: String) = Type(JsonField.of(value))
}
enum class Known {
DATA_SYNC_ALL,
}
enum class Value {
DATA_SYNC_ALL,
_UNKNOWN,
}
fun value(): Value =
when (this) {
DATA_SYNC_ALL -> Value.DATA_SYNC_ALL
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
DATA_SYNC_ALL -> Known.DATA_SYNC_ALL
else -> throw FinchInvalidDataException("Unknown Type: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}