com.tryfinch.api.models.HrisEmploymentRetrieveManyPageAsync.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 com.tryfinch.api.services.async.hris.EmploymentServiceAsync
import java.util.Objects
import java.util.Optional
import java.util.concurrent.CompletableFuture
import java.util.concurrent.Executor
import java.util.function.Predicate
class HrisEmploymentRetrieveManyPageAsync
private constructor(
private val employmentsService: EmploymentServiceAsync,
private val params: HrisEmploymentRetrieveManyParams,
private val response: Response,
) {
fun response(): Response = response
fun responses(): List = response().responses()
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is HrisEmploymentRetrieveManyPageAsync &&
this.employmentsService == other.employmentsService &&
this.params == other.params &&
this.response == other.response
}
override fun hashCode(): Int {
return Objects.hash(
employmentsService,
params,
response,
)
}
override fun toString() =
"HrisEmploymentRetrieveManyPageAsync{employmentsService=$employmentsService, params=$params, response=$response}"
fun hasNextPage(): Boolean {
return !responses().isEmpty()
}
fun getNextPageParams(): Optional {
return Optional.empty()
}
fun getNextPage(): CompletableFuture> {
return getNextPageParams()
.map { employmentsService.retrieveMany(it).thenApply { Optional.of(it) } }
.orElseGet { CompletableFuture.completedFuture(Optional.empty()) }
}
fun autoPager(): AutoPager = AutoPager(this)
companion object {
@JvmStatic
fun of(
employmentsService: EmploymentServiceAsync,
params: HrisEmploymentRetrieveManyParams,
response: Response
) =
HrisEmploymentRetrieveManyPageAsync(
employmentsService,
params,
response,
)
}
@JsonDeserialize(builder = Response.Builder::class)
@NoAutoDetect
class Response
constructor(
private val responses: JsonField>,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
fun responses(): List =
responses.getNullable("responses") ?: listOf()
@JsonProperty("responses")
fun _responses(): Optional>> =
Optional.ofNullable(responses)
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Response = apply {
if (!validated) {
responses().map { it.validate() }
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Response &&
this.responses == other.responses &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
return Objects.hash(responses, additionalProperties)
}
override fun toString() =
"HrisEmploymentRetrieveManyPageAsync.Response{responses=$responses, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var responses: JsonField> = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(page: Response) = apply {
this.responses = page.responses
this.additionalProperties.putAll(page.additionalProperties)
}
fun responses(responses: List) =
responses(JsonField.of(responses))
@JsonProperty("responses")
fun responses(responses: JsonField>) = apply {
this.responses = responses
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun build() = Response(responses, additionalProperties.toUnmodifiable())
}
}
class AutoPager
constructor(
private val firstPage: HrisEmploymentRetrieveManyPageAsync,
) {
fun forEach(
action: Predicate,
executor: Executor
): CompletableFuture {
fun CompletableFuture>.forEach(
action: (EmploymentDataResponse) -> Boolean,
executor: Executor
): CompletableFuture =
thenComposeAsync(
{ page ->
page
.filter { it.responses().all(action) }
.map { it.getNextPage().forEach(action, executor) }
.orElseGet { CompletableFuture.completedFuture(null) }
},
executor
)
return CompletableFuture.completedFuture(Optional.of(firstPage))
.forEach(action::test, executor)
}
fun toList(executor: Executor): CompletableFuture> {
val values = mutableListOf()
return forEach(values::add, executor).thenApply { values }
}
}
}