com.tryfinch.api.models.PayStatementEvent.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 = PayStatementEvent.Builder::class)
@NoAutoDetect
class PayStatementEvent
private constructor(
private val connectionId: JsonField,
private val companyId: JsonField,
private val accountId: JsonField,
private val eventType: JsonField,
private val data: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** Unique Finch ID of the connection associated with the webhook event. */
fun connectionId(): Optional =
Optional.ofNullable(connectionId.getNullable("connection_id"))
/**
* [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
* `connection_id` instead to identify the connection associated with this event.
*/
fun companyId(): String = companyId.getRequired("company_id")
/**
* [DEPRECATED] Unique Finch ID of the employer account used to make this connection. Use
* `connection_id` instead to identify the connection associated with this event.
*/
fun accountId(): String = accountId.getRequired("account_id")
fun eventType(): Optional = Optional.ofNullable(eventType.getNullable("event_type"))
fun data(): Optional = Optional.ofNullable(data.getNullable("data"))
fun toBaseWebhookEvent(): BaseWebhookEvent =
BaseWebhookEvent.builder()
.connectionId(connectionId)
.companyId(companyId)
.accountId(accountId)
.build()
/** Unique Finch ID of the connection associated with the webhook event. */
@JsonProperty("connection_id") @ExcludeMissing fun _connectionId() = connectionId
/**
* [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
* `connection_id` instead to identify the connection associated with this event.
*/
@JsonProperty("company_id") @ExcludeMissing fun _companyId() = companyId
/**
* [DEPRECATED] Unique Finch ID of the employer account used to make this connection. Use
* `connection_id` instead to identify the connection associated with this event.
*/
@JsonProperty("account_id") @ExcludeMissing fun _accountId() = accountId
@JsonProperty("event_type") @ExcludeMissing fun _eventType() = eventType
@JsonProperty("data") @ExcludeMissing fun _data() = data
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): PayStatementEvent = apply {
if (!validated) {
connectionId()
companyId()
accountId()
eventType()
data().map { it.validate() }
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is PayStatementEvent &&
this.connectionId == other.connectionId &&
this.companyId == other.companyId &&
this.accountId == other.accountId &&
this.eventType == other.eventType &&
this.data == other.data &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
connectionId,
companyId,
accountId,
eventType,
data,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"PayStatementEvent{connectionId=$connectionId, companyId=$companyId, accountId=$accountId, eventType=$eventType, data=$data, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var connectionId: JsonField = JsonMissing.of()
private var companyId: JsonField = JsonMissing.of()
private var accountId: JsonField = JsonMissing.of()
private var eventType: JsonField = JsonMissing.of()
private var data: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(payStatementEvent: PayStatementEvent) = apply {
this.connectionId = payStatementEvent.connectionId
this.companyId = payStatementEvent.companyId
this.accountId = payStatementEvent.accountId
this.eventType = payStatementEvent.eventType
this.data = payStatementEvent.data
additionalProperties(payStatementEvent.additionalProperties)
}
/** Unique Finch ID of the connection associated with the webhook event. */
fun connectionId(connectionId: String) = connectionId(JsonField.of(connectionId))
/** Unique Finch ID of the connection associated with the webhook event. */
@JsonProperty("connection_id")
@ExcludeMissing
fun connectionId(connectionId: JsonField) = apply {
this.connectionId = connectionId
}
/**
* [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
* `connection_id` instead to identify the connection associated with this event.
*/
fun companyId(companyId: String) = companyId(JsonField.of(companyId))
/**
* [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
* `connection_id` instead to identify the connection associated with this event.
*/
@JsonProperty("company_id")
@ExcludeMissing
fun companyId(companyId: JsonField) = apply { this.companyId = companyId }
/**
* [DEPRECATED] Unique Finch ID of the employer account used to make this connection. Use
* `connection_id` instead to identify the connection associated with this event.
*/
fun accountId(accountId: String) = accountId(JsonField.of(accountId))
/**
* [DEPRECATED] Unique Finch ID of the employer account used to make this connection. Use
* `connection_id` instead to identify the connection associated with this event.
*/
@JsonProperty("account_id")
@ExcludeMissing
fun accountId(accountId: JsonField) = apply { this.accountId = accountId }
fun eventType(eventType: EventType) = eventType(JsonField.of(eventType))
@JsonProperty("event_type")
@ExcludeMissing
fun eventType(eventType: JsonField) = apply { this.eventType = eventType }
fun data(data: Data) = data(JsonField.of(data))
@JsonProperty("data")
@ExcludeMissing
fun data(data: JsonField) = apply { this.data = data }
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(): PayStatementEvent =
PayStatementEvent(
connectionId,
companyId,
accountId,
eventType,
data,
additionalProperties.toUnmodifiable(),
)
}
@JsonDeserialize(builder = Data.Builder::class)
@NoAutoDetect
class Data
private constructor(
private val paymentId: JsonField,
private val individualId: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The ID of the payment associated with the pay statement. */
fun paymentId(): Optional = Optional.ofNullable(paymentId.getNullable("payment_id"))
/** The ID of the individual associated with the pay statement. */
fun individualId(): Optional =
Optional.ofNullable(individualId.getNullable("individual_id"))
/** The ID of the payment associated with the pay statement. */
@JsonProperty("payment_id") @ExcludeMissing fun _paymentId() = paymentId
/** The ID of the individual associated with the pay statement. */
@JsonProperty("individual_id") @ExcludeMissing fun _individualId() = individualId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): Data = apply {
if (!validated) {
paymentId()
individualId()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Data &&
this.paymentId == other.paymentId &&
this.individualId == other.individualId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
paymentId,
individualId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Data{paymentId=$paymentId, individualId=$individualId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var paymentId: JsonField = JsonMissing.of()
private var individualId: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(data: Data) = apply {
this.paymentId = data.paymentId
this.individualId = data.individualId
additionalProperties(data.additionalProperties)
}
/** The ID of the payment associated with the pay statement. */
fun paymentId(paymentId: String) = paymentId(JsonField.of(paymentId))
/** The ID of the payment associated with the pay statement. */
@JsonProperty("payment_id")
@ExcludeMissing
fun paymentId(paymentId: JsonField) = apply { this.paymentId = paymentId }
/** The ID of the individual associated with the pay statement. */
fun individualId(individualId: String) = individualId(JsonField.of(individualId))
/** The ID of the individual associated with the pay statement. */
@JsonProperty("individual_id")
@ExcludeMissing
fun individualId(individualId: JsonField) = apply {
this.individualId = individualId
}
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(): Data =
Data(
paymentId,
individualId,
additionalProperties.toUnmodifiable(),
)
}
}
class EventType
@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 EventType && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val PAY_STATEMENT_CREATED = EventType(JsonField.of("pay_statement.created"))
@JvmField val PAY_STATEMENT_UPDATED = EventType(JsonField.of("pay_statement.updated"))
@JvmField val PAY_STATEMENT_DELETED = EventType(JsonField.of("pay_statement.deleted"))
@JvmStatic fun of(value: String) = EventType(JsonField.of(value))
}
enum class Known {
PAY_STATEMENT_CREATED,
PAY_STATEMENT_UPDATED,
PAY_STATEMENT_DELETED,
}
enum class Value {
PAY_STATEMENT_CREATED,
PAY_STATEMENT_UPDATED,
PAY_STATEMENT_DELETED,
_UNKNOWN,
}
fun value(): Value =
when (this) {
PAY_STATEMENT_CREATED -> Value.PAY_STATEMENT_CREATED
PAY_STATEMENT_UPDATED -> Value.PAY_STATEMENT_UPDATED
PAY_STATEMENT_DELETED -> Value.PAY_STATEMENT_DELETED
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
PAY_STATEMENT_CREATED -> Known.PAY_STATEMENT_CREATED
PAY_STATEMENT_UPDATED -> Known.PAY_STATEMENT_UPDATED
PAY_STATEMENT_DELETED -> Known.PAY_STATEMENT_DELETED
else -> throw FinchInvalidDataException("Unknown EventType: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}