com.tryfinch.api.models.SandboxConnectionAccountCreateParams.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.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.JsonValue
import com.tryfinch.api.core.NoAutoDetect
import com.tryfinch.api.core.http.Headers
import com.tryfinch.api.core.http.QueryParams
import com.tryfinch.api.core.toImmutable
import com.tryfinch.api.errors.FinchInvalidDataException
import com.tryfinch.api.models.*
import java.util.Objects
class SandboxConnectionAccountCreateParams
constructor(
private val companyId: String,
private val providerId: String,
private val authenticationType: AuthenticationType?,
private val products: List?,
private val additionalHeaders: Headers,
private val additionalQueryParams: QueryParams,
private val additionalBodyProperties: Map,
) {
fun companyId(): String = companyId
fun providerId(): String = providerId
fun authenticationType(): AuthenticationType? = authenticationType
fun products(): List? = products
internal fun getBody(): SandboxConnectionAccountCreateBody {
return SandboxConnectionAccountCreateBody(
companyId,
providerId,
authenticationType,
products,
additionalBodyProperties,
)
}
internal fun getHeaders(): Headers = additionalHeaders
internal fun getQueryParams(): QueryParams = additionalQueryParams
@JsonDeserialize(builder = SandboxConnectionAccountCreateBody.Builder::class)
@NoAutoDetect
class SandboxConnectionAccountCreateBody
internal constructor(
private val companyId: String?,
private val providerId: String?,
private val authenticationType: AuthenticationType?,
private val products: List?,
private val additionalProperties: Map,
) {
@JsonProperty("company_id") fun companyId(): String? = companyId
/** The provider associated with the `access_token` */
@JsonProperty("provider_id") fun providerId(): String? = providerId
@JsonProperty("authentication_type")
fun authenticationType(): AuthenticationType? = authenticationType
/**
* Optional, defaults to Organization products (`company`, `directory`, `employment`,
* `individual`)
*/
@JsonProperty("products") fun products(): List? = products
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
class Builder {
private var companyId: String? = null
private var providerId: String? = null
private var authenticationType: AuthenticationType? = null
private var products: List? = null
private var additionalProperties: MutableMap = mutableMapOf()
internal fun from(
sandboxConnectionAccountCreateBody: SandboxConnectionAccountCreateBody
) = apply {
this.companyId = sandboxConnectionAccountCreateBody.companyId
this.providerId = sandboxConnectionAccountCreateBody.providerId
this.authenticationType = sandboxConnectionAccountCreateBody.authenticationType
this.products = sandboxConnectionAccountCreateBody.products
additionalProperties(sandboxConnectionAccountCreateBody.additionalProperties)
}
@JsonProperty("company_id")
fun companyId(companyId: String) = apply { this.companyId = companyId }
/** The provider associated with the `access_token` */
@JsonProperty("provider_id")
fun providerId(providerId: String) = apply { this.providerId = providerId }
@JsonProperty("authentication_type")
fun authenticationType(authenticationType: AuthenticationType) = apply {
this.authenticationType = authenticationType
}
/**
* Optional, defaults to Organization products (`company`, `directory`, `employment`,
* `individual`)
*/
@JsonProperty("products")
fun products(products: List) = apply { this.products = products }
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(): SandboxConnectionAccountCreateBody =
SandboxConnectionAccountCreateBody(
checkNotNull(companyId) { "`companyId` is required but was not set" },
checkNotNull(providerId) { "`providerId` is required but was not set" },
authenticationType,
products?.toImmutable(),
additionalProperties.toImmutable(),
)
}
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is SandboxConnectionAccountCreateBody && companyId == other.companyId && providerId == other.providerId && authenticationType == other.authenticationType && products == other.products && additionalProperties == other.additionalProperties /* spotless:on */
}
/* spotless:off */
private val hashCode: Int by lazy { Objects.hash(companyId, providerId, authenticationType, products, additionalProperties) }
/* spotless:on */
override fun hashCode(): Int = hashCode
override fun toString() =
"SandboxConnectionAccountCreateBody{companyId=$companyId, providerId=$providerId, authenticationType=$authenticationType, products=$products, additionalProperties=$additionalProperties}"
}
fun _additionalHeaders(): Headers = additionalHeaders
fun _additionalQueryParams(): QueryParams = additionalQueryParams
fun _additionalBodyProperties(): Map = additionalBodyProperties
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return /* spotless:off */ other is SandboxConnectionAccountCreateParams && companyId == other.companyId && providerId == other.providerId && authenticationType == other.authenticationType && products == other.products && additionalHeaders == other.additionalHeaders && additionalQueryParams == other.additionalQueryParams && additionalBodyProperties == other.additionalBodyProperties /* spotless:on */
}
override fun hashCode(): Int = /* spotless:off */ Objects.hash(companyId, providerId, authenticationType, products, additionalHeaders, additionalQueryParams, additionalBodyProperties) /* spotless:on */
override fun toString() =
"SandboxConnectionAccountCreateParams{companyId=$companyId, providerId=$providerId, authenticationType=$authenticationType, products=$products, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams, additionalBodyProperties=$additionalBodyProperties}"
fun toBuilder() = Builder().from(this)
companion object {
fun builder() = Builder()
}
@NoAutoDetect
class Builder {
private var companyId: String? = null
private var providerId: String? = null
private var authenticationType: AuthenticationType? = null
private var products: MutableList = mutableListOf()
private var additionalHeaders: Headers.Builder = Headers.builder()
private var additionalQueryParams: QueryParams.Builder = QueryParams.builder()
private var additionalBodyProperties: MutableMap = mutableMapOf()
internal fun from(
sandboxConnectionAccountCreateParams: SandboxConnectionAccountCreateParams
) = apply {
this.companyId = sandboxConnectionAccountCreateParams.companyId
this.providerId = sandboxConnectionAccountCreateParams.providerId
this.authenticationType = sandboxConnectionAccountCreateParams.authenticationType
this.products(sandboxConnectionAccountCreateParams.products ?: listOf())
additionalHeaders(sandboxConnectionAccountCreateParams.additionalHeaders)
additionalQueryParams(sandboxConnectionAccountCreateParams.additionalQueryParams)
additionalBodyProperties(sandboxConnectionAccountCreateParams.additionalBodyProperties)
}
fun companyId(companyId: String) = apply { this.companyId = companyId }
/** The provider associated with the `access_token` */
fun providerId(providerId: String) = apply { this.providerId = providerId }
fun authenticationType(authenticationType: AuthenticationType) = apply {
this.authenticationType = authenticationType
}
/**
* Optional, defaults to Organization products (`company`, `directory`, `employment`,
* `individual`)
*/
fun products(products: List) = apply {
this.products.clear()
this.products.addAll(products)
}
/**
* Optional, defaults to Organization products (`company`, `directory`, `employment`,
* `individual`)
*/
fun addProduct(product: String) = apply { this.products.add(product) }
fun additionalHeaders(additionalHeaders: Headers) = apply {
this.additionalHeaders.clear()
putAllAdditionalHeaders(additionalHeaders)
}
fun additionalHeaders(additionalHeaders: Map>) = apply {
this.additionalHeaders.clear()
putAllAdditionalHeaders(additionalHeaders)
}
fun putAdditionalHeader(name: String, value: String) = apply {
additionalHeaders.put(name, value)
}
fun putAdditionalHeaders(name: String, values: Iterable) = apply {
additionalHeaders.put(name, values)
}
fun putAllAdditionalHeaders(additionalHeaders: Headers) = apply {
this.additionalHeaders.putAll(additionalHeaders)
}
fun putAllAdditionalHeaders(additionalHeaders: Map>) = apply {
this.additionalHeaders.putAll(additionalHeaders)
}
fun replaceAdditionalHeaders(name: String, value: String) = apply {
additionalHeaders.replace(name, value)
}
fun replaceAdditionalHeaders(name: String, values: Iterable) = apply {
additionalHeaders.replace(name, values)
}
fun replaceAllAdditionalHeaders(additionalHeaders: Headers) = apply {
this.additionalHeaders.replaceAll(additionalHeaders)
}
fun replaceAllAdditionalHeaders(additionalHeaders: Map>) = apply {
this.additionalHeaders.replaceAll(additionalHeaders)
}
fun removeAdditionalHeaders(name: String) = apply { additionalHeaders.remove(name) }
fun removeAllAdditionalHeaders(names: Set) = apply {
additionalHeaders.removeAll(names)
}
fun additionalQueryParams(additionalQueryParams: QueryParams) = apply {
this.additionalQueryParams.clear()
putAllAdditionalQueryParams(additionalQueryParams)
}
fun additionalQueryParams(additionalQueryParams: Map>) = apply {
this.additionalQueryParams.clear()
putAllAdditionalQueryParams(additionalQueryParams)
}
fun putAdditionalQueryParam(key: String, value: String) = apply {
additionalQueryParams.put(key, value)
}
fun putAdditionalQueryParams(key: String, values: Iterable) = apply {
additionalQueryParams.put(key, values)
}
fun putAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply {
this.additionalQueryParams.putAll(additionalQueryParams)
}
fun putAllAdditionalQueryParams(additionalQueryParams: Map>) =
apply {
this.additionalQueryParams.putAll(additionalQueryParams)
}
fun replaceAdditionalQueryParams(key: String, value: String) = apply {
additionalQueryParams.replace(key, value)
}
fun replaceAdditionalQueryParams(key: String, values: Iterable) = apply {
additionalQueryParams.replace(key, values)
}
fun replaceAllAdditionalQueryParams(additionalQueryParams: QueryParams) = apply {
this.additionalQueryParams.replaceAll(additionalQueryParams)
}
fun replaceAllAdditionalQueryParams(additionalQueryParams: Map>) =
apply {
this.additionalQueryParams.replaceAll(additionalQueryParams)
}
fun removeAdditionalQueryParams(key: String) = apply { additionalQueryParams.remove(key) }
fun removeAllAdditionalQueryParams(keys: Set) = apply {
additionalQueryParams.removeAll(keys)
}
fun additionalBodyProperties(additionalBodyProperties: Map) = apply {
this.additionalBodyProperties.clear()
putAllAdditionalBodyProperties(additionalBodyProperties)
}
fun putAdditionalBodyProperty(key: String, value: JsonValue) = apply {
additionalBodyProperties.put(key, value)
}
fun putAllAdditionalBodyProperties(additionalBodyProperties: Map) =
apply {
this.additionalBodyProperties.putAll(additionalBodyProperties)
}
fun removeAdditionalBodyProperty(key: String) = apply {
additionalBodyProperties.remove(key)
}
fun removeAllAdditionalBodyProperties(keys: Set) = apply {
keys.forEach(::removeAdditionalBodyProperty)
}
fun build(): SandboxConnectionAccountCreateParams =
SandboxConnectionAccountCreateParams(
checkNotNull(companyId) { "`companyId` is required but was not set" },
checkNotNull(providerId) { "`providerId` is required but was not set" },
authenticationType,
if (products.size == 0) null else products.toImmutable(),
additionalHeaders.build(),
additionalQueryParams.build(),
additionalBodyProperties.toImmutable(),
)
}
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 /* spotless:off */ other is AuthenticationType && value == other.value /* spotless:on */
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
val CREDENTIAL = AuthenticationType(JsonField.of("credential"))
val API_TOKEN = AuthenticationType(JsonField.of("api_token"))
val OAUTH = AuthenticationType(JsonField.of("oauth"))
val ASSISTED = AuthenticationType(JsonField.of("assisted"))
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()
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy