com.tryfinch.api.models.ConnectionCreateResponse.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
@JsonDeserialize(builder = ConnectionCreateResponse.Builder::class)
@NoAutoDetect
class ConnectionCreateResponse
private constructor(
private val connectionId: JsonField,
private val companyId: JsonField,
private val providerId: JsonField,
private val accountId: JsonField,
private val authenticationType: JsonField,
private val products: JsonField>,
private val accessToken: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/** The ID of the new connection */
fun connectionId(): String = connectionId.getRequired("connection_id")
/** [DEPRECATED] Use `connection_id` to associate a connection with an access token */
fun companyId(): String = companyId.getRequired("company_id")
/** The ID of the provider associated with the `access_token`. */
fun providerId(): String = providerId.getRequired("provider_id")
/** [DEPRECATED] Use `connection_id` to associate a connection with an access token */
fun accountId(): String = accountId.getRequired("account_id")
fun authenticationType(): AuthenticationType =
authenticationType.getRequired("authentication_type")
fun products(): List = products.getRequired("products")
fun accessToken(): String = accessToken.getRequired("access_token")
/** The ID of the new connection */
@JsonProperty("connection_id") @ExcludeMissing fun _connectionId() = connectionId
/** [DEPRECATED] Use `connection_id` to associate a connection with an access token */
@JsonProperty("company_id") @ExcludeMissing fun _companyId() = companyId
/** The ID of the provider associated with the `access_token`. */
@JsonProperty("provider_id") @ExcludeMissing fun _providerId() = providerId
/** [DEPRECATED] Use `connection_id` to associate a connection with an access token */
@JsonProperty("account_id") @ExcludeMissing fun _accountId() = accountId
@JsonProperty("authentication_type")
@ExcludeMissing
fun _authenticationType() = authenticationType
@JsonProperty("products") @ExcludeMissing fun _products() = products
@JsonProperty("access_token") @ExcludeMissing fun _accessToken() = accessToken
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): ConnectionCreateResponse = apply {
if (!validated) {
connectionId()
companyId()
providerId()
accountId()
authenticationType()
products()
accessToken()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is ConnectionCreateResponse &&
this.connectionId == other.connectionId &&
this.companyId == other.companyId &&
this.providerId == other.providerId &&
this.accountId == other.accountId &&
this.authenticationType == other.authenticationType &&
this.products == other.products &&
this.accessToken == other.accessToken &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
connectionId,
companyId,
providerId,
accountId,
authenticationType,
products,
accessToken,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"ConnectionCreateResponse{connectionId=$connectionId, companyId=$companyId, providerId=$providerId, accountId=$accountId, authenticationType=$authenticationType, products=$products, accessToken=$accessToken, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var connectionId: JsonField = JsonMissing.of()
private var companyId: JsonField = JsonMissing.of()
private var providerId: JsonField = JsonMissing.of()
private var accountId: JsonField = JsonMissing.of()
private var authenticationType: JsonField = JsonMissing.of()
private var products: JsonField> = JsonMissing.of()
private var accessToken: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(connectionCreateResponse: ConnectionCreateResponse) = apply {
this.connectionId = connectionCreateResponse.connectionId
this.companyId = connectionCreateResponse.companyId
this.providerId = connectionCreateResponse.providerId
this.accountId = connectionCreateResponse.accountId
this.authenticationType = connectionCreateResponse.authenticationType
this.products = connectionCreateResponse.products
this.accessToken = connectionCreateResponse.accessToken
additionalProperties(connectionCreateResponse.additionalProperties)
}
/** The ID of the new connection */
fun connectionId(connectionId: String) = connectionId(JsonField.of(connectionId))
/** The ID of the new connection */
@JsonProperty("connection_id")
@ExcludeMissing
fun connectionId(connectionId: JsonField) = apply {
this.connectionId = connectionId
}
/** [DEPRECATED] Use `connection_id` to associate a connection with an access token */
fun companyId(companyId: String) = companyId(JsonField.of(companyId))
/** [DEPRECATED] Use `connection_id` to associate a connection with an access token */
@JsonProperty("company_id")
@ExcludeMissing
fun companyId(companyId: JsonField) = apply { this.companyId = companyId }
/** The ID of the provider associated with the `access_token`. */
fun providerId(providerId: String) = providerId(JsonField.of(providerId))
/** The ID of the provider associated with the `access_token`. */
@JsonProperty("provider_id")
@ExcludeMissing
fun providerId(providerId: JsonField) = apply { this.providerId = providerId }
/** [DEPRECATED] Use `connection_id` to associate a connection with an access token */
fun accountId(accountId: String) = accountId(JsonField.of(accountId))
/** [DEPRECATED] Use `connection_id` to associate a connection with an access token */
@JsonProperty("account_id")
@ExcludeMissing
fun accountId(accountId: JsonField) = apply { this.accountId = accountId }
fun authenticationType(authenticationType: AuthenticationType) =
authenticationType(JsonField.of(authenticationType))
@JsonProperty("authentication_type")
@ExcludeMissing
fun authenticationType(authenticationType: JsonField) = apply {
this.authenticationType = authenticationType
}
fun products(products: List) = products(JsonField.of(products))
@JsonProperty("products")
@ExcludeMissing
fun products(products: JsonField>) = apply { this.products = products }
fun accessToken(accessToken: String) = accessToken(JsonField.of(accessToken))
@JsonProperty("access_token")
@ExcludeMissing
fun accessToken(accessToken: JsonField) = apply { this.accessToken = accessToken }
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(): ConnectionCreateResponse =
ConnectionCreateResponse(
connectionId,
companyId,
providerId,
accountId,
authenticationType,
products.map { it.toUnmodifiable() },
accessToken,
additionalProperties.toUnmodifiable(),
)
}
class AuthenticationType
@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 AuthenticationType && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val CREDENTIAL = AuthenticationType(JsonField.of("credential"))
@JvmField val API_TOKEN = AuthenticationType(JsonField.of("api_token"))
@JvmField val OAUTH = AuthenticationType(JsonField.of("oauth"))
@JvmField val ASSISTED = AuthenticationType(JsonField.of("assisted"))
@JvmStatic fun of(value: String) = AuthenticationType(JsonField.of(value))
}
enum class Known {
CREDENTIAL,
API_TOKEN,
OAUTH,
ASSISTED,
}
enum class Value {
CREDENTIAL,
API_TOKEN,
OAUTH,
ASSISTED,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CREDENTIAL -> Value.CREDENTIAL
API_TOKEN -> Value.API_TOKEN
OAUTH -> Value.OAUTH
ASSISTED -> Value.ASSISTED
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CREDENTIAL -> Known.CREDENTIAL
API_TOKEN -> Known.API_TOKEN
OAUTH -> Known.OAUTH
ASSISTED -> Known.ASSISTED
else -> throw FinchInvalidDataException("Unknown AuthenticationType: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}