com.tryfinch.api.models.HrisPayStatementRetrieveManyParams.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.JsonValue
import com.tryfinch.api.core.NoAutoDetect
import com.tryfinch.api.core.toUnmodifiable
import com.tryfinch.api.models.*
import java.util.Objects
class HrisPayStatementRetrieveManyParams
constructor(
private val requests: List,
private val additionalQueryParams: Map>,
private val additionalHeaders: Map>,
private val additionalBodyProperties: Map,
) {
fun requests(): List = requests
@JvmSynthetic
internal fun getBody(): HrisPayStatementRetrieveManyBody {
return HrisPayStatementRetrieveManyBody(requests, additionalBodyProperties)
}
@JvmSynthetic internal fun getQueryParams(): Map> = additionalQueryParams
@JvmSynthetic internal fun getHeaders(): Map> = additionalHeaders
@JsonDeserialize(builder = HrisPayStatementRetrieveManyBody.Builder::class)
@NoAutoDetect
class HrisPayStatementRetrieveManyBody
internal constructor(
private val requests: List?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The array of batch requests. */
@JsonProperty("requests") fun requests(): List? = requests
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is HrisPayStatementRetrieveManyBody &&
this.requests == other.requests &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = Objects.hash(requests, additionalProperties)
}
return hashCode
}
override fun toString() =
"HrisPayStatementRetrieveManyBody{requests=$requests, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var requests: List? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(hrisPayStatementRetrieveManyBody: HrisPayStatementRetrieveManyBody) =
apply {
this.requests = hrisPayStatementRetrieveManyBody.requests
additionalProperties(hrisPayStatementRetrieveManyBody.additionalProperties)
}
/** The array of batch requests. */
@JsonProperty("requests")
fun requests(requests: List) = apply { this.requests = requests }
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(): HrisPayStatementRetrieveManyBody =
HrisPayStatementRetrieveManyBody(
checkNotNull(requests) { "`requests` is required but was not set" }
.toUnmodifiable(),
additionalProperties.toUnmodifiable()
)
}
}
fun _additionalQueryParams(): Map> = additionalQueryParams
fun _additionalHeaders(): Map> = additionalHeaders
fun _additionalBodyProperties(): Map = additionalBodyProperties
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is HrisPayStatementRetrieveManyParams &&
this.requests == other.requests &&
this.additionalQueryParams == other.additionalQueryParams &&
this.additionalHeaders == other.additionalHeaders &&
this.additionalBodyProperties == other.additionalBodyProperties
}
override fun hashCode(): Int {
return Objects.hash(
requests,
additionalQueryParams,
additionalHeaders,
additionalBodyProperties,
)
}
override fun toString() =
"HrisPayStatementRetrieveManyParams{requests=$requests, additionalQueryParams=$additionalQueryParams, additionalHeaders=$additionalHeaders, additionalBodyProperties=$additionalBodyProperties}"
fun toBuilder() = Builder().from(this)
companion object {
@JvmStatic fun builder() = Builder()
}
@NoAutoDetect
class Builder {
private var requests: MutableList = mutableListOf()
private var additionalQueryParams: MutableMap> = mutableMapOf()
private var additionalHeaders: MutableMap> = mutableMapOf()
private var additionalBodyProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(hrisPayStatementRetrieveManyParams: HrisPayStatementRetrieveManyParams) =
apply {
this.requests(hrisPayStatementRetrieveManyParams.requests)
additionalQueryParams(hrisPayStatementRetrieveManyParams.additionalQueryParams)
additionalHeaders(hrisPayStatementRetrieveManyParams.additionalHeaders)
additionalBodyProperties(
hrisPayStatementRetrieveManyParams.additionalBodyProperties
)
}
/** The array of batch requests. */
fun requests(requests: List) = apply {
this.requests.clear()
this.requests.addAll(requests)
}
/** The array of batch requests. */
fun addRequest(request: Request) = apply { this.requests.add(request) }
fun additionalQueryParams(additionalQueryParams: Map>) = apply {
this.additionalQueryParams.clear()
putAllQueryParams(additionalQueryParams)
}
fun putQueryParam(name: String, value: String) = apply {
this.additionalQueryParams.getOrPut(name) { mutableListOf() }.add(value)
}
fun putQueryParams(name: String, values: Iterable) = apply {
this.additionalQueryParams.getOrPut(name) { mutableListOf() }.addAll(values)
}
fun putAllQueryParams(additionalQueryParams: Map>) = apply {
additionalQueryParams.forEach(this::putQueryParams)
}
fun removeQueryParam(name: String) = apply {
this.additionalQueryParams.put(name, mutableListOf())
}
fun additionalHeaders(additionalHeaders: Map>) = apply {
this.additionalHeaders.clear()
putAllHeaders(additionalHeaders)
}
fun putHeader(name: String, value: String) = apply {
this.additionalHeaders.getOrPut(name) { mutableListOf() }.add(value)
}
fun putHeaders(name: String, values: Iterable) = apply {
this.additionalHeaders.getOrPut(name) { mutableListOf() }.addAll(values)
}
fun putAllHeaders(additionalHeaders: Map>) = apply {
additionalHeaders.forEach(this::putHeaders)
}
fun removeHeader(name: String) = apply { this.additionalHeaders.put(name, mutableListOf()) }
fun additionalBodyProperties(additionalBodyProperties: Map) = apply {
this.additionalBodyProperties.clear()
this.additionalBodyProperties.putAll(additionalBodyProperties)
}
fun putAdditionalBodyProperty(key: String, value: JsonValue) = apply {
this.additionalBodyProperties.put(key, value)
}
fun putAllAdditionalBodyProperties(additionalBodyProperties: Map) =
apply {
this.additionalBodyProperties.putAll(additionalBodyProperties)
}
fun build(): HrisPayStatementRetrieveManyParams =
HrisPayStatementRetrieveManyParams(
checkNotNull(requests) { "`requests` is required but was not set" }
.toUnmodifiable(),
additionalQueryParams.mapValues { it.value.toUnmodifiable() }.toUnmodifiable(),
additionalHeaders.mapValues { it.value.toUnmodifiable() }.toUnmodifiable(),
additionalBodyProperties.toUnmodifiable(),
)
}
@JsonDeserialize(builder = Request.Builder::class)
@NoAutoDetect
class Request
private constructor(
private val paymentId: String?,
private val limit: Long?,
private val offset: Long?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** A stable Finch `id` (UUID v4) for a payment. */
@JsonProperty("payment_id") fun paymentId(): String? = paymentId
/** Number of pay statements to return (defaults to all). */
@JsonProperty("limit") fun limit(): Long? = limit
/** Index to start from. */
@JsonProperty("offset") fun offset(): Long? = offset
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Request &&
this.paymentId == other.paymentId &&
this.limit == other.limit &&
this.offset == other.offset &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
paymentId,
limit,
offset,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Request{paymentId=$paymentId, limit=$limit, offset=$offset, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var paymentId: String? = null
private var limit: Long? = null
private var offset: Long? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(request: Request) = apply {
this.paymentId = request.paymentId
this.limit = request.limit
this.offset = request.offset
additionalProperties(request.additionalProperties)
}
/** A stable Finch `id` (UUID v4) for a payment. */
@JsonProperty("payment_id")
fun paymentId(paymentId: String) = apply { this.paymentId = paymentId }
/** Number of pay statements to return (defaults to all). */
@JsonProperty("limit") fun limit(limit: Long) = apply { this.limit = limit }
/** Index to start from. */
@JsonProperty("offset") fun offset(offset: Long) = apply { this.offset = offset }
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(): Request =
Request(
checkNotNull(paymentId) { "`paymentId` is required but was not set" },
limit,
offset,
additionalProperties.toUnmodifiable(),
)
}
}
}