com.tryfinch.api.models.WebhookEvent.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of finch-kotlin-core Show documentation
Show all versions of finch-kotlin-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)
The newest version!
// File generated from our OpenAPI spec by Stainless.
package com.tryfinch.api.models
import com.fasterxml.jackson.core.JsonGenerator
import com.fasterxml.jackson.core.ObjectCodec
import com.fasterxml.jackson.databind.JsonNode
import com.fasterxml.jackson.databind.SerializerProvider
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.module.kotlin.jacksonTypeRef
import com.tryfinch.api.core.BaseDeserializer
import com.tryfinch.api.core.BaseSerializer
import com.tryfinch.api.core.JsonValue
import com.tryfinch.api.core.getOrThrow
import com.tryfinch.api.errors.FinchInvalidDataException
import java.util.Objects
@JsonDeserialize(using = WebhookEvent.Deserializer::class)
@JsonSerialize(using = WebhookEvent.Serializer::class)
class WebhookEvent
private constructor(
private val accountUpdateEvent: AccountUpdateEvent? = null,
private val jobCompletionEvent: JobCompletionEvent? = null,
private val companyEvent: CompanyEvent? = null,
private val directoryEvent: DirectoryEvent? = null,
private val employmentEvent: EmploymentEvent? = null,
private val individualEvent: IndividualEvent? = null,
private val paymentEvent: PaymentEvent? = null,
private val payStatementEvent: PayStatementEvent? = null,
private val _json: JsonValue? = null,
) {
private var validated: Boolean = false
fun accountUpdateEvent(): AccountUpdateEvent? = accountUpdateEvent
fun jobCompletionEvent(): JobCompletionEvent? = jobCompletionEvent
fun companyEvent(): CompanyEvent? = companyEvent
fun directoryEvent(): DirectoryEvent? = directoryEvent
fun employmentEvent(): EmploymentEvent? = employmentEvent
fun individualEvent(): IndividualEvent? = individualEvent
fun paymentEvent(): PaymentEvent? = paymentEvent
fun payStatementEvent(): PayStatementEvent? = payStatementEvent
fun isAccountUpdateEvent(): Boolean = accountUpdateEvent != null
fun isJobCompletionEvent(): Boolean = jobCompletionEvent != null
fun isCompanyEvent(): Boolean = companyEvent != null
fun isDirectoryEvent(): Boolean = directoryEvent != null
fun isEmploymentEvent(): Boolean = employmentEvent != null
fun isIndividualEvent(): Boolean = individualEvent != null
fun isPaymentEvent(): Boolean = paymentEvent != null
fun isPayStatementEvent(): Boolean = payStatementEvent != null
fun asAccountUpdateEvent(): AccountUpdateEvent =
accountUpdateEvent.getOrThrow("accountUpdateEvent")
fun asJobCompletionEvent(): JobCompletionEvent =
jobCompletionEvent.getOrThrow("jobCompletionEvent")
fun asCompanyEvent(): CompanyEvent = companyEvent.getOrThrow("companyEvent")
fun asDirectoryEvent(): DirectoryEvent = directoryEvent.getOrThrow("directoryEvent")
fun asEmploymentEvent(): EmploymentEvent = employmentEvent.getOrThrow("employmentEvent")
fun asIndividualEvent(): IndividualEvent = individualEvent.getOrThrow("individualEvent")
fun asPaymentEvent(): PaymentEvent = paymentEvent.getOrThrow("paymentEvent")
fun asPayStatementEvent(): PayStatementEvent = payStatementEvent.getOrThrow("payStatementEvent")
fun _json(): JsonValue? = _json
fun accept(visitor: Visitor): T {
return when {
accountUpdateEvent != null -> visitor.visitAccountUpdateEvent(accountUpdateEvent)
jobCompletionEvent != null -> visitor.visitJobCompletionEvent(jobCompletionEvent)
companyEvent != null -> visitor.visitCompanyEvent(companyEvent)
directoryEvent != null -> visitor.visitDirectoryEvent(directoryEvent)
employmentEvent != null -> visitor.visitEmploymentEvent(employmentEvent)
individualEvent != null -> visitor.visitIndividualEvent(individualEvent)
paymentEvent != null -> visitor.visitPaymentEvent(paymentEvent)
payStatementEvent != null -> visitor.visitPayStatementEvent(payStatementEvent)
else -> visitor.unknown(_json)
}
}
fun validate(): WebhookEvent = apply {
if (!validated) {
if (
accountUpdateEvent == null &&
jobCompletionEvent == null &&
companyEvent == null &&
directoryEvent == null &&
employmentEvent == null &&
individualEvent == null &&
paymentEvent == null &&
payStatementEvent == null
) {
throw FinchInvalidDataException("Unknown WebhookEvent: $_json")
}
validated = true
}
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is WebhookEvent && accountUpdateEvent == other.accountUpdateEvent && jobCompletionEvent == other.jobCompletionEvent && companyEvent == other.companyEvent && directoryEvent == other.directoryEvent && employmentEvent == other.employmentEvent && individualEvent == other.individualEvent && paymentEvent == other.paymentEvent && payStatementEvent == other.payStatementEvent /* spotless:on */
}
override fun hashCode(): Int = /* spotless:off */ Objects.hash(accountUpdateEvent, jobCompletionEvent, companyEvent, directoryEvent, employmentEvent, individualEvent, paymentEvent, payStatementEvent) /* spotless:on */
override fun toString(): String =
when {
accountUpdateEvent != null -> "WebhookEvent{accountUpdateEvent=$accountUpdateEvent}"
jobCompletionEvent != null -> "WebhookEvent{jobCompletionEvent=$jobCompletionEvent}"
companyEvent != null -> "WebhookEvent{companyEvent=$companyEvent}"
directoryEvent != null -> "WebhookEvent{directoryEvent=$directoryEvent}"
employmentEvent != null -> "WebhookEvent{employmentEvent=$employmentEvent}"
individualEvent != null -> "WebhookEvent{individualEvent=$individualEvent}"
paymentEvent != null -> "WebhookEvent{paymentEvent=$paymentEvent}"
payStatementEvent != null -> "WebhookEvent{payStatementEvent=$payStatementEvent}"
_json != null -> "WebhookEvent{_unknown=$_json}"
else -> throw IllegalStateException("Invalid WebhookEvent")
}
companion object {
fun ofAccountUpdateEvent(accountUpdateEvent: AccountUpdateEvent) =
WebhookEvent(accountUpdateEvent = accountUpdateEvent)
fun ofJobCompletionEvent(jobCompletionEvent: JobCompletionEvent) =
WebhookEvent(jobCompletionEvent = jobCompletionEvent)
fun ofCompanyEvent(companyEvent: CompanyEvent) = WebhookEvent(companyEvent = companyEvent)
fun ofDirectoryEvent(directoryEvent: DirectoryEvent) =
WebhookEvent(directoryEvent = directoryEvent)
fun ofEmploymentEvent(employmentEvent: EmploymentEvent) =
WebhookEvent(employmentEvent = employmentEvent)
fun ofIndividualEvent(individualEvent: IndividualEvent) =
WebhookEvent(individualEvent = individualEvent)
fun ofPaymentEvent(paymentEvent: PaymentEvent) = WebhookEvent(paymentEvent = paymentEvent)
fun ofPayStatementEvent(payStatementEvent: PayStatementEvent) =
WebhookEvent(payStatementEvent = payStatementEvent)
}
interface Visitor {
fun visitAccountUpdateEvent(accountUpdateEvent: AccountUpdateEvent): T
fun visitJobCompletionEvent(jobCompletionEvent: JobCompletionEvent): T
fun visitCompanyEvent(companyEvent: CompanyEvent): T
fun visitDirectoryEvent(directoryEvent: DirectoryEvent): T
fun visitEmploymentEvent(employmentEvent: EmploymentEvent): T
fun visitIndividualEvent(individualEvent: IndividualEvent): T
fun visitPaymentEvent(paymentEvent: PaymentEvent): T
fun visitPayStatementEvent(payStatementEvent: PayStatementEvent): T
fun unknown(json: JsonValue?): T {
throw FinchInvalidDataException("Unknown WebhookEvent: $json")
}
}
class Deserializer : BaseDeserializer(WebhookEvent::class) {
override fun ObjectCodec.deserialize(node: JsonNode): WebhookEvent {
val json = JsonValue.fromJsonNode(node)
tryDeserialize(node, jacksonTypeRef())?.let {
return WebhookEvent(accountUpdateEvent = it, _json = json)
}
tryDeserialize(node, jacksonTypeRef())?.let {
return WebhookEvent(jobCompletionEvent = it, _json = json)
}
tryDeserialize(node, jacksonTypeRef())?.let {
return WebhookEvent(companyEvent = it, _json = json)
}
tryDeserialize(node, jacksonTypeRef())?.let {
return WebhookEvent(directoryEvent = it, _json = json)
}
tryDeserialize(node, jacksonTypeRef())?.let {
return WebhookEvent(employmentEvent = it, _json = json)
}
tryDeserialize(node, jacksonTypeRef())?.let {
return WebhookEvent(individualEvent = it, _json = json)
}
tryDeserialize(node, jacksonTypeRef())?.let {
return WebhookEvent(paymentEvent = it, _json = json)
}
tryDeserialize(node, jacksonTypeRef())?.let {
return WebhookEvent(payStatementEvent = it, _json = json)
}
return WebhookEvent(_json = json)
}
}
class Serializer : BaseSerializer(WebhookEvent::class) {
override fun serialize(
value: WebhookEvent,
generator: JsonGenerator,
provider: SerializerProvider
) {
when {
value.accountUpdateEvent != null -> generator.writeObject(value.accountUpdateEvent)
value.jobCompletionEvent != null -> generator.writeObject(value.jobCompletionEvent)
value.companyEvent != null -> generator.writeObject(value.companyEvent)
value.directoryEvent != null -> generator.writeObject(value.directoryEvent)
value.employmentEvent != null -> generator.writeObject(value.employmentEvent)
value.individualEvent != null -> generator.writeObject(value.individualEvent)
value.paymentEvent != null -> generator.writeObject(value.paymentEvent)
value.payStatementEvent != null -> generator.writeObject(value.payStatementEvent)
value._json != null -> generator.writeObject(value._json)
else -> throw IllegalStateException("Invalid WebhookEvent")
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy