com.tryfinch.api.models.AutomatedCreateResponse.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
@JsonDeserialize(builder = AutomatedCreateResponse.Builder::class)
@NoAutoDetect
class AutomatedCreateResponse
private constructor(
private val jobId: JsonField,
private val jobUrl: JsonField,
private val allowedRefreshes: JsonField,
private val remainingRefreshes: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The id of the job that has been created. */
fun jobId(): String = jobId.getRequired("job_id")
/** The url that can be used to retrieve the job status */
fun jobUrl(): String = jobUrl.getRequired("job_url")
/** The number of allowed refreshes per hour (per hour, fixed window) */
fun allowedRefreshes(): Long = allowedRefreshes.getRequired("allowed_refreshes")
/** The number of remaining refreshes available (per hour, fixed window) */
fun remainingRefreshes(): Long = remainingRefreshes.getRequired("remaining_refreshes")
/** The id of the job that has been created. */
@JsonProperty("job_id") @ExcludeMissing fun _jobId() = jobId
/** The url that can be used to retrieve the job status */
@JsonProperty("job_url") @ExcludeMissing fun _jobUrl() = jobUrl
/** The number of allowed refreshes per hour (per hour, fixed window) */
@JsonProperty("allowed_refreshes") @ExcludeMissing fun _allowedRefreshes() = allowedRefreshes
/** The number of remaining refreshes available (per hour, fixed window) */
@JsonProperty("remaining_refreshes")
@ExcludeMissing
fun _remainingRefreshes() = remainingRefreshes
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): AutomatedCreateResponse = apply {
if (!validated) {
jobId()
jobUrl()
allowedRefreshes()
remainingRefreshes()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is AutomatedCreateResponse &&
this.jobId == other.jobId &&
this.jobUrl == other.jobUrl &&
this.allowedRefreshes == other.allowedRefreshes &&
this.remainingRefreshes == other.remainingRefreshes &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
jobId,
jobUrl,
allowedRefreshes,
remainingRefreshes,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"AutomatedCreateResponse{jobId=$jobId, jobUrl=$jobUrl, allowedRefreshes=$allowedRefreshes, remainingRefreshes=$remainingRefreshes, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var jobId: JsonField = JsonMissing.of()
private var jobUrl: JsonField = JsonMissing.of()
private var allowedRefreshes: JsonField = JsonMissing.of()
private var remainingRefreshes: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(automatedCreateResponse: AutomatedCreateResponse) = apply {
this.jobId = automatedCreateResponse.jobId
this.jobUrl = automatedCreateResponse.jobUrl
this.allowedRefreshes = automatedCreateResponse.allowedRefreshes
this.remainingRefreshes = automatedCreateResponse.remainingRefreshes
additionalProperties(automatedCreateResponse.additionalProperties)
}
/** The id of the job that has been created. */
fun jobId(jobId: String) = jobId(JsonField.of(jobId))
/** The id of the job that has been created. */
@JsonProperty("job_id")
@ExcludeMissing
fun jobId(jobId: JsonField) = apply { this.jobId = jobId }
/** The url that can be used to retrieve the job status */
fun jobUrl(jobUrl: String) = jobUrl(JsonField.of(jobUrl))
/** The url that can be used to retrieve the job status */
@JsonProperty("job_url")
@ExcludeMissing
fun jobUrl(jobUrl: JsonField) = apply { this.jobUrl = jobUrl }
/** The number of allowed refreshes per hour (per hour, fixed window) */
fun allowedRefreshes(allowedRefreshes: Long) =
allowedRefreshes(JsonField.of(allowedRefreshes))
/** The number of allowed refreshes per hour (per hour, fixed window) */
@JsonProperty("allowed_refreshes")
@ExcludeMissing
fun allowedRefreshes(allowedRefreshes: JsonField) = apply {
this.allowedRefreshes = allowedRefreshes
}
/** The number of remaining refreshes available (per hour, fixed window) */
fun remainingRefreshes(remainingRefreshes: Long) =
remainingRefreshes(JsonField.of(remainingRefreshes))
/** The number of remaining refreshes available (per hour, fixed window) */
@JsonProperty("remaining_refreshes")
@ExcludeMissing
fun remainingRefreshes(remainingRefreshes: JsonField) = apply {
this.remainingRefreshes = remainingRefreshes
}
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(): AutomatedCreateResponse =
AutomatedCreateResponse(
jobId,
jobUrl,
allowedRefreshes,
remainingRefreshes,
additionalProperties.toUnmodifiable(),
)
}
}